improve command-line help for --enable_peer_stats
[openafs.git] / src / volser / volmain.c
index 367a8a8..2dfed9a 100644 (file)
@@ -14,6 +14,7 @@
 #include <afs/opr.h>
 #ifdef AFS_PTHREAD_ENV
 # include <opr/lock.h>
+# include <opr/softsig.h>
 #endif
 
 #ifdef AFS_NT40_ENV
@@ -70,16 +71,19 @@ int debuglevel = 0;
 #define MAXLWP 128
 int lwps = 9;
 int udpBufSize = 0;            /* UDP buffer size for receive */
+int restrictedQueryLevel = RESTRICTED_QUERY_ANYUSER;
 
 int rxBind = 0;
 int rxkadDisableDotCheck = 0;
-int DoPreserveVolumeStats = 0;
+int DoPreserveVolumeStats = 1;
 int rxJumbograms = 0;  /* default is to not send and receive jumbograms. */
 int rxMaxMTU = -1;
 char *auditFileName = NULL;
-char *logFile = NULL;
+static struct logOptions logopts;
 char *configDir = NULL;
 
+enum vol_s2s_crypt doCrypt = VS2SC_NEVER;
+
 #define ADDRSPERSITE 16         /* Same global is in rx/rx_user.c */
 afs_uint32 SHostAddrs[ADDRSPERSITE];
 
@@ -129,7 +133,7 @@ BKGLoop(void *unused)
     struct timeval tv;
     int loop = 0;
 
-    afs_pthread_setname_self("vol bkg");
+    opr_threadname_set("vol bkg");
     while (1) {
        tv.tv_sec = GCWAKEUP;
        tv.tv_usec = 0;
@@ -147,54 +151,14 @@ BKGLoop(void *unused)
        loop++;
        if (loop == 10) {       /* reopen log every 5 minutes */
            loop = 0;
-           ReOpenLog(AFSDIR_SERVER_VOLSERLOG_FILEPATH);
+           ReOpenLog();
        }
     }
 
-    return NULL;
-}
-
-/* Background daemon for sleeping so the volserver does not become I/O bound */
-afs_int32 TTsleep, TTrun;
-#ifndef AFS_PTHREAD_ENV
-static void *
-BKGSleep(void *unused)
-{
-    struct volser_trans *tt;
-
-    if (TTsleep) {
-       while (1) {
-#ifdef AFS_PTHREAD_ENV
-           sleep(TTrun);
-#else /* AFS_PTHREAD_ENV */
-           IOMGR_Sleep(TTrun);
-#endif
-           VTRANS_LOCK;
-           for (tt = TransList(); tt; tt = tt->next) {
-                VTRANS_OBJ_LOCK(tt);
-               if ((strcmp(tt->lastProcName, "DeleteVolume") == 0)
-                   || (strcmp(tt->lastProcName, "Clone") == 0)
-                   || (strcmp(tt->lastProcName, "ReClone") == 0)
-                   || (strcmp(tt->lastProcName, "Forward") == 0)
-                   || (strcmp(tt->lastProcName, "Restore") == 0)
-                   || (strcmp(tt->lastProcName, "ForwardMulti") == 0)) {
-                    VTRANS_OBJ_UNLOCK(tt);
-                   break;
-                }
-                VTRANS_OBJ_UNLOCK(tt);
-           }
-           if (tt) {
-               VTRANS_UNLOCK;
-               sleep(TTsleep);
-           } else
-               VTRANS_UNLOCK;
-       }
-    }
-    return NULL;
+    AFS_UNREACHED(return(NULL));
 }
-#endif
 
-#ifdef AFS_NT40_ENV
+#if defined(AFS_NT40_ENV) || defined(AFS_DARWIN160_ENV)
 /* no volser_syscall */
 #elif defined(AFS_SUN511_ENV)
 int
@@ -208,6 +172,13 @@ volser_syscall(afs_uint32 a3, afs_uint32 a4, void *a5)
     }
     return err;
 }
+#elif !defined(AFS_SYSCALL)
+int
+volser_syscall(afs_uint32 a3, afs_uint32 a4, void *a5)
+{
+    errno = ENOSYS;
+    return -1;
+}
 #else
 int
 volser_syscall(afs_uint32 a3, afs_uint32 a4, void *a5)
@@ -272,27 +243,35 @@ enum optionsList {
     OPT_peer,
     OPT_process,
     OPT_preserve_vol_stats,
+    OPT_clear_vol_stats,
     OPT_sync,
+#ifdef HAVE_SYSLOG
     OPT_syslog,
+#endif
     OPT_logfile,
-    OPT_config
+    OPT_config,
+    OPT_restricted_query,
+    OPT_transarc_logs,
+    OPT_s2s_crypt
 };
 
 static int
 ParseArgs(int argc, char **argv) {
     int code;
     int optval;
-    char *optstring;
+    char *optstring = NULL;
     struct cmd_syndesc *opts;
-    char *sleepSpec;
-    char *sync_behavior;
+    char *sleepSpec = NULL;
+    char *sync_behavior = NULL;
+    char *restricted_query_parameter = NULL;
+    char *s2s_crypt_behavior = NULL;
 
-    opts = cmd_CreateSyntax(NULL, NULL, NULL, NULL);
+    opts = cmd_CreateSyntax(NULL, NULL, NULL, 0, NULL);
     cmd_AddParmAtOffset(opts, OPT_log, "-log", CMD_FLAG, CMD_OPTIONAL,
           "log vos users");
     cmd_AddParmAtOffset(opts, OPT_rxbind, "-rxbind", CMD_FLAG, CMD_OPTIONAL,
           "bind only to the primary interface");
-    cmd_AddParmAtOffset(opts, OPT_dotted, "-dotted", CMD_FLAG, CMD_OPTIONAL,
+    cmd_AddParmAtOffset(opts, OPT_dotted, "-allow-dotted-principals", CMD_FLAG, CMD_OPTIONAL,
           "permit Kerberos 5 principals with dots");
     cmd_AddParmAtOffset(opts, OPT_debug, "-d", CMD_SINGLE, CMD_OPTIONAL,
           "debug level");
@@ -313,21 +292,31 @@ ParseArgs(int argc, char **argv) {
     cmd_AddParmAtOffset(opts, OPT_sleep, "-sleep", CMD_SINGLE,
            CMD_OPTIONAL, "make background daemon sleep (LWP only)");
     cmd_AddParmAtOffset(opts, OPT_peer, "-enable_peer_stats", CMD_FLAG,
-           CMD_OPTIONAL, "enable RX transport statistics");
+           CMD_OPTIONAL, "enable RX RPC statistics by peer");
     cmd_AddParmAtOffset(opts, OPT_process, "-enable_process_stats", CMD_FLAG,
            CMD_OPTIONAL, "enable RX RPC statistics");
+    /* -preserve-vol-stats on by default now. */
     cmd_AddParmAtOffset(opts, OPT_preserve_vol_stats, "-preserve-vol-stats", CMD_FLAG,
-           CMD_OPTIONAL, "preserve volume statistics");
-#if !defined(AFS_NT40_ENV)
+           CMD_OPTIONAL|CMD_HIDDEN,
+           "preserve volume statistics when restoring/recloning");
+    cmd_AddParmAtOffset(opts, OPT_clear_vol_stats, "-clear-vol-stats", CMD_FLAG,
+           CMD_OPTIONAL, "clear volume statistics when restoring/recloning");
+#ifdef HAVE_SYSLOG
     cmd_AddParmAtOffset(opts, OPT_syslog, "-syslog", CMD_SINGLE_OR_FLAG,
            CMD_OPTIONAL, "log to syslog");
 #endif
+    cmd_AddParmAtOffset(opts, OPT_transarc_logs, "-transarc-logs", CMD_FLAG,
+                       CMD_OPTIONAL, "enable Transarc style logging");
     cmd_AddParmAtOffset(opts, OPT_sync, "-sync",
            CMD_SINGLE, CMD_OPTIONAL, "always | onclose | never");
     cmd_AddParmAtOffset(opts, OPT_logfile, "-logfile", CMD_SINGLE,
           CMD_OPTIONAL, "location of log file");
     cmd_AddParmAtOffset(opts, OPT_config, "-config", CMD_SINGLE,
           CMD_OPTIONAL, "configuration location");
+    cmd_AddParmAtOffset(opts, OPT_restricted_query, "-restricted_query",
+           CMD_SINGLE, CMD_OPTIONAL, "anyuser | admin");
+    cmd_AddParmAtOffset(opts, OPT_s2s_crypt, "-s2scrypt",
+           CMD_SINGLE, CMD_OPTIONAL, "always | inherit | never");
 
     code = cmd_Parse(argc, argv, &opts);
     if (code == CMD_HELP) {
@@ -339,8 +328,8 @@ ParseArgs(int argc, char **argv) {
     cmd_OptionAsFlag(opts, OPT_log, &DoLogging);
     cmd_OptionAsFlag(opts, OPT_rxbind, &rxBind);
     cmd_OptionAsFlag(opts, OPT_dotted, &rxkadDisableDotCheck);
-    cmd_OptionAsFlag(opts, OPT_preserve_vol_stats, &DoPreserveVolumeStats);
-    cmd_OptionAsInt(opts, OPT_debug, &LogLevel);
+    if (cmd_OptionPresent(opts, OPT_clear_vol_stats))
+       DoPreserveVolumeStats = 0;
     if (cmd_OptionPresent(opts, OPT_peer))
        rx_enablePeerRPCStats();
     if (cmd_OptionPresent(opts, OPT_process))
@@ -349,12 +338,36 @@ ParseArgs(int argc, char **argv) {
        rxJumbograms = 0;
     if (cmd_OptionPresent(opts, OPT_jumbo))
        rxJumbograms = 1;
-#ifndef AFS_NT40_ENV
+
+#ifdef HAVE_SYSLOG
     if (cmd_OptionPresent(opts, OPT_syslog)) {
-       serverLogSyslog = 1;
-       cmd_OptionAsInt(opts, OPT_syslog, &serverLogSyslogFacility);
-    }
+       if (cmd_OptionPresent(opts, OPT_logfile)) {
+           fprintf(stderr, "Invalid options: -syslog and -logfile are exclusive.\n");
+           return -1;
+       }
+       if (cmd_OptionPresent(opts, OPT_transarc_logs)) {
+           fprintf(stderr, "Invalid options: -syslog and -transarc-logs are exclusive.\n");
+           return -1;
+       }
+       logopts.lopt_dest = logDest_syslog;
+       logopts.lopt_facility = LOG_DAEMON;
+       logopts.lopt_tag = "volserver";
+       cmd_OptionAsInt(opts, OPT_syslog, &logopts.lopt_facility);
+    } else
 #endif
+    {
+       logopts.lopt_dest = logDest_file;
+       if (cmd_OptionPresent(opts, OPT_transarc_logs)) {
+           logopts.lopt_rotateOnOpen = 1;
+           logopts.lopt_rotateStyle = logRotate_old;
+       }
+       if (cmd_OptionPresent(opts, OPT_logfile))
+           cmd_OptionAsString(opts, OPT_logfile, (char**)&logopts.lopt_filename);
+       else
+           logopts.lopt_filename = AFSDIR_SERVER_VOLSERLOG_FILEPATH;
+    }
+    cmd_OptionAsInt(opts, OPT_debug, &logopts.lopt_logLevel);
+
     cmd_OptionAsInt(opts, OPT_rxmaxmtu, &rxMaxMTU);
     if (cmd_OptionAsInt(opts, OPT_udpsize, &optval) == 0) {
        if (optval < rx_GetMinUdpBufSize()) {
@@ -380,13 +393,7 @@ ParseArgs(int argc, char **argv) {
        }
     }
     if (cmd_OptionAsString(opts, OPT_sleep, &sleepSpec) == 0) {
-       sscanf(sleepSpec, "%d/%d", &TTsleep, &TTrun);
-       if ((TTsleep < 0) || (TTrun <= 0)) {
-           printf("Warning: '-sleep %d/%d' is incorrect; ignoring\n",
-                   TTsleep, TTrun);
-           TTsleep = TTrun = 0;
-       }
-
+       printf("Warning: -sleep option ignored; this option is obsolete\n");
     }
     if (cmd_OptionAsString(opts, OPT_sync, &sync_behavior) == 0) {
        if (ih_SetSyncBehavior(sync_behavior)) {
@@ -394,8 +401,33 @@ ParseArgs(int argc, char **argv) {
            return -1;
        }
     }
-    cmd_OptionAsString(opts, OPT_logfile, &logFile);
     cmd_OptionAsString(opts, OPT_config, &configDir);
+    if (cmd_OptionAsString(opts, OPT_restricted_query,
+                          &restricted_query_parameter) == 0) {
+       if (strcmp(restricted_query_parameter, "anyuser") == 0)
+           restrictedQueryLevel = RESTRICTED_QUERY_ANYUSER;
+       else if (strcmp(restricted_query_parameter, "admin") == 0)
+           restrictedQueryLevel = RESTRICTED_QUERY_ADMIN;
+       else {
+           printf("invalid argument for -restricted_query: %s\n",
+                  restricted_query_parameter);
+           return -1;
+       }
+       free(restricted_query_parameter);
+    }
+    if (cmd_OptionAsString(opts, OPT_s2s_crypt, &s2s_crypt_behavior) == 0) {
+       if (strcmp(s2s_crypt_behavior, "always") == 0)
+           doCrypt = VS2SC_ALWAYS;
+       else if (strcmp(s2s_crypt_behavior, "never") == 0)
+           doCrypt = VS2SC_NEVER;
+       else if (strcmp(s2s_crypt_behavior, "inherit") == 0)
+           doCrypt = VS2SC_INHERIT;
+       else {
+           printf("invalid argument for -s2scrypt: %s\n", s2s_crypt_behavior);
+           return -1;
+       }
+       free(s2s_crypt_behavior);
+    }
 
     return 0;
 }
@@ -409,6 +441,7 @@ main(int argc, char **argv)
     afs_int32 numClasses;
     struct rx_service *service;
     int rxpackets = 100;
+    char hoststr[16];
     afs_uint32 host = ntohl(INADDR_ANY);
     VolumePackageOptions opts;
 
@@ -440,12 +473,11 @@ main(int argc, char **argv)
        exit(2);
     }
 
-    TTsleep = TTrun = 0;
-
     configDir = strdup(AFSDIR_SERVER_ETC_DIRPATH);
-    logFile = strdup(AFSDIR_SERVER_VOLSERLOG_FILEPATH);
 
-    ParseArgs(argc, argv);
+    if (ParseArgs(argc, argv)) {
+       exit(1);
+    }
 
     if (auditFileName) {
        osi_audit_file(auditFileName);
@@ -471,9 +503,8 @@ main(int argc, char **argv)
        exit(1);
     }
 #endif
-    /* Open VolserLog and map stdout, stderr into it; VInitVolumePackage2 can
-       log, so we need to do this here */
-    OpenLog(logFile);
+
+    OpenLog(&logopts);
 
     VOptDefaults(volumeServer, &opts);
     if (VInitVolumePackage2(volumeServer, &opts)) {
@@ -486,7 +517,7 @@ main(int argc, char **argv)
 #ifndef AFS_PTHREAD_ENV
     vol_PollProc = IOMGR_Poll; /* tell vol pkg to poll io system periodically */
 #endif
-#ifndef AFS_NT40_ENV
+#if !defined( AFS_NT40_ENV ) && !defined(AFS_DARWIN160_ENV)
     rxi_syscallp = volser_syscall;
 #endif
     rx_nPackets = rxpackets;   /* set the max number of packets */
@@ -509,6 +540,8 @@ main(int argc, char **argv)
             host = SHostAddrs[0];
     }
 
+    Log("Volserver binding rx to %s:%d\n",
+        afs_inet_ntoa_r(host, hoststr), AFSCONF_VOLUMEPORT);
     code = rx_InitHost(host, (int)htons(AFSCONF_VOLUMEPORT));
     if (code) {
        fprintf(stderr, "rx init failed on socket AFSCONF_VOLUMEPORT %u\n",
@@ -529,7 +562,12 @@ main(int argc, char **argv)
     rx_SetRxDeadTime(420);
     memset(busyFlags, 0, sizeof(busyFlags));
 
+#ifdef AFS_PTHREAD_ENV
+    opr_softsig_Init();
+    SetupLogSoftSignals();
+#else
     SetupLogSignals();
+#endif
 
     {
 #ifdef AFS_PTHREAD_ENV
@@ -542,7 +580,6 @@ main(int argc, char **argv)
 #else
        PROCESS pid;
        LWP_CreateProcess(BKGLoop, 16*1024, 3, 0, "vol bkg daemon", &pid);
-       LWP_CreateProcess(BKGSleep,16*1024, 3, 0, "vol slp daemon", &pid);
 #endif
     }
 
@@ -552,7 +589,7 @@ main(int argc, char **argv)
     if (!tdir) {
        Abort("volser: could not open conf files in %s\n",
              configDir);
-       VS_EXIT(1);
+       AFS_UNREACHED(VS_EXIT(1));
     }
 
     /* initialize audit user check */
@@ -581,8 +618,14 @@ main(int argc, char **argv)
 #endif
 
     if (rxkadDisableDotCheck) {
-        rx_SetSecurityConfiguration(service, RXS_CONFIG_FLAGS,
-                                    (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
+       code = rx_SetSecurityConfiguration(service, RXS_CONFIG_FLAGS,
+                                          (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
+       if (code) {
+           fprintf(stderr,
+                   "volser: failed to allow dotted principals: code %d\n",
+                   code);
+           VS_EXIT(1);
+       }
     }
 
     service =
@@ -598,11 +641,6 @@ main(int argc, char **argv)
     if (afsconf_GetLatestKey(tdir, NULL, NULL) == 0) {
        LogDesWarning();
     }
-    if (TTsleep) {
-       Log("Will sleep %d second%s every %d second%s\n", TTsleep,
-           (TTsleep > 1) ? "s" : "", TTrun + TTsleep,
-           (TTrun + TTsleep > 1) ? "s" : "");
-    }
 
     /* allow super users to manage RX statistics */
     rx_SetRxStatUserOk(vol_rxstat_userok);
@@ -611,5 +649,5 @@ main(int argc, char **argv)
 
     osi_audit(VS_FinishEvent, (-1), AUD_END);
     Abort("StartServer returned?");
-    return 0; /* not reached */
+    AFS_UNREACHED(return 0);
 }