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>
24 #include <sys/socket.h>
25 #include <netinet/in.h>
31 #include <rx/rx_globals.h>
33 #include <afs/bubasics.h>
35 #include <afs/afsutil.h>
37 #include <afs/cellconfig.h>
42 #include <afs/volser.h> /*VLDB_MAXSERVERS */
43 #include <afs/com_err.h>
47 #include "bc.h" /*Backup Coordinator structs and defs */
50 int localauth, interact;
53 extern int bc_AddDumpCmd();
54 extern int bc_AddHostCmd();
55 extern int bc_AddVolEntryCmd();
56 extern int bc_AddVolSetCmd();
57 /* extern int bc_CheckDumpStatCmd(); */
58 extern int bc_DeleteDumpCmd();
59 extern int bc_DeleteHostCmd();
60 extern int bc_DeleteVolEntryCmd();
61 extern int bc_DeleteVolSetCmd();
62 extern int bc_DiskRestoreCmd();
63 extern int bc_VolsetRestoreCmd();
64 extern int bc_DumpCmd();
65 extern int bc_GetTapeStatusCmd();
66 extern int bc_JobsCmd();
67 extern int bc_KillCmd();
68 extern int bc_LabelTapeCmd();
69 extern int bc_ListDumpScheduleCmd();
70 extern int bc_ListHostsCmd();
71 extern int bc_ListVolSetCmd();
72 extern int bc_QuitCmd();
73 extern int bc_ReadLabelCmd();
74 extern int bc_ScanDumpsCmd();
75 extern int bc_SetExpCmd();
76 extern int bc_VolRestoreCmd();
77 extern int bc_dblookupCmd();
78 extern int bc_dbVerifyCmd();
79 extern int bc_deleteDumpCmd();
80 extern int bc_dumpInfoCmd();
81 extern int bc_restoreDbCmd();
82 extern int bc_saveDbCmd();
85 * Global configuration information for the Backup Coordinator.
87 struct bc_config *bc_globalConfig; /*Ptr to global BC configuration info */
89 struct ubik_client *cstruct; /* Ptr to Ubik client structure */
90 struct ktc_token ttoken; /* The token */
92 static const char *DefaultConfDir; /*Default backup config directory */
93 static int bcInit = 0; /* backupInit called yet ? */
94 char *whoami = "backup";
96 /* dummy routine for the audit work. It should do nothing since audits */
97 /* occur at the server level and bos is not a server. */
104 * Initialize all the error tables that may be used by com_err
110 initialize_ACFG_error_table();
111 initialize_KA_error_table();
112 initialize_RXK_error_table();
113 initialize_CMD_error_table();
114 initialize_VL_error_table();
115 initialize_BUTM_error_table();
116 initialize_VOLS_error_table();
117 initialize_BUTC_error_table();
118 initialize_BUTX_error_table();
119 initialize_BUDB_error_table();
120 initialize_BUCD_error_table();
121 initialize_KTC_error_table();
125 * got to account for the errors which are volume related but
126 * not dealt with by standard errno and com_err stuff.
132 if (((code <= VMOVED) && (code >= VSALVAGE)) || (code < 0)) {
135 fprintf(STDERR, "Possible communication failure\n");
138 fprintf(STDERR, "Volume needs salvage\n");
141 fprintf(STDERR, "Bad vnode number quoted\n");
145 "Volume not attached, does not exist, or not on line\n");
148 fprintf(STDERR, "Volume already exists\n");
151 fprintf(STDERR, "Volume is not in service\n");
154 fprintf(STDERR, "Volume is off line\n");
157 fprintf(STDERR, "Volume is already on line\n");
160 fprintf(STDERR, "Partition is full\n");
163 fprintf(STDERR, "Volume max quota exceeded\n");
166 fprintf(STDERR, "Volume temporarily unavailable\n");
169 fprintf(STDERR, "Volume has moved to another server\n");
178 /* Return true if line is all whitespace */
181 register char *aline;
185 while (tc = *aline++)
186 if ((tc != ' ') && (tc != '\t') && (tc != '\n'))
194 * initialize configuration information that is stored as text blocks
200 udbClientTextP ctPtr;
204 extern struct bc_config *bc_globalConfig;
206 mkdir(DefaultConfDir, 777); /* temporary */
208 /* initialize the client text structures */
209 ctPtr = &bc_globalConfig->configText[0];
211 for (i = 0; i < TB_NUM; i++) {
212 memset(ctPtr, 0, sizeof(*ctPtr));
214 ctPtr->textVersion = -1;
221 /*----------------------------------------------------------------------------
225 * Routine that is called when the backup coordinator is invoked, responsible for
226 * basic initialization and some command line parsing.
229 * Zero (but may exit the entire program on error!)
232 * Nothing interesting.
235 * Initializes this program.
236 *----------------------------------------------------------------------------
242 register afs_int32 code;
243 static int initd = 0; /* ever called? */
245 PROCESS pid; /* LWP process ID */
247 extern statusWatcher();
250 initialize_CMD_error_table();
252 /* don't run more than once */
254 afs_com_err(whoami, 0, "Backup already initialized.");
259 code = bc_InitConfig(DefaultConfDir);
261 afs_com_err(whoami, code,
262 "Can't initialize from config files in directory '%s'",
270 code = LWP_InitializeProcessSupport(LWP_NORMAL_PRIORITY, &pid);
272 afs_com_err(whoami, code, "; Can't initialize LWP");
276 code = rx_Init(htons(0));
278 afs_com_err(whoami, code, "; Can't initialize Rx");
282 rx_SetRxDeadTime(60);
284 /* VLDB initialization */
285 code = vldbClientInit(0, localauth, tcell, &cstruct, &ttoken);
289 /* Backup database initialization */
290 code = udbClientInit(0, localauth, tcell);
294 /* setup status monitoring thread */
297 LWP_CreateProcess(statusWatcher, 20480, LWP_NORMAL_PRIORITY,
298 (void *)2, "statusWatcher", &watcherPid);
300 afs_com_err(whoami, code, "; Can't create status monitor task");
307 /*----------------------------------------------------------------------------
311 * Make sure we mark down when we need to exit the Backup Coordinator.
312 * Specifically, we don't want to continue when our help and apropos
313 * routines are called from the command line.
316 * as : Ptr to the command syntax descriptor.
322 * This routine is called right before each of the Backup Coordinator
323 * opcode routines are invoked.
325 *----------------------------------------------------------------------------
329 MyBeforeProc(register struct cmd_syndesc *as, void *arock)
333 /* Handling the command line opcode */
335 localauth = ((as && as->parms[14].items) ? 1 : 0);
336 if (as && as->parms[15].items)
337 strcpy(tcell, as->parms[15].items->data);
343 afs_com_err(whoami, code, "; Can't initialize backup");
347 /* Get initial information from the database */
348 code = bc_InitTextConfig();
350 afs_com_err(whoami, code,
351 "; Can't obtain configuration text from backup database");
363 #include "AFS_component_version_number.c"
365 #define MAXRECURSION 20
366 extern int dontExecute; /* declared in commands.c */
367 extern char *loadFile; /* declared in commands.c */
368 char lineBuffer[1024]; /* Line typed in by user or read from load file */
371 * This will dispatch a command. It holds a recursive loop for the
372 * "dump -file" option. This option reads backup commands from a file.
374 * Cannot put this code on other side of cmd_Dispatch call (in
375 * commands.c) because when make a dispatch call when in a dispatch
376 * call, environment is mucked up.
378 * To avoid multiple processes stepping on each other in the dispatch code,
379 * put a lock around it so only 1 process gets in at a time.
382 struct Lock dispatchLock; /* lock on the Dispatch call */
383 #define lock_Dispatch() ObtainWriteLock(&dispatchLock)
384 #define unlock_Dispatch() ReleaseWriteLock(&dispatchLock)
387 doDispatch(targc, targv, dispatchCount)
390 afs_int32 dispatchCount; /* to prevent infinite recursion */
398 int noExecute; /* local capy of global variable */
399 char *internalLoadFile;
404 code = cmd_Dispatch(targc, targv);
405 internalLoadFile = loadFile;
409 if (internalLoadFile) { /* Load a file in */
410 if (dispatchCount > MAXRECURSION) { /* Beware recursive loops. */
411 afs_com_err(whoami, 0, "Potential recursion: will not load file %s",
417 fd = fopen(internalLoadFile, "r"); /* Open the load file */
419 afs_com_err(whoami, errno, "; Cannot open file %s", internalLoadFile);
424 noExecute = dontExecute;
426 printf("Would have executed the following commands:\n");
429 while (fgets(lineBuffer, sizeof(lineBuffer) - 1, fd)) { /* Get commands from file */
432 i = strlen(lineBuffer) - 1;
433 if (lineBuffer[i] == '\n') /* Drop return at end of line */
434 lineBuffer[i] = '\0';
437 printf(" %s\n", lineBuffer); /* echo */
439 printf("------> %s\n", lineBuffer); /* echo */
441 if (!LineIsBlank(lineBuffer) && /* Skip if blank line */
442 (lineBuffer[0] != '#') && /* or comment */
443 (!noExecute)) { /* or no execute */
444 c = cmd_ParseLine(lineBuffer, sargv, &sargc, MAXV);
446 afs_com_err(whoami, c, "; Can't parse line");
448 doDispatch(sargc, sargv, dispatchCount + 1); /* Recursive - ignore error */
449 cmd_FreeArgv(sargv); /* Free up arguments */
458 if (internalLoadFile)
459 free(internalLoadFile);
464 bc_interactCmd(struct cmd_syndesc *as, void *arock)
472 register struct cmd_syndesc *ts;
475 cmd_AddParm(ts, "-localauth", CMD_FLAG, CMD_OPTIONAL,
476 "local authentication");
477 cmd_AddParm(ts, "-cell", CMD_SINGLE, CMD_OPTIONAL, "cell name");
485 char *targv[MAXV]; /*Ptr to parsed argv stuff */
486 afs_int32 targc; /*Num parsed arguments */
487 afs_int32 code; /*Return code */
488 register struct cmd_syndesc *ts; /*Ptr to parsed command line */
494 * The following signal action for AIX is necessary so that in case of a
495 * crash (i.e. core is generated) we can include the user's data section
496 * in the core dump. Unfortunately, by default, only a partial core is
497 * generated which, in many cases, isn't too useful.
499 struct sigaction nsa;
501 sigemptyset(&nsa.sa_mask);
502 nsa.sa_handler = SIG_DFL;
503 nsa.sa_flags = SA_FULLDUMP;
504 sigaction(SIGSEGV, &nsa, NULL);
506 Lock_Init(&dispatchLock);
507 InitErrTabs(); /* init all the error tables which may be used */
509 /* setup the default backup dir */
510 DefaultConfDir = AFSDIR_SERVER_BACKUP_DIRPATH;
511 /* Get early warning if the command is interacive mode or not */
512 interact = (((argc < 2) || (argv[1][0] == '-')) ? 1 : 0);
514 cmd_SetBeforeProc(MyBeforeProc, NULL);
516 ts = cmd_CreateSyntax("dump", bc_DumpCmd, NULL, "start dump");
517 cmd_AddParm(ts, "-volumeset", CMD_SINGLE, CMD_OPTIONAL,
519 cmd_AddParm(ts, "-dump", CMD_SINGLE, CMD_OPTIONAL, "dump level name");
520 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
522 cmd_AddParm(ts, "-at", CMD_LIST, CMD_OPTIONAL, "Date/time to start dump");
523 cmd_AddParm(ts, "-append", CMD_FLAG, CMD_OPTIONAL,
524 "append to existing dump set");
525 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
526 cmd_AddParm(ts, "-file", CMD_SINGLE, CMD_OPTIONAL, "load file");
530 ts = cmd_CreateSyntax("volrestore", bc_VolRestoreCmd, NULL,
532 cmd_AddParm(ts, "-server", CMD_SINGLE, CMD_REQUIRED,
533 "destination machine");
534 cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_REQUIRED,
535 "destination partition");
536 cmd_AddParm(ts, "-volume", CMD_LIST, CMD_REQUIRED,
537 "volume(s) to restore");
538 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
539 "new volume name extension");
540 cmd_AddParm(ts, "-date", CMD_LIST, CMD_OPTIONAL,
541 "date from which to restore");
542 cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offsets");
543 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
544 cmd_AddParm(ts, "-usedump", CMD_SINGLE, CMD_OPTIONAL,
545 "specify the dumpID to restore from");
549 ts = cmd_CreateSyntax("diskrestore", bc_DiskRestoreCmd, NULL,
550 "restore partition");
551 cmd_AddParm(ts, "-server", CMD_SINGLE, CMD_REQUIRED,
552 "machine to restore");
553 cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_REQUIRED,
554 "partition to restore");
555 cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offset");
557 cmd_AddParm(ts, "-newserver", CMD_SINGLE, CMD_OPTIONAL,
558 "destination machine");
559 cmd_AddParm(ts, "-newpartition", CMD_SINGLE, CMD_OPTIONAL,
560 "destination partition");
561 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
562 "new volume name extension");
563 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
567 ts = cmd_CreateSyntax("quit", bc_QuitCmd, NULL, "leave the program");
569 ts = cmd_CreateSyntax("volsetrestore", bc_VolsetRestoreCmd, NULL,
570 "restore a set of volumes");
571 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_OPTIONAL, "volume set name");
572 cmd_AddParm(ts, "-file", CMD_SINGLE, CMD_OPTIONAL, "file name");
573 cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offset");
574 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
575 "new volume name extension");
576 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
580 ts = cmd_CreateSyntax("addhost", bc_AddHostCmd, NULL, "add host to config");
581 cmd_AddParm(ts, "-tapehost", CMD_SINGLE, CMD_REQUIRED,
582 "tape machine name");
583 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
588 ts = cmd_CreateSyntax("delhost", bc_DeleteHostCmd, NULL,
589 "delete host to config");
590 cmd_AddParm(ts, "-tapehost", CMD_SINGLE, CMD_REQUIRED,
591 "tape machine name");
592 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
597 ts = cmd_CreateSyntax("listhosts", bc_ListHostsCmd, NULL,
598 "list config hosts");
602 ts = cmd_CreateSyntax("jobs", bc_JobsCmd, NULL, "list running jobs");
604 ts = cmd_CreateSyntax("kill", bc_KillCmd, NULL, "kill running job");
605 cmd_AddParm(ts, "-id", CMD_SINGLE, CMD_REQUIRED,
606 "job ID or dump set name");
608 ts = cmd_CreateSyntax("listvolsets", bc_ListVolSetCmd, NULL,
610 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_OPTIONAL, "volume set name");
614 ts = cmd_CreateSyntax("listdumps", bc_ListDumpScheduleCmd, NULL,
615 "list dump schedules");
619 ts = cmd_CreateSyntax("addvolset", bc_AddVolSetCmd, NULL,
620 "create a new volume set");
621 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_REQUIRED, "volume set name");
622 cmd_AddParm(ts, "-temporary", CMD_FLAG, CMD_OPTIONAL,
623 "temporary volume set");
627 ts = cmd_CreateSyntax("status", bc_GetTapeStatusCmd, NULL,
628 "get tape coordinator status");
629 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
634 ts = cmd_CreateSyntax("delvolset", bc_DeleteVolSetCmd, NULL,
635 "delete a volume set");
636 cmd_AddParm(ts, "-name", CMD_LIST, CMD_REQUIRED, "volume set name");
640 ts = cmd_CreateSyntax("addvolentry", bc_AddVolEntryCmd, NULL,
641 "add a new volume entry");
642 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_REQUIRED, "volume set name");
643 cmd_AddParm(ts, "-server", CMD_SINGLE, CMD_REQUIRED, "machine name");
644 cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_REQUIRED, "partition name");
645 cmd_AddParm(ts, "-volumes", CMD_SINGLE, CMD_REQUIRED,
646 "volume name (regular expression)");
650 ts = cmd_CreateSyntax("delvolentry", bc_DeleteVolEntryCmd, NULL,
651 "delete a volume set sub-entry");
652 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_REQUIRED, "volume set name");
653 cmd_AddParm(ts, "-entry", CMD_SINGLE, CMD_REQUIRED, "volume set index");
657 ts = cmd_CreateSyntax("adddump", bc_AddDumpCmd, NULL, "add dump schedule");
658 cmd_AddParm(ts, "-dump", CMD_LIST, CMD_REQUIRED, "dump level name");
659 cmd_AddParm(ts, "-expires", CMD_LIST, CMD_OPTIONAL, "expiration date");
663 ts = cmd_CreateSyntax("deldump", bc_DeleteDumpCmd, NULL,
664 "delete dump schedule");
665 cmd_AddParm(ts, "-dump", CMD_SINGLE, CMD_REQUIRED, "dump level name");
669 ts = cmd_CreateSyntax("labeltape", bc_LabelTapeCmd, NULL, "label a tape");
670 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_OPTIONAL,
671 "AFS tape name, defaults to NULL");
672 cmd_AddParm(ts, "-size", CMD_SINGLE, CMD_OPTIONAL,
673 "tape size in Kbytes, defaults to size in tapeconfig");
674 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
676 cmd_AddParm(ts, "-pname", CMD_SINGLE, CMD_OPTIONAL,
677 "permanent tape name");
681 ts = cmd_CreateSyntax("readlabel", bc_ReadLabelCmd, NULL,
682 "read the label on tape");
683 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
688 ts = cmd_CreateSyntax("scantape", bc_ScanDumpsCmd, NULL,
689 "dump information recovery from tape");
690 cmd_AddParm(ts, "-dbadd", CMD_FLAG, CMD_OPTIONAL,
691 "add information to the database");
692 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
697 ts = cmd_CreateSyntax("volinfo", bc_dblookupCmd, NULL,
698 "query the backup database");
699 cmd_AddParm(ts, "-volume", CMD_SINGLE, CMD_REQUIRED, "volume name");
703 ts = cmd_CreateSyntax("setexp", bc_SetExpCmd, NULL,
704 "set/clear dump expiration dates");
705 cmd_AddParm(ts, "-dump", CMD_LIST, CMD_REQUIRED, "dump level name");
706 cmd_AddParm(ts, "-expires", CMD_LIST, CMD_OPTIONAL, "expiration date");
710 ts = cmd_CreateSyntax("savedb", bc_saveDbCmd, NULL, "save backup database");
711 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
713 cmd_AddParm(ts, "-archive", CMD_LIST, CMD_OPTIONAL, "date time");
717 ts = cmd_CreateSyntax("restoredb", bc_restoreDbCmd, NULL,
718 "restore backup database");
719 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
724 ts = cmd_CreateSyntax("dumpinfo", bc_dumpInfoCmd, NULL,
725 "provide information about a dump in the database");
726 cmd_AddParm(ts, "-ndumps", CMD_SINGLE, CMD_OPTIONAL, "no. of dumps");
727 cmd_AddParm(ts, "-id", CMD_SINGLE, CMD_OPTIONAL, "dump id");
728 cmd_AddParm(ts, "-verbose", CMD_FLAG, CMD_OPTIONAL,
729 "detailed description");
733 ts = cmd_CreateSyntax("dbverify", bc_dbVerifyCmd, NULL,
734 "check ubik database integrity");
735 cmd_AddParm(ts, "-detail", CMD_FLAG, CMD_OPTIONAL, "additional details");
739 ts = cmd_CreateSyntax("deletedump", bc_deleteDumpCmd, NULL,
740 "delete dumps from the database");
741 cmd_AddParm(ts, "-dumpid", CMD_LIST, CMD_OPTIONAL, "dump id");
742 cmd_AddParm(ts, "-from", CMD_LIST, CMD_OPTIONAL, "date time");
743 cmd_AddParm(ts, "-to", CMD_LIST, CMD_OPTIONAL, "date time");
744 cmd_AddParm(ts, "-port", CMD_SINGLE, CMD_OPTIONAL, "TC port offset");
745 cmd_AddParm(ts, "-groupid", CMD_SINGLE, CMD_OPTIONAL, "group ID");
746 cmd_AddParm(ts, "-dbonly", CMD_FLAG, CMD_OPTIONAL,
747 "delete the dump from the backup database only");
748 cmd_AddParm(ts, "-force", CMD_FLAG, CMD_OPTIONAL,
749 "always delete from backup database");
750 cmd_AddParm(ts, "-noexecute", CMD_FLAG, CMD_OPTIONAL,
751 "Just list the dumps");
756 ts = cmd_CreateSyntax("interactive", bc_interactCmd, NULL,
757 "enter interactive mode");
761 * Now execute the command.
765 targv[targc++] = argv[0];
767 targv[targc++] = "interactive";
768 for (i = 1; i < argc; i++)
769 targv[targc++] = argv[i];
771 code = doDispatch(targc, targv, 1);
773 if (!interact || !bcInit) { /* Non-interactive mode */
777 code = bc_WaitForNoJobs(); /* wait for any jobs to finish */
778 exit(code); /* and exit */
781 /* Iterate on command lines, interpreting user commands (interactive mode) */
789 while ((ret = LWP_GetLine(lineBuffer, sizeof(lineBuffer))) == 0)
790 printf("%s: Command line too long\n", whoami); /* line too long */
793 return 0; /* Got EOF */
795 if (!LineIsBlank(lineBuffer)) {
796 code = cmd_ParseLine(lineBuffer, targv, &targc, MAXV);
798 afs_com_err(whoami, code, "; Can't parse line: '%s'",
799 afs_error_message(code));
801 doDispatch(targc, targv, 1);