Changeset 87798 in vbox for trunk/src/VBox/NetworkServices/NAT

Timestamp:

Feb 19, 2021 9:37:34 AM (4 years ago)

Author:

vboxsync

Message:

NAT/Net: Do our own getopt, we only need one option really (the
network name) and we get the rest via the API. Main now starts us
with just the network name. First step towards divorcing from the old
base class. bugref:9929.

File:

• trunk/src/VBox/NetworkServices/NAT/VBoxNetLwipNAT.cpp (modified) (8 diffs)

trunk/src/VBox/NetworkServices/NAT/VBoxNetLwipNAT.cpp

@@ -45 +45 @@
 #include <iprt/param.h>
 #include <iprt/pipe.h>
-#include <iprt/getopt.h>
 #include <iprt/string.h>
 #include <iprt/mem.h>
@@ -54 +53 @@
 #include <iprt/cpp/utils.h>
 #include <VBox/log.h>
+
+#include <iprt/buildconfig.h>
+#include <iprt/getopt.h>
+#include <iprt/process.h>
 
 #include <VBox/sup.h>
@@ -182 +185 @@
     virtual ~VBoxNetLwipNAT();
 
-    virtual void usage() { /** @todo should be implemented */ };
-    virtual int parseOpt(int c, const RTGETOPTUNION &Value);
-
-    virtual bool isMainNeeded() const { return true; }
+    RTEXITCODE parseArgs(int argc, char *argv[]);
 
     virtual int init();
@@ -191 +191 @@
 
 private:
+    virtual int parseOpt(int c, const RTGETOPTUNION &Value);
+    virtual void usage();
+
+    virtual bool isMainNeeded() const { return true; }
+
     int initCom();
     int initHome();
@@ -236 +241 @@
 INTNETSEG VBoxNetLwipNAT::aXmitSeg[64];
 
-/**
- * Additional command line options.
- *
- * Our parseOpt() will be called by the base class if any of these are
- * supplied.
- */
-RTGETOPTDEF VBoxNetLwipNAT::s_aGetOptDef[] =
-{
-    /*
-     * Currently there are no extra options and since arrays can't be
-     * empty use a sentinel entry instead, so that the placeholder
-     * code to process the options can be supplied nonetheless.
-     */
-    {}                          /* sentinel */
-};
-
 
 
 VBoxNetLwipNAT::VBoxNetLwipNAT()
-  : VBoxNetBaseService("VBoxNetNAT", "nat-network")
+  : VBoxNetBaseService("VBoxNetNAT", "")
 {
     LogFlowFuncEnter();
@@ -292 +281 @@
     setMacAddress(mac);
 
-    /* tell the base class about our command line options */
-    for (PCRTGETOPTDEF pcOpt = &s_aGetOptDef[0]; pcOpt->iShort != 0; ++pcOpt)
-        addCommandLineOption(pcOpt);
-
     m_loOptDescriptor.lomap = NULL;
     m_loOptDescriptor.num_lomap = 0;
@@ -325 +310 @@
 
 /**
- * Hook into the option processing.
+ * Command line options.
  *
- * Called by VBoxNetBaseService::parseArgs() for options that are not
- * recognized by the base class.  See s_aGetOptDef[].
+ * @note This class is currently in transition away from being
+ * inheritted from VBoxNetBaseService, so it no longer calls its
+ * getopt code and has its own parseArgs() instead.
+ */
+RTGETOPTDEF VBoxNetLwipNAT::s_aGetOptDef[] =
+{
+    { "--network",              'n',   RTGETOPT_REQ_STRING },
+    { "--verbose",              'v',   RTGETOPT_REQ_NOTHING },
+};
+
+
+/** Icky hack to tell the caller it should exit with RTEXITCODE_SUCCESS */
+#define RTEXITCODE_DONE RTEXITCODE_32BIT_HACK
+
+void
+VBoxNetLwipNAT::usage()
+{
+    RTPrintf("%s Version %sr%u\n"
+             "(C) 2009-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
+             "All rights reserved.\n"
+             "\n"
+             "Usage: %s <options>\n"
+             "\n"
+             "Options:\n",
+             RTProcShortName(), RTBldCfgVersion(), RTBldCfgRevision(),
+             RTProcShortName());
+    for (size_t i = 0; i < RT_ELEMENTS(s_aGetOptDef); ++i)
+        RTPrintf("    -%c, %s\n", s_aGetOptDef[i].iShort, s_aGetOptDef[i].pszLong);
+}
+
+
+RTEXITCODE
+VBoxNetLwipNAT::parseArgs(int argc, char *argv[])
+{
+    unsigned int uVerbosity = 0;
+    int rc;
+
+    RTGETOPTSTATE State;
+    rc = RTGetOptInit(&State, argc, argv,
+                      s_aGetOptDef, RT_ELEMENTS(s_aGetOptDef),
+                      1, 0);
+
+    int ch;
+    RTGETOPTUNION Val;
+    while ((ch = RTGetOpt(&State, &Val)) != 0)
+    {
+        switch (ch)
+        {
+            case 'n':           /* --network */
+                if (!getNetworkName().empty())
+                    return RTMsgErrorExit(RTEXITCODE_SYNTAX, "multiple --network options");
+                setNetworkName(Val.psz);
+                break;
+
+            case 'v':           /* --verbose */
+                ++uVerbosity;
+                break;
+
+
+            /*
+             * Standard options recognized by RTGetOpt()
+             */
+
+            case 'V':           /* --version */
+                RTPrintf("%sr%u\n", RTBldCfgVersion(), RTBldCfgRevision());
+                return RTEXITCODE_DONE;
+
+            case 'h':           /* --help */
+                usage();
+                return RTEXITCODE_DONE;
+
+            case VINF_GETOPT_NOT_OPTION:
+                return RTMsgErrorExit(RTEXITCODE_SYNTAX, "unexpected non-option argument");
+
+            default:
+                return RTGetOptPrintError(ch, &Val);
+        }
+    }
+
+    if (getNetworkName().empty())
+        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "missing --network option");
+
+    /* tell the base class while we're still joined at the hip */
+    setVerbosityLevel((int32_t)uVerbosity);
+
+    return RTEXITCODE_SUCCESS;
+}
+
+
+/**
+ * @note This class is currently in transition away from being
+ * inheritted from VBoxNetBaseService, so it no longer calls its
+ * getopt code and has its own parseArgs() instead.
  */
 int VBoxNetLwipNAT::parseOpt(int c, const RTGETOPTUNION &Value)
@@ -2117 +2193 @@
     VBoxNetLwipNAT NAT;
 
-    int rcExit = NAT.parseArgs(argc - 1, argv + 1);
+    int rcExit = NAT.parseArgs(argc, argv);
     if (rcExit != RTEXITCODE_SUCCESS)
-        return rcExit;          /* messages are already printed */
+    {
+        /* messages are already printed */
+        return rcExit == RTEXITCODE_DONE ? RTEXITCODE_SUCCESS : rcExit;
+    }
 
     rc = NAT.init();