2 * Copyright 2000, International Business Machines Corporation and others.
5 * This software has been released under the terms of the IBM Public
6 * License. For details, see the LICENSE file in the top-level source
7 * directory or online at http://www.openafs.org/dl/license10.html
10 #include <afsconfig.h>
11 #include <afs/param.h>
17 #include <sys/types.h>
25 #include <sys/socket.h>
26 #include <netinet/in.h>
32 #include <rx/rx_globals.h>
34 #include <afs/bubasics.h>
36 #include <afs/afsutil.h>
38 #include <afs/cellconfig.h>
43 #include <afs/volser.h> /*VLDB_MAXSERVERS */
44 #include <afs/com_err.h>
48 #include "bc.h" /*Backup Coordinator structs and defs */
51 int localauth, interact;
54 extern int BC_ExecuteRequest();
55 extern int bc_AddDumpCmd();
56 extern int bc_AddHostCmd();
57 extern int bc_AddVolEntryCmd();
58 extern int bc_AddVolSetCmd();
59 /* extern int bc_CheckDumpStatCmd(); */
60 extern int bc_DeleteDumpCmd();
61 extern int bc_DeleteHostCmd();
62 extern int bc_DeleteVolEntryCmd();
63 extern int bc_DeleteVolSetCmd();
64 extern int bc_DiskRestoreCmd();
65 extern int bc_VolsetRestoreCmd();
66 extern int bc_DumpCmd();
67 extern int bc_GetTapeStatusCmd();
68 extern int bc_JobsCmd();
69 extern int bc_KillCmd();
70 extern int bc_LabelTapeCmd();
71 extern int bc_ListDumpScheduleCmd();
72 extern int bc_ListHostsCmd();
73 extern int bc_ListVolSetCmd();
74 extern int bc_QuitCmd();
75 extern int bc_ReadLabelCmd();
76 extern int bc_ScanDumpsCmd();
77 extern int bc_SetExpCmd();
78 extern int bc_VolRestoreCmd();
79 extern int bc_dblookupCmd();
80 extern int bc_dbVerifyCmd();
81 extern int bc_deleteDumpCmd();
82 extern int bc_dumpInfoCmd();
83 extern int bc_restoreDbCmd();
84 extern int bc_saveDbCmd();
89 * Global configuration information for the Backup Coordinator.
91 struct bc_config *bc_globalConfig; /*Ptr to global BC configuration info */
93 struct ubik_client *cstruct; /* Ptr to Ubik client structure */
94 struct ktc_token ttoken; /* The token */
96 static const char *DefaultConfDir; /*Default backup config directory */
97 static int bcInit = 0; /* backupInit called yet ? */
98 char *whoami = "backup";
100 /* dummy routine for the audit work. It should do nothing since audits */
101 /* occur at the server level and bos is not a server. */
108 * Initialize all the error tables that may be used by com_err
114 initialize_ACFG_error_table();
115 initialize_KA_error_table();
116 initialize_RXK_error_table();
117 initialize_CMD_error_table();
118 initialize_VL_error_table();
119 initialize_BUTM_error_table();
120 initialize_VOLS_error_table();
121 initialize_BUTC_error_table();
122 initialize_BUTX_error_table();
123 initialize_BUDB_error_table();
124 initialize_BUCD_error_table();
125 initialize_KTC_error_table();
129 * got to account for the errors which are volume related but
130 * not dealt with by standard errno and com_err stuff.
136 if (((code <= VMOVED) && (code >= VSALVAGE)) || (code < 0)) {
139 fprintf(STDERR, "Possible communication failure\n");
142 fprintf(STDERR, "Volume needs salvage\n");
145 fprintf(STDERR, "Bad vnode number quoted\n");
149 "Volume not attached, does not exist, or not on line\n");
152 fprintf(STDERR, "Volume already exists\n");
155 fprintf(STDERR, "Volume is not in service\n");
158 fprintf(STDERR, "Volume is off line\n");
161 fprintf(STDERR, "Volume is already on line\n");
164 fprintf(STDERR, "Partition is full\n");
167 fprintf(STDERR, "Volume max quota exceeded\n");
170 fprintf(STDERR, "Volume temporarily unavailable\n");
173 fprintf(STDERR, "Volume has moved to another server\n");
182 /* Return true if line is all whitespace */
185 register char *aline;
189 while (tc = *aline++)
190 if ((tc != ' ') && (tc != '\t') && (tc != '\n'))
198 * initialize configuration information that is stored as text blocks
204 udbClientTextP ctPtr;
208 extern struct bc_config *bc_globalConfig;
210 mkdir(DefaultConfDir, 777); /* temporary */
212 /* initialize the client text structures */
213 ctPtr = &bc_globalConfig->configText[0];
215 for (i = 0; i < TB_NUM; i++) {
216 memset(ctPtr, 0, sizeof(*ctPtr));
218 ctPtr->textVersion = -1;
225 /*----------------------------------------------------------------------------
229 * Routine that is called when the backup coordinator is invoked, responsible for
230 * basic initialization and some command line parsing.
233 * Zero (but may exit the entire program on error!)
236 * Nothing interesting.
239 * Initializes this program.
240 *----------------------------------------------------------------------------
246 register afs_int32 code;
247 static int initd = 0; /* ever called? */
249 PROCESS pid; /* LWP process ID */
251 extern statusWatcher();
254 initialize_CMD_error_table();
256 /* don't run more than once */
258 com_err(whoami, 0, "Backup already initialized.");
263 code = bc_InitConfig(DefaultConfDir);
265 com_err(whoami, code,
266 "Can't initialize from config files in directory '%s'",
274 code = LWP_InitializeProcessSupport(LWP_NORMAL_PRIORITY, &pid);
276 com_err(whoami, code, "; Can't initialize LWP");
280 code = rx_Init(htons(0));
282 com_err(whoami, code, "; Can't initialize Rx");
286 rx_SetRxDeadTime(60);
288 /* VLDB initialization */
289 vldbClientInit(0, localauth, tcell, &cstruct, &ttoken);
293 /* Backup database initialization */
294 code = udbClientInit(0, localauth, tcell);
298 /* setup status monitoring thread */
301 LWP_CreateProcess(statusWatcher, 20480, LWP_NORMAL_PRIORITY,
302 (void *)2, "statusWatcher", &watcherPid);
304 com_err(whoami, code, "; Can't create status monitor task");
311 /*----------------------------------------------------------------------------
315 * Make sure we mark down when we need to exit the Backup Coordinator.
316 * Specifically, we don't want to continue when our help and apropos
317 * routines are called from the command line.
320 * as : Ptr to the command syntax descriptor.
326 * This routine is called right before each of the Backup Coordinator
327 * opcode routines are invoked.
329 *----------------------------------------------------------------------------
334 register struct cmd_syndesc *as;
339 /* Handling the command line opcode */
341 localauth = ((as && as->parms[14].items) ? 1 : 0);
342 if (as && as->parms[15].items)
343 strcpy(tcell, as->parms[15].items->data);
349 com_err(whoami, code, "; Can't initialize backup");
353 /* Get initial information from the database */
354 code = bc_InitTextConfig();
356 com_err(whoami, code,
357 "; Can't obtain configuration text from backup database");
369 #include "AFS_component_version_number.c"
371 #define MAXRECURSION 20
372 extern int dontExecute; /* declared in commands.c */
373 extern char *loadFile; /* declared in commands.c */
374 char lineBuffer[1024]; /* Line typed in by user or read from load file */
377 * This will dispatch a command. It holds a recursive loop for the
378 * "dump -file" option. This option reads backup commands from a file.
380 * Cannot put this code on other side of cmd_Dispatch call (in
381 * commands.c) because when make a dispatch call when in a dispatch
382 * call, environment is mucked up.
384 * To avoid multiple processes stepping on each other in the dispatch code,
385 * put a lock around it so only 1 process gets in at a time.
388 struct Lock dispatchLock; /* lock on the Dispatch call */
389 #define lock_Dispatch() ObtainWriteLock(&dispatchLock)
390 #define unlock_Dispatch() ReleaseWriteLock(&dispatchLock)
393 doDispatch(targc, targv, dispatchCount)
396 afs_int32 dispatchCount; /* to prevent infinite recursion */
404 int noExecute; /* local capy of global variable */
405 char *internalLoadFile;
410 code = cmd_Dispatch(targc, targv);
411 internalLoadFile = loadFile;
415 if (internalLoadFile) { /* Load a file in */
416 if (dispatchCount > MAXRECURSION) { /* Beware recursive loops. */
417 com_err(whoami, 0, "Potential recursion: will not load file %s",
423 fd = fopen(internalLoadFile, "r"); /* Open the load file */
425 com_err(whoami, errno, "; Cannot open file %s", internalLoadFile);
430 noExecute = dontExecute;
432 printf("Would have executed the following commands:\n");
435 while (fgets(lineBuffer, sizeof(lineBuffer) - 1, fd)) { /* Get commands from file */
438 i = strlen(lineBuffer) - 1;
439 if (lineBuffer[i] == '\n') /* Drop return at end of line */
440 lineBuffer[i] = '\0';
443 printf(" %s\n", lineBuffer); /* echo */
445 printf("------> %s\n", lineBuffer); /* echo */
447 if (!LineIsBlank(lineBuffer) && /* Skip if blank line */
448 (lineBuffer[0] != '#') && /* or comment */
449 (!noExecute)) { /* or no execute */
450 c = cmd_ParseLine(lineBuffer, sargv, &sargc, MAXV);
452 com_err(whoami, c, "; Can't parse line");
454 doDispatch(sargc, sargv, dispatchCount + 1); /* Recursive - ignore error */
455 cmd_FreeArgv(sargv); /* Free up arguments */
464 if (internalLoadFile)
465 free(internalLoadFile);
470 bc_interactCmd(as, arock)
471 struct cmd_syndesc *as;
479 register struct cmd_syndesc *ts;
482 cmd_AddParm(ts, "-localauth", CMD_FLAG, CMD_OPTIONAL,
483 "local authentication");
484 cmd_AddParm(ts, "-cell", CMD_SINGLE, CMD_OPTIONAL, "cell name");
492 char **targv[MAXV]; /*Ptr to parsed argv stuff */
493 afs_int32 targc; /*Num parsed arguments */
494 afs_int32 code; /*Return code */
495 char *tp; /*Result of gets() */
496 register struct cmd_syndesc *ts; /*Ptr to parsed command line */
502 * The following signal action for AIX is necessary so that in case of a
503 * crash (i.e. core is generated) we can include the user's data section
504 * in the core dump. Unfortunately, by default, only a partial core is
505 * generated which, in many cases, isn't too useful.
507 struct sigaction nsa;
509 sigemptyset(&nsa.sa_mask);
510 nsa.sa_handler = SIG_DFL;
511 nsa.sa_flags = SA_FULLDUMP;
512 sigaction(SIGSEGV, &nsa, NULL);
514 Lock_Init(&dispatchLock);
515 InitErrTabs(); /* init all the error tables which may be used */
517 /* setup the default backup dir */
518 DefaultConfDir = AFSDIR_SERVER_BACKUP_DIRPATH;
519 /* Get early warning if the command is interacive mode or not */
520 interact = (((argc < 2) || (argv[1][0] == '-')) ? 1 : 0);
522 cmd_SetBeforeProc(MyBeforeProc, NULL);
524 ts = cmd_CreateSyntax("dump", bc_DumpCmd, 0, "start dump");
525 cmd_AddParm(ts, "-volumeset", CMD_SINGLE, CMD_OPTIONAL,
527 cmd_AddParm(ts, "-dump", CMD_SINGLE, CMD_OPTIONAL, "dump level name");
528 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
530 cmd_AddParm(ts, "-at", CMD_LIST, CMD_OPTIONAL, "Date/time to start dump");
531 cmd_AddParm(ts, "-append", CMD_FLAG, CMD_OPTIONAL,
532 "append to existing dump set");
533 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
534 cmd_AddParm(ts, "-file", CMD_SINGLE, CMD_OPTIONAL, "load file");
538 ts = cmd_CreateSyntax("volrestore", bc_VolRestoreCmd, 0,
540 cmd_AddParm(ts, "-server", CMD_SINGLE, CMD_REQUIRED,
541 "destination machine");
542 cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_REQUIRED,
543 "destination partition");
544 cmd_AddParm(ts, "-volume", CMD_LIST, CMD_REQUIRED,
545 "volume(s) to restore");
546 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
547 "new volume name extension");
548 cmd_AddParm(ts, "-date", CMD_LIST, CMD_OPTIONAL,
549 "date from which to restore");
550 cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offsets");
551 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
555 ts = cmd_CreateSyntax("diskrestore", bc_DiskRestoreCmd, 0,
556 "restore partition");
557 cmd_AddParm(ts, "-server", CMD_SINGLE, CMD_REQUIRED,
558 "machine to restore");
559 cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_REQUIRED,
560 "partition to restore");
561 cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offset");
563 cmd_AddParm(ts, "-newserver", CMD_SINGLE, CMD_OPTIONAL,
564 "destination machine");
565 cmd_AddParm(ts, "-newpartition", CMD_SINGLE, CMD_OPTIONAL,
566 "destination partition");
567 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
568 "new volume name extension");
569 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
573 ts = cmd_CreateSyntax("quit", bc_QuitCmd, 0, "leave the program");
575 ts = cmd_CreateSyntax("volsetrestore", bc_VolsetRestoreCmd, 0,
576 "restore a set of volumes");
577 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_OPTIONAL, "volume set name");
578 cmd_AddParm(ts, "-file", CMD_SINGLE, CMD_OPTIONAL, "file name");
579 cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offset");
580 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
581 "new volume name extension");
582 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
586 ts = cmd_CreateSyntax("addhost", bc_AddHostCmd, 0, "add host to config");
587 cmd_AddParm(ts, "-tapehost", CMD_SINGLE, CMD_REQUIRED,
588 "tape machine name");
589 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
594 ts = cmd_CreateSyntax("delhost", bc_DeleteHostCmd, 0,
595 "delete host to config");
596 cmd_AddParm(ts, "-tapehost", CMD_SINGLE, CMD_REQUIRED,
597 "tape machine name");
598 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
603 ts = cmd_CreateSyntax("listhosts", bc_ListHostsCmd, 0,
604 "list config hosts");
608 ts = cmd_CreateSyntax("jobs", bc_JobsCmd, 0, "list running jobs");
610 ts = cmd_CreateSyntax("kill", bc_KillCmd, 0, "kill running job");
611 cmd_AddParm(ts, "-id", CMD_SINGLE, CMD_REQUIRED,
612 "job ID or dump set name");
614 ts = cmd_CreateSyntax("listvolsets", bc_ListVolSetCmd, 0,
616 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_OPTIONAL, "volume set name");
620 ts = cmd_CreateSyntax("listdumps", bc_ListDumpScheduleCmd, 0,
621 "list dump schedules");
625 ts = cmd_CreateSyntax("addvolset", bc_AddVolSetCmd, 0,
626 "create a new volume set");
627 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_REQUIRED, "volume set name");
628 cmd_AddParm(ts, "-temporary", CMD_FLAG, CMD_OPTIONAL,
629 "temporary volume set");
633 ts = cmd_CreateSyntax("status", bc_GetTapeStatusCmd, 0,
634 "get tape coordinator status");
635 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
640 ts = cmd_CreateSyntax("delvolset", bc_DeleteVolSetCmd, 0,
641 "delete a volume set");
642 cmd_AddParm(ts, "-name", CMD_LIST, CMD_REQUIRED, "volume set name");
646 ts = cmd_CreateSyntax("addvolentry", bc_AddVolEntryCmd, 0,
647 "add a new volume entry");
648 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_REQUIRED, "volume set name");
649 cmd_AddParm(ts, "-server", CMD_SINGLE, CMD_REQUIRED, "machine name");
650 cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_REQUIRED, "partition name");
651 cmd_AddParm(ts, "-volumes", CMD_SINGLE, CMD_REQUIRED,
652 "volume name (regular expression)");
656 ts = cmd_CreateSyntax("delvolentry", bc_DeleteVolEntryCmd, 0,
657 "delete a volume set sub-entry");
658 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_REQUIRED, "volume set name");
659 cmd_AddParm(ts, "-entry", CMD_SINGLE, CMD_REQUIRED, "volume set index");
663 ts = cmd_CreateSyntax("adddump", bc_AddDumpCmd, 0, "add dump schedule");
664 cmd_AddParm(ts, "-dump", CMD_LIST, CMD_REQUIRED, "dump level name");
665 cmd_AddParm(ts, "-expires", CMD_LIST, CMD_OPTIONAL, "expiration date");
669 ts = cmd_CreateSyntax("deldump", bc_DeleteDumpCmd, 0,
670 "delete dump schedule");
671 cmd_AddParm(ts, "-dump", CMD_SINGLE, CMD_REQUIRED, "dump level name");
675 ts = cmd_CreateSyntax("labeltape", bc_LabelTapeCmd, 0, "label a tape");
676 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_OPTIONAL,
677 "AFS tape name, defaults to NULL");
678 cmd_AddParm(ts, "-size", CMD_SINGLE, CMD_OPTIONAL,
679 "tape size in Kbytes, defaults to size in tapeconfig");
680 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
682 cmd_AddParm(ts, "-pname", CMD_SINGLE, CMD_OPTIONAL,
683 "permanent tape name");
687 ts = cmd_CreateSyntax("readlabel", bc_ReadLabelCmd, 0,
688 "read the label on tape");
689 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
694 ts = cmd_CreateSyntax("scantape", bc_ScanDumpsCmd, 0,
695 "dump information recovery from tape");
696 cmd_AddParm(ts, "-dbadd", CMD_FLAG, CMD_OPTIONAL,
697 "add information to the database");
698 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
703 ts = cmd_CreateSyntax("volinfo", bc_dblookupCmd, 0,
704 "query the backup database");
705 cmd_AddParm(ts, "-volume", CMD_SINGLE, CMD_REQUIRED, "volume name");
709 ts = cmd_CreateSyntax("setexp", bc_SetExpCmd, 0,
710 "set/clear dump expiration dates");
711 cmd_AddParm(ts, "-dump", CMD_LIST, CMD_REQUIRED, "dump level name");
712 cmd_AddParm(ts, "-expires", CMD_LIST, CMD_OPTIONAL, "expiration date");
716 ts = cmd_CreateSyntax("savedb", bc_saveDbCmd, 0, "save backup database");
717 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
719 cmd_AddParm(ts, "-archive", CMD_LIST, CMD_OPTIONAL, "date time");
723 ts = cmd_CreateSyntax("restoredb", bc_restoreDbCmd, 0,
724 "restore backup database");
725 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
730 ts = cmd_CreateSyntax("dumpinfo", bc_dumpInfoCmd, 0,
731 "provide information about a dump in the database");
732 cmd_AddParm(ts, "-ndumps", CMD_SINGLE, CMD_OPTIONAL, "no. of dumps");
733 cmd_AddParm(ts, "-id", CMD_SINGLE, CMD_OPTIONAL, "dump id");
734 cmd_AddParm(ts, "-verbose", CMD_FLAG, CMD_OPTIONAL,
735 "detailed description");
739 ts = cmd_CreateSyntax("dbverify", bc_dbVerifyCmd, 0,
740 "check ubik database integrity");
741 cmd_AddParm(ts, "-detail", CMD_FLAG, CMD_OPTIONAL, "additional details");
745 ts = cmd_CreateSyntax("deletedump", bc_deleteDumpCmd, 0,
746 "delete dumps from the database");
747 cmd_AddParm(ts, "-dumpid", CMD_LIST, CMD_OPTIONAL, "dump id");
748 cmd_AddParm(ts, "-from", CMD_LIST, CMD_OPTIONAL, "date time");
749 cmd_AddParm(ts, "-to", CMD_LIST, CMD_OPTIONAL, "date time");
750 cmd_AddParm(ts, "-port", CMD_SINGLE, CMD_OPTIONAL, "TC port offset");
751 cmd_AddParm(ts, "-groupid", CMD_SINGLE, CMD_OPTIONAL, "group ID");
752 cmd_AddParm(ts, "-dbonly", CMD_FLAG, CMD_OPTIONAL,
753 "delete the dump from the backup database only");
754 cmd_AddParm(ts, "-force", CMD_FLAG, CMD_OPTIONAL,
755 "always delete from backup database");
756 cmd_AddParm(ts, "-noexecute", CMD_FLAG, CMD_OPTIONAL,
757 "Just list the dumps");
762 ts = cmd_CreateSyntax("interactive", bc_interactCmd, 0,
763 "enter interactive mode");
767 * Now execute the command.
771 targv[targc++] = argv[0];
773 targv[targc++] = "interactive";
774 for (i = 1; i < argc; i++)
775 targv[targc++] = argv[i];
777 code = doDispatch(targc, targv, 1);
779 if (!interact || !bcInit) { /* Non-interactive mode */
783 code = bc_WaitForNoJobs(); /* wait for any jobs to finish */
784 exit(code); /* and exit */
787 /* Iterate on command lines, interpreting user commands (interactive mode) */
795 while ((ret = LWP_GetLine(lineBuffer, sizeof(lineBuffer))) == 0)
796 printf("%s: Command line too long\n", whoami); /* line too long */
799 return 0; /* Got EOF */
801 if (!LineIsBlank(lineBuffer)) {
802 code = cmd_ParseLine(lineBuffer, targv, &targc, MAXV);
804 com_err(whoami, code, "; Can't parse line: '%s'",
805 error_message(code));
807 doDispatch(targc, targv, 1);