Changeset 79514 in vbox for trunk/src/VBox/NetworkServices/Dhcpd

Timestamp:

Jul 4, 2019 8:01:58 AM (6 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

131793

Message:

Dhcpd: Eliminated use of std::string (probably my mistake in the original code). Various other cleanups. bugref:9288

Location:

trunk/src/VBox/NetworkServices/Dhcpd

Files:

• Config.cpp (modified) (13 diffs)
• Config.h (modified) (3 diffs)
• DHCPD.h (modified) (2 diffs)
• Db.cpp (modified) (4 diffs)
• Db.h (modified) (2 diffs)
• DhcpMessage.cpp (modified) (4 diffs)
• DhcpMessage.h (modified) (2 diffs)
• DhcpOptions.h (modified) (7 diffs)
• VBoxNetDhcpd.cpp (modified) (5 diffs)

trunk/src/VBox/NetworkServices/Dhcpd/Config.cpp

@@ -18 +18 @@
 #include "Config.h"
 
-#include <iprt/types.h>
+#include <iprt/ctype.h>
 #include <iprt/net.h>           /* NB: must come before getopt.h */
 #include <iprt/getopt.h>
@@ -88 +88 @@
 
 
-void Config::setNetwork(const std::string &aStrNetwork)
-{
-    AssertReturnVoid(m_strNetwork.empty());
+void Config::setNetwork(const RTCString &aStrNetwork)
+{
+    AssertReturnVoid(m_strNetwork.isEmpty());
 
     m_strNetwork = aStrNetwork;
@@ -104 +104 @@
 int Config::logInit()
 {
-    int rc;
-    size_t cch;
-
-    if (m_strHome.empty() || m_strBaseName.empty())
-        return VERR_GENERAL_FAILURE;
+    if (m_strHome.isEmpty() || m_strBaseName.isEmpty())
+        return VERR_PATH_ZERO_LENGTH;
 
     /* default log file name */
     char szLogFile[RTPATH_MAX];
-    cch = RTStrPrintf(szLogFile, sizeof(szLogFile),
-                      "%s%c%s-Dhcpd.log",
-                      m_strHome.c_str(), RTPATH_DELIMITER, m_strBaseName.c_str());
-    if (cch >= sizeof(szLogFile))
+    ssize_t cch = RTStrPrintf2(szLogFile, sizeof(szLogFile),
+                               "%s%c%s-Dhcpd.log",
+                               m_strHome.c_str(), RTPATH_DELIMITER, m_strBaseName.c_str());
+    if (cch <= 0)
         return VERR_BUFFER_OVERFLOW;
 
-
-    /* get a writable copy of the base name */
-    char szBaseName[RTPATH_MAX];
-    rc = RTStrCopy(szBaseName, sizeof(szBaseName), m_strBaseName.c_str());
-    if (RT_FAILURE(rc))
-        return rc;
-
-    /* sanitize base name some more to be usable in an environment variable name */
-    for (char *p = szBaseName; *p != '\0'; ++p)
-    {
-        if (   *p != '_'
-            && (*p < '0' || '9' < *p)
-            && (*p < 'a' || 'z' < *p)
-            && (*p < 'A' || 'Z' < *p))
-        {
+    /* Sanitize base name some more to be usable in an environment variable name: */
+    char szEnvVarBase[128];
+    cch = RTStrPrintf(szEnvVarBase, sizeof(szEnvVarBase), "VBOXDHCP_%s_RELEASE_LOG", m_strBaseName.c_str());
+    if (cch <= 0)
+        return VERR_BUFFER_OVERFLOW;
+    for (char *p = szEnvVarBase; *p != '\0'; ++p)
+        if (*p != '_' && !RT_C_IS_ALNUM(*p))
             *p = '_';
-        }
-    }
-
-
-    /* name of the environment variable to control logging */
-    char szEnvVarBase[128];
-    cch = RTStrPrintf(szEnvVarBase, sizeof(szEnvVarBase),
-                      "VBOXDHCP_%s_RELEASE_LOG", szBaseName);
-    if (cch >= sizeof(szEnvVarBase))
-        return VERR_BUFFER_OVERFLOW;
-
-
-    rc = com::VBoxLogRelCreate("DHCP Server",
-                               szLogFile,
-                               RTLOGFLAGS_PREFIX_TIME_PROG,
-                               "all all.restrict -default.restrict",
-                               szEnvVarBase,
-                               RTLOGDEST_FILE
+
+
+    int rc = com::VBoxLogRelCreate("DHCP Server",
+                                   szLogFile,
+                                   RTLOGFLAGS_PREFIX_TIME_PROG,
+                                   "all all.restrict -default.restrict",
+                                   szEnvVarBase,
+                                   RTLOGDEST_FILE
 #ifdef DEBUG
-                               | RTLOGDEST_STDERR
+                                   | RTLOGDEST_STDERR
 #endif
-                               ,
-                               32768 /* cMaxEntriesPerGroup */,
-                               0 /* cHistory */,
-                               0 /* uHistoryFileTime */,
-                               0 /* uHistoryFileSize */,
-                               NULL /* pErrInfo */);
+                                   ,
+                                   32768 /* cMaxEntriesPerGroup */,
+                                   0 /* cHistory */,
+                                   0 /* uHistoryFileTime */,
+                                   0 /* uHistoryFileSize */,
+                                   NULL /* pErrInfo */);
 
     return rc;
@@ -170 +149 @@
     int rc;
 
-    if (m_strNetwork.empty())
+    if (m_strNetwork.isEmpty())
     {
         LogDHCP(("network name is not specified\n"));
@@ -212 +191 @@
 
     /* valid netmask */
-    int iPrefixLengh;
-    rc = RTNetMaskToPrefixIPv4(&m_IPv4Netmask, &iPrefixLengh);
-    if (RT_FAILURE(rc) || iPrefixLengh == 0)
+    int cPrefixBits;
+    rc = RTNetMaskToPrefixIPv4(&m_IPv4Netmask, &cPrefixBits);
+    if (RT_FAILURE(rc) || cPrefixBits == 0)
     {
         LogDHCP(("IP mask is not valid: %RTnaipv4\n", m_IPv4Netmask.u));
@@ -224 +203 @@
     {
         LogDHCP(("first pool address is outside the network %RTnaipv4/%d: %RTnaipv4\n",
-                 (m_IPv4Address.u & m_IPv4Netmask.u), iPrefixLengh,
-                 m_IPv4PoolFirst.u));
+                 (m_IPv4Address.u & m_IPv4Netmask.u), cPrefixBits, m_IPv4PoolFirst.u));
         return VERR_GENERAL_FAILURE;
     }
@@ -233 +211 @@
     {
         LogDHCP(("last pool address is outside the network %RTnaipv4/%d: %RTnaipv4\n",
-                 (m_IPv4Address.u & m_IPv4Netmask.u), iPrefixLengh,
-                 m_IPv4PoolLast.u));
+                 (m_IPv4Address.u & m_IPv4Netmask.u), cPrefixBits, m_IPv4PoolLast.u));
         return VERR_GENERAL_FAILURE;
     }
@@ -257 +234 @@
     if (!fMACGenerated)
         LogDHCP(("MAC address %RTmac\n", &m_MacAddress));
-    LogDHCP(("IP address %RTnaipv4/%d\n", m_IPv4Address.u, iPrefixLengh));
+    LogDHCP(("IP address %RTnaipv4/%d\n", m_IPv4Address.u, cPrefixBits));
     LogDHCP(("address pool %RTnaipv4 - %RTnaipv4\n", m_IPv4PoolFirst.u, m_IPv4PoolLast.u));
 
@@ -387 +364 @@
 
             case 'n': /* --network */
-                if (!config->m_strNetwork.empty())
+                if (!config->m_strNetwork.isEmpty())
                 {
                     RTMsgError("Duplicate --network option");
@@ -396 +373 @@
 
             case 't': /* --trunk-name */
-                if (!config->m_strTrunk.empty())
+                if (!config->m_strTrunk.isEmpty())
                 {
                     RTMsgError("Duplicate --trunk-name option");
@@ -641 +618 @@
         throw ConfigFileError("DHCPServer/@networkName missing");
 
-    setNetwork(strNetworkName.c_str());
+    setNetwork(strNetworkName);
 
     RTCString strTrunkType;
@@ -663 +640 @@
         if (!server->getAttributeValue("trunkName", &strTrunk))
             throw ConfigFileError("DHCPServer/@trunkName missing");
-        m_strTrunk = strTrunk.c_str();
+        m_strTrunk = strTrunk;
     }
     else
@@ -848 +825 @@
 void Config::sanitizeBaseName()
 {
-    int rc;
-
-    if (m_strNetwork.empty())
-        return;
-
-    char szBaseName[RTPATH_MAX];
-    rc = RTStrCopy(szBaseName, sizeof(szBaseName), m_strNetwork.c_str());
-    if (RT_FAILURE(rc))
-        return;
-
-    char ch;
+    if (m_strNetwork.isNotEmpty())
+    {
+        m_strBaseName = m_strNetwork;
+
+        char ch;
 #if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
-    static const char s_szIllegals[] = "/\\\"*:<>?|\t\v\n\r\f\a\b"; /** @todo all control chars... */
-    for (char *p = szBaseName; (ch = *p) != '\0'; ++p)
-        if (strchr(s_szIllegals, ch))
-            *p = '_';
+        static const char s_szIllegals[] = "/\\\"*:<>?|\t\v\n\r\f\a\b"; /** @todo all control chars... */
+        for (char *psz = m_strBaseName.mutableRaw(); (ch = *psz) != '\0'; ++psz)
+            if (strchr(s_szIllegals, ch))
+                *psz = '_';
 #else
-    for (char *p = szBaseName; (ch = *p) != '\0'; ++p)
-        if (RTPATH_IS_SEP(ch))
-            *p = '_';
+        for (char *psz = m_strBaseName.mutableRaw(); (ch = *psz) != '\0'; ++psz)
+            if (RTPATH_IS_SEP(ch))
+                *psz = '_';
 #endif
-
-    m_strBaseName.assign(szBaseName);
+        m_strBaseName.jolt(); /* Not really necessary, but it's protocol. */
+    }
+    else
+        m_strBaseName.setNull();
 }
 

trunk/src/VBox/NetworkServices/Dhcpd/Config.h

@@ -25 +25 @@
 #include <iprt/net.h>
 #include <iprt/cpp/xml.h>
+#include <iprt/cpp/ministring.h>
 
 #include <VBox/intnet.h>
 
-#include <string>
 
 #include "Defs.h"
@@ -37 +37 @@
 class Config
 {
-    /* XXX: TODO: also store fixed address assignments, etc? */
+    /** XXX: TODO: also store fixed address assignments, etc? */
     typedef std::map<RTMAC, optmap_t> vmmap_t;
 
-    std::string m_strHome;   /* path of ~/.VirtualBox or equivalent */
+    RTCString m_strHome;   /* path of ~/.VirtualBox or equivalent */
 
-    std::string m_strNetwork;
-    std::string m_strBaseName; /* m_strNetwork sanitized to be usable in a path component */
+    RTCString m_strNetwork;
+    RTCString m_strBaseName; /* m_strNetwork sanitized to be usable in a path component */
 
-    std::string m_strTrunk;
+    RTCString m_strTrunk;
     INTNETTRUNKTYPE m_enmTrunkType;
 
@@ -73 +73 @@
 
 public: /* accessors */
-    const std::string &getHome() const { return m_strHome; }
+    const RTCString &getHome() const { return m_strHome; }
 
-    const std::string &getNetwork() const { return m_strNetwork; }
-    void setNetwork(const std::string &aStrNetwork);
+    const RTCString &getNetwork() const { return m_strNetwork; }
+    void setNetwork(const RTCString &aStrNetwork);
 
-    const std::string &getBaseName() const { return m_strBaseName; }
-    const std::string &getTrunk() const { return m_strTrunk; }
+    const RTCString &getBaseName() const { return m_strBaseName; }
+    const RTCString &getTrunk() const { return m_strTrunk; }
     INTNETTRUNKTYPE getTrunkType() const { return m_enmTrunkType; }
 

trunk/src/VBox/NetworkServices/Dhcpd/DHCPD.h

@@ -22 +22 @@
 #endif
 
+#include <iprt/cpp/ministring.h>
 #include "Defs.h"
 #include "Config.h"
@@ -31 +32 @@
 {
     const Config *m_pConfig;
-    std::string m_strLeasesFileName;
+    RTCString m_strLeasesFileName;
     Db m_db;
 

trunk/src/VBox/NetworkServices/Dhcpd/Db.cpp

@@ -223 +223 @@
 Binding *Binding::fromXML(const xml::ElementNode *ndLease)
 {
-    int rc;
-
     /* Lease/@network seems to always have bogus value, ignore it. */
 
@@ -236 +234 @@
 
     RTMAC mac;
-    rc = RTNetStrToMacAddr(strMac.c_str(), &mac);
+    int rc = RTNetStrToMacAddr(strMac.c_str(), &mac);
     if (RT_FAILURE(rc))
         return NULL;
@@ -640 +638 @@
 
 
-int Db::writeLeases(const std::string &strFileName) const
+int Db::writeLeases(const RTCString &strFileName) const
 {
     LogDHCP(("writing leases to %s\n", strFileName.c_str()));
@@ -684 +682 @@
 
 
-int Db::loadLeases(const std::string &strFileName)
+int Db::loadLeases(const RTCString &strFileName)
 {
     LogDHCP(("loading leases from %s\n", strFileName.c_str()));

trunk/src/VBox/NetworkServices/Dhcpd/Db.h

@@ -24 +24 @@
 #include <iprt/net.h>
 
+#include <iprt/cpp/ministring.h>
 #include <iprt/cpp/xml.h>
 
@@ -145 +146 @@
 
 public:
-    int loadLeases(const std::string &strFileName);
+    int loadLeases(const RTCString &strFileName);
     void loadLease(const xml::ElementNode *ndLease);
 
-    int writeLeases(const std::string &strFileName) const;
+    int writeLeases(const RTCString &strFileName) const;
 
 private:

trunk/src/VBox/NetworkServices/Dhcpd/DhcpMessage.cpp

@@ -102 +102 @@
     }
 
-    int overload;
-    overload = msg->parseOptions(&bp->bp_vend.Dhcp.dhcp_opts,
-                                 buflen - RT_OFFSETOF(RTNETBOOTP, bp_vend.Dhcp.dhcp_opts));
-    if (overload < 0)
+    int fOptOverload = msg->parseOptions(&bp->bp_vend.Dhcp.dhcp_opts, buflen - RT_OFFSETOF(RTNETBOOTP, bp_vend.Dhcp.dhcp_opts));
+    if (fOptOverload < 0)
         return NULL;
 
     /* "The 'file' field MUST be interpreted next ..." */
-    if (overload & DHCP_OPTION_OVERLOAD_FILE) {
+    if (fOptOverload & RTNET_DHCP_OPTION_OVERLOAD_FILE)
+    {
         int status = msg->parseOptions(bp->bp_file, sizeof(bp->bp_file));
         if (status != 0)
@@ -124 +123 @@
 
     /* "... followed by the 'sname' field." */
-    if (overload & DHCP_OPTION_OVERLOAD_SNAME) {
+    if (fOptOverload & RTNET_DHCP_OPTION_OVERLOAD_SNAME)
+    {
         int status = msg->parseOptions(bp->bp_sname, sizeof(bp->bp_sname));
         if (status != 0) /* NB: this includes "nested" Option Overload */
@@ -150 +150 @@
 int DhcpClientMessage::parseOptions(const void *buf, size_t buflen)
 {
-    uint8_t opt, optlen;
-    const uint8_t *data;
-    int overload;
-
-    overload = 0;
-
-    data = static_cast<const uint8_t *>(buf);
-    while (buflen > 0) {
-        opt = *data++;
+    int            fOptOverload = 0;
+    const uint8_t *data        = static_cast<const uint8_t *>(buf);
+    while (buflen > 0)
+    {
+        uint8_t const opt = *data++;
         --buflen;
 
-        if (opt == RTNET_DHCP_OPT_PAD) {
+        if (opt == RTNET_DHCP_OPT_PAD)
             continue;
-        }
-
-        if (opt == RTNET_DHCP_OPT_END) {
-            break;
-        }
-
-        if (buflen == 0) {
+
+        if (opt == RTNET_DHCP_OPT_END)
+            break;
+
+        if (buflen == 0)
+        {
             RTPrintf("option %d has no length field\n", opt);
             return -1;
         }
 
-        optlen = *data++;
+        uint8_t optlen = *data++;
         --buflen;
 
-        if (optlen > buflen) {
-            RTPrintf("option %d truncated (length %d, but only %lu bytes left)\n",
-                   opt, optlen, (unsigned long)buflen);
+        if (optlen > buflen)
+        {
+            RTPrintf("option %d truncated (length %d, but only %lu bytes left)\n", opt, optlen, (unsigned long)buflen);
             return -1;
         }
@@ -188 +183 @@
             return -1;
 #endif
-        if (opt == RTNET_DHCP_OPT_OPTION_OVERLOAD) {
-            if (optlen != 1) {
-                RTPrintf("Overload Option (option %d) has invalid length %d\n",
-                       opt, optlen);
+        if (opt == RTNET_DHCP_OPT_OPTION_OVERLOAD)
+        {
+            if (optlen != 1)
+            {
+                RTPrintf("Overload Option (option %d) has invalid length %d\n", opt, optlen);
                 return -1;
             }
 
-            overload = *data;
-
-            if ((overload & ~DHCP_OPTION_OVERLOAD_MASK) != 0) {
-                RTPrintf("Overload Option (option %d) has invalid value 0x%x\n",
-                       opt, overload);
+            fOptOverload = *data;
+
+            if ((fOptOverload & ~RTNET_DHCP_OPTION_OVERLOAD_MASK) != 0)
+            {
+                RTPrintf("Overload Option (option %d) has invalid value 0x%x\n", opt, fOptOverload);
                 return -1;
             }
         }
         else
-        {
             m_rawopts.insert(std::make_pair(opt, octets_t(data, data + optlen)));
-        }
-
-        data += optlen;
+
+        data   += optlen;
         buflen -= optlen;
     }
 
-    return overload;
+    return fOptOverload;
 }
 

trunk/src/VBox/NetworkServices/Dhcpd/DhcpMessage.h

@@ -24 +24 @@
 #include "Defs.h"
 #include <iprt/net.h>
-#include <string>
+#include <iprt/cpp/ministring.h>
 #include "ClientId.h"
 #include "DhcpOptions.h"
 
-
-/* move to <iptr/net.h>? */
-#define DHCP_OPTION_OVERLOAD_MASK  0x3
-#define DHCP_OPTION_OVERLOAD_FILE  0x1
-#define DHCP_OPTION_OVERLOAD_SNAME 0x2
 
 
@@ -48 +43 @@
     RTNETADDRIPV4   m_giaddr;
 
-    std::string m_sname;
-    std::string m_file;
+    RTCString m_sname;
+    RTCString m_file;
 
     OptMessageType m_optMessageType;

trunk/src/VBox/NetworkServices/Dhcpd/DhcpOptions.h

@@ -24 +24 @@
 #include "Defs.h"
 
-#include <string.h>
-
+#include <iprt/asm.h>
 #include <iprt/err.h>
-#include <iprt/types.h>
-#include <iprt/asm.h>
-#include <iprt/stdint.h>
 #include <iprt/net.h>
-
-#include <string>
+#include <iprt/string.h>
+#include <iprt/cpp/ministring.h>
+
 
 class DhcpClientMessage;
@@ -105 +102 @@
     }
 
-    static void append(octets_t &aDst, const std::string &str)
-    {
-        append(aDst, str.c_str(), str.size());
+    static void append(octets_t &aDst, const RTCString &str)
+    {
+        append(aDst, str.c_str(), str.length());
     }
 
@@ -148 +145 @@
     }
 
-    static void extract(std::string &aString, octets_t::const_iterator &pos, size_t cb)
+#if 0 /** @todo fix me */
+    static void extract(RTCString &aString, octets_t::const_iterator &pos, size_t cb)
     {
         aString.replace(aString.begin(), aString.end(), &pos[0], &pos[cb]);
         pos += cb;
     }
+#endif
 
 
@@ -362 +361 @@
 {
   public:
-    typedef std::string value_t;
-
-  protected:
-    std::string m_String;
+    typedef RTCString value_t;
+
+  protected:
+    RTCString m_String;
 
     explicit OptStringBase(uint8_t aOptCode)
       : DhcpOption(aOptCode, false), m_String() {}
 
-    OptStringBase(uint8_t aOptCode, const std::string &aOptString)
+    OptStringBase(uint8_t aOptCode, const RTCString &aOptString)
       : DhcpOption(aOptCode), m_String(aOptString) {}
 
@@ -386 +385 @@
 
   public:
-    std::string &value() { return m_String; }
-    const std::string &value() const { return m_String; }
+    RTCString &value() { return m_String; }
+    const RTCString &value() const { return m_String; }
 
   protected:
     virtual ssize_t encodeValue(octets_t &dst) const
     {
-        if (!isLengthValid(m_String.size()))
+        if (!isLengthValid(m_String.length()))
             return -1;
 
         append(dst, m_String);
-        return m_String.size();
+        return m_String.length();
     }
 
@@ -410 +409 @@
             return VERR_INVALID_PARAMETER;
 
-        octets_t::const_iterator pos(src.begin());
-        extract(m_String, pos, cb);
+        int rc = m_String.assignNoThrow((char *)&src.front(), cb); /** @todo encoding. */
         m_fPresent = true;
-        return VINF_SUCCESS;
+        return rc;
     }
 };
@@ -427 +425 @@
       : OptStringBase(optcode) {}
 
-    explicit OptString(const std::string &aOptString)
+    explicit OptString(const RTCString &aOptString)
       : OptStringBase(optcode, aOptString) {}
 

trunk/src/VBox/NetworkServices/Dhcpd/VBoxNetDhcpd.cpp

@@ -119 +119 @@
     int vmmInit();
 
-    int ifInit(const std::string &strNetwork,
-               const std::string &strTrunk = std::string(),
+    int ifInit(const RTCString &strNetwork,
+               const RTCString &strTrunk = RTCString(),
                INTNETTRUNKTYPE enmTrunkType = kIntNetTrunkType_WhateverNone);
-    int ifOpen(const std::string &strNetwork,
-               const std::string &strTrunk,
+    int ifOpen(const RTCString &strNetwork,
+               const RTCString &strTrunk,
                INTNETTRUNKTYPE enmTrunkType);
     int ifGetBuf();
@@ -254 +254 @@
 
 
-int VBoxNetDhcpd::ifInit(const std::string &strNetwork,
-                         const std::string &strTrunk,
+int VBoxNetDhcpd::ifInit(const RTCString &strNetwork,
+                         const RTCString &strTrunk,
                          INTNETTRUNKTYPE enmTrunkType)
 {
@@ -276 +276 @@
 
 
-int VBoxNetDhcpd::ifOpen(const std::string &strNetwork,
-                         const std::string &strTrunk,
+int VBoxNetDhcpd::ifOpen(const RTCString &strNetwork,
+                         const RTCString &strTrunk,
                          INTNETTRUNKTYPE enmTrunkType)
 {
@@ -284 +284 @@
 
     INTNETOPENREQ OpenReq;
-    int rc;
+    RT_ZERO(OpenReq);
 
     OpenReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
@@ -290 +290 @@
     OpenReq.pSession = m_pSession;
 
-    strncpy(OpenReq.szNetwork, strNetwork.c_str(), sizeof(OpenReq.szNetwork));
-    OpenReq.szNetwork[sizeof(OpenReq.szNetwork) - 1] = '\0';
-
-    strncpy(OpenReq.szTrunk, strTrunk.c_str(), sizeof(OpenReq.szTrunk));
-    OpenReq.szTrunk[sizeof(OpenReq.szTrunk) - 1] = '\0';
+    int rc = RTStrCopy(OpenReq.szNetwork, sizeof(OpenReq.szNetwork), strNetwork.c_str());
+    AssertRCReturn(rc, rc);
+
+    rc = RTStrCopy(OpenReq.szTrunk, sizeof(OpenReq.szTrunk), strTrunk.c_str());
+    AssertRCReturn(rc, rc);
 
     if (enmTrunkType != kIntNetTrunkType_Invalid)