/* Utility to start or stop system services. Requests are sent to the * reincarnation server that does the actual work. * * Changes: * Jul 22, 2005: Created (Jorrit N. Herder) */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include /* This array defines all known requests. */ PRIVATE char *known_requests[] = { "up", "down", "refresh", "restart", "-unused", "shutdown", "upcopy", /* fill for RS_UP_COPY */ "catch for illegal requests" }; #define ILLEGAL_REQUEST sizeof(known_requests)/sizeof(char *) /* Global error number set for failed system calls. */ #define OK 0 #define RUN_CMD "run" #define RUN_SCRIPT "/etc/rs.single" /* Default script for 'run' */ /* Define names for arguments provided to this utility. The first few * arguments are required and have a known index. Thereafter, some optional * argument pairs like "-args arglist" follow. */ #define ARG_NAME 0 /* own application name */ /* The following are relative to optind */ #define ARG_REQUEST 0 /* request to perform */ #define ARG_PATH 1 /* rescue dir or system service */ #define ARG_LABEL 1 /* name of system service */ #define MIN_ARG_COUNT 1 /* require an action */ #define ARG_ARGS "-args" /* list of arguments to be passed */ #define ARG_DEV "-dev" /* major device number for drivers */ #define ARG_PERIOD "-period" /* heartbeat period in ticks */ #define ARG_SCRIPT "-script" /* name of the script to restart a * driver */ #define ARG_LABELNAME "-label" /* custom label name */ #define ARG_CONFIG "-config" /* name of the file with the resource * configuration */ #define ARG_PRINTEP "-printep" /* print endpoint number after start */ #define DRIVER_LOGIN "driver" /* Passwd file entry for drivers */ #define MAX_CLASS_RECURS 100 /* Max nesting level for classes */ /* The function parse_arguments() verifies and parses the command line * parameters passed to this utility. Request parameters that are needed * are stored globally in the following variables: */ PRIVATE int req_type; PRIVATE int do_run= 0; /* 'run' command instead of 'up' */ PRIVATE char *req_label; PRIVATE char *req_path; PRIVATE char *req_args; PRIVATE int req_major; PRIVATE long req_period; PRIVATE char *req_script; PRIVATE char *req_label; PRIVATE char *req_config; PRIVATE int req_printep; PRIVATE int class_recurs; /* Nesting level of class statements */ /* Buffer to build "/command arg1 arg2 ..." string to pass to RS server. */ PRIVATE char command[4096]; /* Arguments for RS to start a new service */ PRIVATE struct rs_start rs_start; /* An error occurred. Report the problem, print the usage, and exit. */ PRIVATE void print_usage(char *app_name, char *problem) { fprintf(stderr, "Warning, %s\n", problem); fprintf(stderr, "Usage:\n"); fprintf(stderr, " %s [-c] (up|run) [%s ] [%s ] [%s ]\n", app_name, ARG_ARGS, ARG_DEV, ARG_PERIOD); fprintf(stderr, " %s down label\n", app_name); fprintf(stderr, " %s refresh label\n", app_name); fprintf(stderr, " %s restart label\n", app_name); fprintf(stderr, " %s rescue \n", app_name); fprintf(stderr, " %s shutdown\n", app_name); fprintf(stderr, "\n"); } /* A request to the RS server failed. Report and exit. */ PRIVATE void failure(int num) { fprintf(stderr, "Request to RS failed: %s (error %d)\n", strerror(num), num); exit(num); } /* Parse and verify correctness of arguments. Report problem and exit if an * error is found. Store needed parameters in global variables. */ PRIVATE int parse_arguments(int argc, char **argv) { struct stat stat_buf; char *hz; int req_nr; int c, i; int c_flag; c_flag= 0; while (c= getopt(argc, argv, "c?"), c != -1) { switch(c) { case '?': print_usage(argv[ARG_NAME], "wrong number of arguments"); exit(EINVAL); case 'c': c_flag= 1; break; default: fprintf(stderr, "%s: getopt failed: %c\n", argv[ARG_NAME], c); exit(1); } } /* Verify argument count. */ if (argc < optind+MIN_ARG_COUNT) { print_usage(argv[ARG_NAME], "wrong number of arguments"); exit(EINVAL); } if (strcmp(argv[optind+ARG_REQUEST], RUN_CMD) == 0) { req_nr= RS_UP; do_run= TRUE; } else { /* Verify request type. */ for (req_type=0; req_type< ILLEGAL_REQUEST; req_type++) { if (strcmp(known_requests[req_type],argv[optind+ARG_REQUEST])==0) break; } if (req_type == ILLEGAL_REQUEST) { print_usage(argv[ARG_NAME], "illegal request type"); exit(ENOSYS); } req_nr = RS_RQ_BASE + req_type; } if (req_nr == RS_UP) { rs_start.rss_flags= 0; if (c_flag) rs_start.rss_flags |= RF_COPY; if (do_run) { /* Set default recovery script for RUN */ req_script = RUN_SCRIPT; req_nr = RS_START; } if (req_nr == RS_UP && c_flag) req_nr= RS_UP_COPY; /* Verify argument count. */ if (argc - 1 < optind+ARG_PATH) { print_usage(argv[ARG_NAME], "action requires a binary to start"); exit(EINVAL); } /* Verify the name of the binary of the system service. */ req_path = argv[optind+ARG_PATH]; if (req_path[0] != '/') { print_usage(argv[ARG_NAME], "binary should be absolute path"); exit(EINVAL); } if (stat(req_path, &stat_buf) == -1) { perror(req_path); fprintf(stderr, "couldn't get stat binary\n"); exit(errno); } if (! (stat_buf.st_mode & S_IFREG)) { print_usage(argv[ARG_NAME], "binary is not a regular file"); exit(EINVAL); } /* Check optional arguments that come in pairs like "-args arglist". */ for (i=optind+MIN_ARG_COUNT+1; i> MAJOR) & BYTE; } else if (strcmp(argv[i], ARG_SCRIPT)==0) { req_script = argv[i+1]; req_nr = RS_START; } else if (strcmp(argv[i], ARG_LABELNAME)==0) { req_label = argv[i+1]; req_nr = RS_START; } else if (strcmp(argv[i], ARG_CONFIG)==0) { req_config = argv[i+1]; req_nr = RS_START; } else if (strcmp(argv[i], ARG_PRINTEP)==0) { req_printep = 1; } else { print_usage(argv[ARG_NAME], "unknown optional argument given"); exit(EINVAL); } } } else if (req_nr == RS_DOWN || req_nr == RS_REFRESH || req_nr == RS_RESTART) { /* Verify argument count. */ if (argc - 1 < optind+ARG_LABEL) { print_usage(argv[ARG_NAME], "action requires a label to stop"); exit(EINVAL); } req_label= argv[optind+ARG_LABEL]; } else if (req_nr == RS_SHUTDOWN) { /* no extra arguments required */ } /* Return the request number if no error were found. */ return(req_nr); } PRIVATE void fatal(char *fmt, ...) { va_list ap; fprintf(stderr, "fatal error: "); va_start(ap, fmt); vfprintf(stderr, fmt, ap); va_end(ap); fprintf(stderr, "\n"); exit(1); } #define KW_DRIVER "driver" #define KW_UID "uid" #define KW_NICE "nice" #define KW_IRQ "irq" #define KW_IO "io" #define KW_PCI "pci" #define KW_DEVICE "device" #define KW_CLASS "class" #define KW_SYSTEM "system" FORWARD void do_driver(config_t *cpe, config_t *config); PRIVATE void do_class(config_t *cpe, config_t *config) { config_t *cp, *cp1; if (class_recurs > MAX_CLASS_RECURS) { fatal( "do_class: nesting level too high for class '%s' at %s:%d", cpe->word, cpe->file, cpe->line); } class_recurs++; /* Process classes */ for (; cpe; cpe= cpe->next) { if (cpe->flags & CFG_SUBLIST) { fatal("do_class: unexpected sublist at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_STRING) { fatal("do_uid: unexpected string at %s:%d", cpe->file, cpe->line); } /* Find entry for the class */ for (cp= config; cp; cp= cp->next) { if (!(cp->flags & CFG_SUBLIST)) { fatal("do_class: expected list at %s:%d\n", cp->file, cp->line); } cp1= cp->list; if ((cp1->flags & CFG_STRING) || (cp1->flags & CFG_SUBLIST)) { fatal("do_class: expected word at %s:%d\n", cp1->file, cp1->line); } /* At this place we expect the word 'driver' */ if (strcmp(cp1->word, KW_DRIVER) != 0) fatal("do_class: exected word '%S' at %s:%d\n", KW_DRIVER, cp1->file, cp1->line); cp1= cp1->next; if ((cp1->flags & CFG_STRING) || (cp1->flags & CFG_SUBLIST)) { fatal("do_class: expected word at %s:%d\n", cp1->file, cp1->line); } /* At this place we expect the name of the driver */ if (strcmp(cp1->word, cpe->word) == 0) break; } if (cp == NULL) { fatal( "do_class: no entry found for class '%s' at %s:%d\n", cpe->word, cpe->file, cpe->line); } do_driver(cp1->next, config); } class_recurs--; } PRIVATE void do_uid(config_t *cpe) { uid_t uid; struct passwd *pw; char *check; /* Process a uid */ if (cpe->next != NULL) { fatal("do_uid: just one uid/login expected at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_SUBLIST) { fatal("do_uid: unexpected sublist at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_STRING) { fatal("do_uid: unexpected string at %s:%d", cpe->file, cpe->line); } pw= getpwnam(cpe->word); if (pw != NULL) uid= pw->pw_uid; else { uid= strtol(cpe->word, &check, 0); if (check[0] != '\0') { fatal("do_uid: bad uid/login '%s' at %s:%d", cpe->word, cpe->file, cpe->line); } } rs_start.rss_uid= uid; } PRIVATE void do_nice(config_t *cpe) { int nice_val; char *check; /* Process a nice value */ if (cpe->next != NULL) { fatal("do_nice: just one nice value expected at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_SUBLIST) { fatal("do_nice: unexpected sublist at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_STRING) { fatal("do_nice: unexpected string at %s:%d", cpe->file, cpe->line); } nice_val= strtol(cpe->word, &check, 0); if (check[0] != '\0') { fatal("do_nice: bad nice value '%s' at %s:%d", cpe->word, cpe->file, cpe->line); } /* Check range? */ rs_start.rss_nice= nice_val; } PRIVATE void do_irq(config_t *cpe) { int irq; char *check; /* Process a list of IRQs */ for (; cpe; cpe= cpe->next) { if (cpe->flags & CFG_SUBLIST) { fatal("do_irq: unexpected sublist at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_STRING) { fatal("do_irq: unexpected string at %s:%d", cpe->file, cpe->line); } irq= strtoul(cpe->word, &check, 0); if (check[0] != '\0') { fatal("do_irq: bad irq '%s' at %s:%d", cpe->word, cpe->file, cpe->line); } if (rs_start.rss_nr_irq >= RSS_NR_IRQ) fatal("do_irq: too many IRQs (max %d)", RSS_NR_IRQ); rs_start.rss_irq[rs_start.rss_nr_irq]= irq; rs_start.rss_nr_irq++; } } PRIVATE void do_io(config_t *cpe) { int irq; unsigned base, len; char *check; /* Process a list of I/O ranges */ for (; cpe; cpe= cpe->next) { if (cpe->flags & CFG_SUBLIST) { fatal("do_io: unexpected sublist at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_STRING) { fatal("do_io: unexpected string at %s:%d", cpe->file, cpe->line); } base= strtoul(cpe->word, &check, 0x10); len= 1; if (check[0] == ':') { len= strtoul(check+1, &check, 0x10); } if (check[0] != '\0') { fatal("do_io: bad I/O range '%s' at %s:%d", cpe->word, cpe->file, cpe->line); } if (rs_start.rss_nr_io >= RSS_NR_IO) fatal("do_io: too many I/O ranges (max %d)", RSS_NR_IO); rs_start.rss_io[rs_start.rss_nr_io].base= base; rs_start.rss_io[rs_start.rss_nr_io].len= len; rs_start.rss_nr_io++; } } PRIVATE void do_pci_device(config_t *cpe) { u16_t vid, did; char *check, *check2; /* Process a list of PCI device IDs */ for (; cpe; cpe= cpe->next) { if (cpe->flags & CFG_SUBLIST) { fatal("do_pci_device: unexpected sublist at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_STRING) { fatal("do_pci_device: unexpected string at %s:%d", cpe->file, cpe->line); } vid= strtoul(cpe->word, &check, 0x10); if (check[0] == '/') did= strtoul(check+1, &check2, 0x10); if (check[0] != '/' || check2[0] != '\0') { fatal("do_pci_device: bad ID '%s' at %s:%d", cpe->word, cpe->file, cpe->line); } if (rs_start.rss_nr_pci_id >= RSS_NR_PCI_ID) { fatal("do_pci_device: too many device IDs (max %d)", RSS_NR_PCI_ID); } rs_start.rss_pci_id[rs_start.rss_nr_pci_id].vid= vid; rs_start.rss_pci_id[rs_start.rss_nr_pci_id].did= did; rs_start.rss_nr_pci_id++; } } PRIVATE void do_pci_class(config_t *cpe) { u8_t baseclass, subclass, interface; u32_t class_id, mask; char *check; /* Process a list of PCI device class IDs */ for (; cpe; cpe= cpe->next) { if (cpe->flags & CFG_SUBLIST) { fatal("do_pci_device: unexpected sublist at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_STRING) { fatal("do_pci_device: unexpected string at %s:%d", cpe->file, cpe->line); } baseclass= strtoul(cpe->word, &check, 0x10); subclass= 0; interface= 0; mask= 0xff0000; if (check[0] == '/') { subclass= strtoul(check+1, &check, 0x10); mask= 0xffff00; if (check[0] == '/') { interface= strtoul(check+1, &check, 0x10); mask= 0xffffff; } } if (check[0] != '\0') { fatal("do_pci_class: bad class ID '%s' at %s:%d", cpe->word, cpe->file, cpe->line); } class_id= (baseclass << 16) | (subclass << 8) | interface; if (rs_start.rss_nr_pci_class >= RSS_NR_PCI_CLASS) { fatal("do_pci_class: too many class IDs (max %d)", RSS_NR_PCI_CLASS); } rs_start.rss_pci_class[rs_start.rss_nr_pci_class].class= class_id; rs_start.rss_pci_class[rs_start.rss_nr_pci_class].mask= mask; rs_start.rss_nr_pci_class++; } } PRIVATE void do_pci(config_t *cpe) { int i, call_nr, word, bits_per_word; unsigned long mask; if (cpe == NULL) return; /* Empty PCI statement */ if (cpe->flags & CFG_SUBLIST) { fatal("do_pci: unexpected sublist at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_STRING) { fatal("do_pci: unexpected string at %s:%d", cpe->file, cpe->line); } if (strcmp(cpe->word, KW_DEVICE) == 0) { do_pci_device(cpe->next); return; } if (strcmp(cpe->word, KW_CLASS) == 0) { do_pci_class(cpe->next); return; } fatal("do_pci: unexpected word '%s' at %s:%d", cpe->word, cpe->file, cpe->line); } struct { char *label; int call_nr; } system_tab[]= { { "EXIT", SYS_EXIT }, { "PRIVCTL", SYS_PRIVCTL }, { "TRACE", SYS_TRACE }, { "KILL", SYS_KILL }, { "UMAP", SYS_UMAP }, { "VIRCOPY", SYS_VIRCOPY }, { "IRQCTL", SYS_IRQCTL }, { "DEVIO", SYS_DEVIO }, { "SDEVIO", SYS_SDEVIO }, { "VDEVIO", SYS_VDEVIO }, { "SETALARM", SYS_SETALARM }, { "TIMES", SYS_TIMES }, { "GETINFO", SYS_GETINFO }, { "SAFECOPYFROM", SYS_SAFECOPYFROM }, { "SAFECOPYTO", SYS_SAFECOPYTO }, { "VSAFECOPY", SYS_VSAFECOPY }, { "SETGRANT", SYS_SETGRANT }, { "READBIOS", SYS_READBIOS }, { NULL, 0 } }; PRIVATE void do_system(config_t *cpe) { int i, call_nr, word, bits_per_word; unsigned long mask; bits_per_word= sizeof(rs_start.rss_system[0])*8; /* Process a list of 'system' calls that are allowed */ for (; cpe; cpe= cpe->next) { if (cpe->flags & CFG_SUBLIST) { fatal("do_system: unexpected sublist at %s:%d", cpe->file, cpe->line); } if (cpe->flags & CFG_STRING) { fatal("do_system: unexpected string at %s:%d", cpe->file, cpe->line); } /* Get call number */ for (i= 0; system_tab[i].label != NULL; i++) { if (strcmp(cpe->word, system_tab[i].label) == 0) break; } if (system_tab[i].label == NULL) { fatal("do_system: unknown call '%s' at %s:%d", cpe->word, cpe->file, cpe->line); } call_nr= system_tab[i].call_nr; /* Subtract KERNEL_CALL */ if (call_nr < KERNEL_CALL) { fatal( "do_system: bad call number %d in system tab for '%s'\n", call_nr, system_tab[i].label); } call_nr -= KERNEL_CALL; word= call_nr / bits_per_word; mask= (1UL << (call_nr % bits_per_word)); if (word >= RSS_NR_SYSTEM) { fatal( "do_system: RSS_NR_SYSTEM is too small (%d needed)\n", word+1); } rs_start.rss_system[word] |= mask; } } PRIVATE void do_driver(config_t *cpe, config_t *config) { config_t *cp; /* At this point we expect one sublist that contains the varios * resource allocations */ if (!(cpe->flags & CFG_SUBLIST)) { fatal("do_driver: expected list at %s:%d\n", cpe->file, cpe->line); } if (cpe->next != NULL) { cpe= cpe->next; fatal("do_driver: expected end of list at %s:%d\n", cpe->file, cpe->line); } cpe= cpe->list; /* Process the list */ for (cp= cpe; cp; cp= cp->next) { if (!(cp->flags & CFG_SUBLIST)) { fatal("do_driver: expected list at %s:%d\n", cp->file, cp->line); } cpe= cp->list; if ((cpe->flags & CFG_STRING) || (cpe->flags & CFG_SUBLIST)) { fatal("do_driver: expected word at %s:%d\n", cpe->file, cpe->line); } if (strcmp(cpe->word, KW_CLASS) == 0) { do_class(cpe->next, config); continue; } if (strcmp(cpe->word, KW_UID) == 0) { do_uid(cpe->next); continue; } if (strcmp(cpe->word, KW_NICE) == 0) { do_nice(cpe->next); continue; } if (strcmp(cpe->word, KW_IRQ) == 0) { do_irq(cpe->next); continue; } if (strcmp(cpe->word, KW_IO) == 0) { do_io(cpe->next); continue; } if (strcmp(cpe->word, KW_PCI) == 0) { do_pci(cpe->next); continue; } if (strcmp(cpe->word, KW_SYSTEM) == 0) { do_system(cpe->next); continue; } } } PRIVATE void do_config(char *label, char *filename) { config_t *config, *cp, *cpe; config= config_read(filename, 0, NULL); if (config == NULL) { fprintf(stderr, "config_read failed for '%s': %s\n", filename, strerror(errno)); exit(1); } /* Find an entry for our driver */ for (cp= config; cp; cp= cp->next) { if (!(cp->flags & CFG_SUBLIST)) { fatal("do_config: expected list at %s:%d\n", cp->file, cp->line); } cpe= cp->list; if ((cpe->flags & CFG_STRING) || (cpe->flags & CFG_SUBLIST)) { fatal("do_config: expected word at %s:%d\n", cpe->file, cpe->line); } /* At this place we expect the word 'driver' */ if (strcmp(cpe->word, KW_DRIVER) != 0) fatal("do_config: exected word '%S' at %s:%d\n", KW_DRIVER, cpe->file, cpe->line); cpe= cpe->next; if ((cpe->flags & CFG_STRING) || (cpe->flags & CFG_SUBLIST)) { fatal("do_config: expected word at %s:%d\n", cpe->file, cpe->line); } /* At this place we expect the name of the driver */ if (strcmp(cpe->word, label) == 0) break; } if (cp == NULL) { fprintf(stderr, "driver '%s' not found\n", label); return; } cpe= cpe->next; do_driver(cpe, config); } /* Main program. */ PUBLIC int main(int argc, char **argv) { message m; int result; int request; int i, s; char *label, *progname = NULL; struct passwd *pw; /* Verify and parse the command line arguments. All arguments are checked * here. If an error occurs, the problem is reported and exit(2) is called. * all needed parameters to perform the request are extracted and stored * global variables. */ request = parse_arguments(argc, argv); if(req_path) { /* Obtain binary name. */ progname = strrchr(req_path, '/'); assert(progname); /* an absolute path was required */ progname++; /* skip last slash */ } /* Arguments seem fine. Try to perform the request. Only valid requests * should end up here. The default is used for not yet supported requests. */ switch(request) { case RS_UP: case RS_UP_COPY: /* Build space-separated command string to be passed to RS server. */ strcpy(command, req_path); command[strlen(req_path)] = ' '; strcpy(command+strlen(req_path)+1, req_args); /* Build request message and send the request. */ m.RS_CMD_ADDR = command; m.RS_CMD_LEN = strlen(command); m.RS_DEV_MAJOR = req_major; m.RS_PERIOD = req_period; if (OK != (s=_taskcall(RS_PROC_NR, request, &m))) failure(-s); result = m.m_type; break; case RS_START: /* Build space-separated command string to be passed to RS server. */ strcpy(command, req_path); command[strlen(req_path)] = ' '; strcpy(command+strlen(req_path)+1, req_args); rs_start.rss_cmd= command; rs_start.rss_cmdlen= strlen(command); rs_start.rss_major= req_major; rs_start.rss_period= req_period; rs_start.rss_script= req_script; if(req_label) { rs_start.rss_label = req_label; rs_start.rss_labellen = strlen(req_label); } else { rs_start.rss_label = progname; rs_start.rss_labellen = strlen(progname); } if (req_script) rs_start.rss_scriptlen= strlen(req_script); else rs_start.rss_scriptlen= 0; pw= getpwnam(DRIVER_LOGIN); if (pw == NULL) fatal("no passwd file entry for '%s'", DRIVER_LOGIN); rs_start.rss_uid= pw->pw_uid; /* The name of the driver */ (label= strrchr(req_path, '/')) ? label++ : (label= req_path); if (req_config) { assert(progname); do_config(progname, req_config); } m.RS_CMD_ADDR = (char *) &rs_start; /* Build request message and send the request. */ if (OK != (s=_taskcall(RS_PROC_NR, request, &m))) failure(-s); else if(req_printep) printf("%d\n", m.RS_ENDPOINT); result = m.m_type; break; case RS_DOWN: case RS_REFRESH: case RS_RESTART: m.RS_CMD_ADDR = req_label; m.RS_CMD_LEN = strlen(req_label); if (OK != (s=_taskcall(RS_PROC_NR, request, &m))) failure(-s); break; case RS_SHUTDOWN: if (OK != (s=_taskcall(RS_PROC_NR, request, &m))) failure(-s); break; default: print_usage(argv[ARG_NAME], "request is not yet supported"); result = EGENERIC; } return(result); }