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 */
48 #include "bucoord_prototypes.h"
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 */
248 initialize_CMD_error_table();
250 /* don't run more than once */
252 afs_com_err(whoami, 0, "Backup already initialized.");
257 code = bc_InitConfig(DefaultConfDir);
259 afs_com_err(whoami, code,
260 "Can't initialize from config files in directory '%s'",
268 code = LWP_InitializeProcessSupport(LWP_NORMAL_PRIORITY, &pid);
270 afs_com_err(whoami, code, "; Can't initialize LWP");
274 code = rx_Init(htons(0));
276 afs_com_err(whoami, code, "; Can't initialize Rx");
280 rx_SetRxDeadTime(60);
282 /* VLDB initialization */
283 code = vldbClientInit(0, localauth, tcell, &cstruct, &ttoken);
287 /* Backup database initialization */
288 code = udbClientInit(0, localauth, tcell);
292 /* setup status monitoring thread */
295 LWP_CreateProcess(statusWatcher, 20480, LWP_NORMAL_PRIORITY,
296 (void *)2, "statusWatcher", &watcherPid);
298 afs_com_err(whoami, code, "; Can't create status monitor task");
305 /*----------------------------------------------------------------------------
309 * Make sure we mark down when we need to exit the Backup Coordinator.
310 * Specifically, we don't want to continue when our help and apropos
311 * routines are called from the command line.
314 * as : Ptr to the command syntax descriptor.
320 * This routine is called right before each of the Backup Coordinator
321 * opcode routines are invoked.
323 *----------------------------------------------------------------------------
327 MyBeforeProc(register struct cmd_syndesc *as, void *arock)
331 /* Handling the command line opcode */
333 localauth = ((as && as->parms[14].items) ? 1 : 0);
334 if (as && as->parms[15].items)
335 strcpy(tcell, as->parms[15].items->data);
341 afs_com_err(whoami, code, "; Can't initialize backup");
345 /* Get initial information from the database */
346 code = bc_InitTextConfig();
348 afs_com_err(whoami, code,
349 "; Can't obtain configuration text from backup database");
361 #include "AFS_component_version_number.c"
363 #define MAXRECURSION 20
364 extern int dontExecute; /* declared in commands.c */
365 extern char *loadFile; /* declared in commands.c */
366 char lineBuffer[1024]; /* Line typed in by user or read from load file */
369 * This will dispatch a command. It holds a recursive loop for the
370 * "dump -file" option. This option reads backup commands from a file.
372 * Cannot put this code on other side of cmd_Dispatch call (in
373 * commands.c) because when make a dispatch call when in a dispatch
374 * call, environment is mucked up.
376 * To avoid multiple processes stepping on each other in the dispatch code,
377 * put a lock around it so only 1 process gets in at a time.
380 struct Lock dispatchLock; /* lock on the Dispatch call */
381 #define lock_Dispatch() ObtainWriteLock(&dispatchLock)
382 #define unlock_Dispatch() ReleaseWriteLock(&dispatchLock)
385 doDispatch(targc, targv, dispatchCount)
388 afs_int32 dispatchCount; /* to prevent infinite recursion */
396 int noExecute; /* local capy of global variable */
397 char *internalLoadFile;
402 code = cmd_Dispatch(targc, targv);
403 internalLoadFile = loadFile;
407 if (internalLoadFile) { /* Load a file in */
408 if (dispatchCount > MAXRECURSION) { /* Beware recursive loops. */
409 afs_com_err(whoami, 0, "Potential recursion: will not load file %s",
415 fd = fopen(internalLoadFile, "r"); /* Open the load file */
417 afs_com_err(whoami, errno, "; Cannot open file %s", internalLoadFile);
422 noExecute = dontExecute;
424 printf("Would have executed the following commands:\n");
427 while (fgets(lineBuffer, sizeof(lineBuffer) - 1, fd)) { /* Get commands from file */
430 i = strlen(lineBuffer) - 1;
431 if (lineBuffer[i] == '\n') /* Drop return at end of line */
432 lineBuffer[i] = '\0';
435 printf(" %s\n", lineBuffer); /* echo */
437 printf("------> %s\n", lineBuffer); /* echo */
439 if (!LineIsBlank(lineBuffer) && /* Skip if blank line */
440 (lineBuffer[0] != '#') && /* or comment */
441 (!noExecute)) { /* or no execute */
442 c = cmd_ParseLine(lineBuffer, sargv, &sargc, MAXV);
444 afs_com_err(whoami, c, "; Can't parse line");
446 doDispatch(sargc, sargv, dispatchCount + 1); /* Recursive - ignore error */
447 cmd_FreeArgv(sargv); /* Free up arguments */
456 if (internalLoadFile)
457 free(internalLoadFile);
462 bc_interactCmd(struct cmd_syndesc *as, void *arock)
470 register struct cmd_syndesc *ts;
473 cmd_AddParm(ts, "-localauth", CMD_FLAG, CMD_OPTIONAL,
474 "local authentication");
475 cmd_AddParm(ts, "-cell", CMD_SINGLE, CMD_OPTIONAL, "cell name");
483 char *targv[MAXV]; /*Ptr to parsed argv stuff */
484 afs_int32 targc; /*Num parsed arguments */
485 afs_int32 code; /*Return code */
486 register struct cmd_syndesc *ts; /*Ptr to parsed command line */
492 * The following signal action for AIX is necessary so that in case of a
493 * crash (i.e. core is generated) we can include the user's data section
494 * in the core dump. Unfortunately, by default, only a partial core is
495 * generated which, in many cases, isn't too useful.
497 struct sigaction nsa;
499 sigemptyset(&nsa.sa_mask);
500 nsa.sa_handler = SIG_DFL;
501 nsa.sa_flags = SA_FULLDUMP;
502 sigaction(SIGSEGV, &nsa, NULL);
504 Lock_Init(&dispatchLock);
505 InitErrTabs(); /* init all the error tables which may be used */
507 /* setup the default backup dir */
508 DefaultConfDir = AFSDIR_SERVER_BACKUP_DIRPATH;
509 /* Get early warning if the command is interacive mode or not */
510 interact = (((argc < 2) || (argv[1][0] == '-')) ? 1 : 0);
512 cmd_SetBeforeProc(MyBeforeProc, NULL);
514 ts = cmd_CreateSyntax("dump", bc_DumpCmd, NULL, "start dump");
515 cmd_AddParm(ts, "-volumeset", CMD_SINGLE, CMD_OPTIONAL,
517 cmd_AddParm(ts, "-dump", CMD_SINGLE, CMD_OPTIONAL, "dump level name");
518 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
520 cmd_AddParm(ts, "-at", CMD_LIST, CMD_OPTIONAL, "Date/time to start dump");
521 cmd_AddParm(ts, "-append", CMD_FLAG, CMD_OPTIONAL,
522 "append to existing dump set");
523 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
524 cmd_AddParm(ts, "-file", CMD_SINGLE, CMD_OPTIONAL, "load file");
528 ts = cmd_CreateSyntax("volrestore", bc_VolRestoreCmd, NULL,
530 cmd_AddParm(ts, "-server", CMD_SINGLE, CMD_REQUIRED,
531 "destination machine");
532 cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_REQUIRED,
533 "destination partition");
534 cmd_AddParm(ts, "-volume", CMD_LIST, CMD_REQUIRED,
535 "volume(s) to restore");
536 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
537 "new volume name extension");
538 cmd_AddParm(ts, "-date", CMD_LIST, CMD_OPTIONAL,
539 "date from which to restore");
540 cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offsets");
541 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
542 cmd_AddParm(ts, "-usedump", CMD_SINGLE, CMD_OPTIONAL,
543 "specify the dumpID to restore from");
547 ts = cmd_CreateSyntax("diskrestore", bc_DiskRestoreCmd, NULL,
548 "restore partition");
549 cmd_AddParm(ts, "-server", CMD_SINGLE, CMD_REQUIRED,
550 "machine to restore");
551 cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_REQUIRED,
552 "partition to restore");
553 cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offset");
555 cmd_AddParm(ts, "-newserver", CMD_SINGLE, CMD_OPTIONAL,
556 "destination machine");
557 cmd_AddParm(ts, "-newpartition", CMD_SINGLE, CMD_OPTIONAL,
558 "destination partition");
559 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
560 "new volume name extension");
561 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
565 ts = cmd_CreateSyntax("quit", bc_QuitCmd, NULL, "leave the program");
567 ts = cmd_CreateSyntax("volsetrestore", bc_VolsetRestoreCmd, NULL,
568 "restore a set of volumes");
569 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_OPTIONAL, "volume set name");
570 cmd_AddParm(ts, "-file", CMD_SINGLE, CMD_OPTIONAL, "file name");
571 cmd_AddParm(ts, "-portoffset", CMD_LIST, CMD_OPTIONAL, "TC port offset");
572 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL,
573 "new volume name extension");
574 cmd_AddParm(ts, "-n", CMD_FLAG, CMD_OPTIONAL, "don't really execute it");
578 ts = cmd_CreateSyntax("addhost", bc_AddHostCmd, NULL, "add host to config");
579 cmd_AddParm(ts, "-tapehost", CMD_SINGLE, CMD_REQUIRED,
580 "tape machine name");
581 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
586 ts = cmd_CreateSyntax("delhost", bc_DeleteHostCmd, NULL,
587 "delete host to config");
588 cmd_AddParm(ts, "-tapehost", CMD_SINGLE, CMD_REQUIRED,
589 "tape machine name");
590 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
595 ts = cmd_CreateSyntax("listhosts", bc_ListHostsCmd, NULL,
596 "list config hosts");
600 ts = cmd_CreateSyntax("jobs", bc_JobsCmd, NULL, "list running jobs");
602 ts = cmd_CreateSyntax("kill", bc_KillCmd, NULL, "kill running job");
603 cmd_AddParm(ts, "-id", CMD_SINGLE, CMD_REQUIRED,
604 "job ID or dump set name");
606 ts = cmd_CreateSyntax("listvolsets", bc_ListVolSetCmd, NULL,
608 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_OPTIONAL, "volume set name");
612 ts = cmd_CreateSyntax("listdumps", bc_ListDumpScheduleCmd, NULL,
613 "list dump schedules");
617 ts = cmd_CreateSyntax("addvolset", bc_AddVolSetCmd, NULL,
618 "create a new volume set");
619 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_REQUIRED, "volume set name");
620 cmd_AddParm(ts, "-temporary", CMD_FLAG, CMD_OPTIONAL,
621 "temporary volume set");
625 ts = cmd_CreateSyntax("status", bc_GetTapeStatusCmd, NULL,
626 "get tape coordinator status");
627 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
632 ts = cmd_CreateSyntax("delvolset", bc_DeleteVolSetCmd, NULL,
633 "delete a volume set");
634 cmd_AddParm(ts, "-name", CMD_LIST, CMD_REQUIRED, "volume set name");
638 ts = cmd_CreateSyntax("addvolentry", bc_AddVolEntryCmd, NULL,
639 "add a new volume entry");
640 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_REQUIRED, "volume set name");
641 cmd_AddParm(ts, "-server", CMD_SINGLE, CMD_REQUIRED, "machine name");
642 cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_REQUIRED, "partition name");
643 cmd_AddParm(ts, "-volumes", CMD_SINGLE, CMD_REQUIRED,
644 "volume name (regular expression)");
648 ts = cmd_CreateSyntax("delvolentry", bc_DeleteVolEntryCmd, NULL,
649 "delete a volume set sub-entry");
650 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_REQUIRED, "volume set name");
651 cmd_AddParm(ts, "-entry", CMD_SINGLE, CMD_REQUIRED, "volume set index");
655 ts = cmd_CreateSyntax("adddump", bc_AddDumpCmd, NULL, "add dump schedule");
656 cmd_AddParm(ts, "-dump", CMD_LIST, CMD_REQUIRED, "dump level name");
657 cmd_AddParm(ts, "-expires", CMD_LIST, CMD_OPTIONAL, "expiration date");
661 ts = cmd_CreateSyntax("deldump", bc_DeleteDumpCmd, NULL,
662 "delete dump schedule");
663 cmd_AddParm(ts, "-dump", CMD_SINGLE, CMD_REQUIRED, "dump level name");
667 ts = cmd_CreateSyntax("labeltape", bc_LabelTapeCmd, NULL, "label a tape");
668 cmd_AddParm(ts, "-name", CMD_SINGLE, CMD_OPTIONAL,
669 "AFS tape name, defaults to NULL");
670 cmd_AddParm(ts, "-size", CMD_SINGLE, CMD_OPTIONAL,
671 "tape size in Kbytes, defaults to size in tapeconfig");
672 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
674 cmd_AddParm(ts, "-pname", CMD_SINGLE, CMD_OPTIONAL,
675 "permanent tape name");
679 ts = cmd_CreateSyntax("readlabel", bc_ReadLabelCmd, NULL,
680 "read the label on tape");
681 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
686 ts = cmd_CreateSyntax("scantape", bc_ScanDumpsCmd, NULL,
687 "dump information recovery from tape");
688 cmd_AddParm(ts, "-dbadd", CMD_FLAG, CMD_OPTIONAL,
689 "add information to the database");
690 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
695 ts = cmd_CreateSyntax("volinfo", bc_dblookupCmd, NULL,
696 "query the backup database");
697 cmd_AddParm(ts, "-volume", CMD_SINGLE, CMD_REQUIRED, "volume name");
701 ts = cmd_CreateSyntax("setexp", bc_SetExpCmd, NULL,
702 "set/clear dump expiration dates");
703 cmd_AddParm(ts, "-dump", CMD_LIST, CMD_REQUIRED, "dump level name");
704 cmd_AddParm(ts, "-expires", CMD_LIST, CMD_OPTIONAL, "expiration date");
708 ts = cmd_CreateSyntax("savedb", bc_saveDbCmd, NULL, "save backup database");
709 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
711 cmd_AddParm(ts, "-archive", CMD_LIST, CMD_OPTIONAL, "date time");
715 ts = cmd_CreateSyntax("restoredb", bc_restoreDbCmd, NULL,
716 "restore backup database");
717 cmd_AddParm(ts, "-portoffset", CMD_SINGLE, CMD_OPTIONAL,
722 ts = cmd_CreateSyntax("dumpinfo", bc_dumpInfoCmd, NULL,
723 "provide information about a dump in the database");
724 cmd_AddParm(ts, "-ndumps", CMD_SINGLE, CMD_OPTIONAL, "no. of dumps");
725 cmd_AddParm(ts, "-id", CMD_SINGLE, CMD_OPTIONAL, "dump id");
726 cmd_AddParm(ts, "-verbose", CMD_FLAG, CMD_OPTIONAL,
727 "detailed description");
731 ts = cmd_CreateSyntax("dbverify", bc_dbVerifyCmd, NULL,
732 "check ubik database integrity");
733 cmd_AddParm(ts, "-detail", CMD_FLAG, CMD_OPTIONAL, "additional details");
737 ts = cmd_CreateSyntax("deletedump", bc_deleteDumpCmd, NULL,
738 "delete dumps from the database");
739 cmd_AddParm(ts, "-dumpid", CMD_LIST, CMD_OPTIONAL, "dump id");
740 cmd_AddParm(ts, "-from", CMD_LIST, CMD_OPTIONAL, "date time");
741 cmd_AddParm(ts, "-to", CMD_LIST, CMD_OPTIONAL, "date time");
742 cmd_AddParm(ts, "-port", CMD_SINGLE, CMD_OPTIONAL, "TC port offset");
743 cmd_AddParm(ts, "-groupid", CMD_SINGLE, CMD_OPTIONAL, "group ID");
744 cmd_AddParm(ts, "-dbonly", CMD_FLAG, CMD_OPTIONAL,
745 "delete the dump from the backup database only");
746 cmd_AddParm(ts, "-force", CMD_FLAG, CMD_OPTIONAL,
747 "always delete from backup database");
748 cmd_AddParm(ts, "-noexecute", CMD_FLAG, CMD_OPTIONAL,
749 "Just list the dumps");
754 ts = cmd_CreateSyntax("interactive", bc_interactCmd, NULL,
755 "enter interactive mode");
759 * Now execute the command.
763 targv[targc++] = argv[0];
765 targv[targc++] = "interactive";
766 for (i = 1; i < argc; i++)
767 targv[targc++] = argv[i];
769 code = doDispatch(targc, targv, 1);
771 if (!interact || !bcInit) { /* Non-interactive mode */
775 code = bc_WaitForNoJobs(); /* wait for any jobs to finish */
776 exit(code); /* and exit */
779 /* Iterate on command lines, interpreting user commands (interactive mode) */
787 while ((ret = LWP_GetLine(lineBuffer, sizeof(lineBuffer))) == 0)
788 printf("%s: Command line too long\n", whoami); /* line too long */
791 return 0; /* Got EOF */
793 if (!LineIsBlank(lineBuffer)) {
794 code = cmd_ParseLine(lineBuffer, targv, &targc, MAXV);
796 afs_com_err(whoami, code, "; Can't parse line: '%s'",
797 afs_error_message(code));
799 doDispatch(targc, targv, 1);