[libvirt] [PATCH 2/5] Introduce VIR_STRDUP to replace strdup

Tuesday, 2 April 2013

diff --git a/HACKING b/HACKING
index c8833c0..6230ffd 100644
--- a/HACKING
+++ b/HACKING
@@ -719,6 +719,11 @@ sizeof(dest) returns something meaningful). Note that this is a
macro, so
 arguments could be evaluated more than once. This is equivalent to
 virStrncpy(dest, src, strlen(src), sizeof(dest)).
 
+  VIR_STRDUP(char *c)
+
+You should avoid using strdup directly as it does not report OOM error. Use
+VIR_STRDUP(c) macro instead (@c is type of char *).
+
 
 Variable length string buffer
 =============================
diff --git a/cfg.mk b/cfg.mk
index 7a2c69f..8cc67a5 100644
--- a/cfg.mk
+++ b/cfg.mk
@@ -383,6 +383,11 @@ sc_prohibit_asprintf:
 	halt='use virAsprintf, not as'printf				\
 	  $(_sc_search_regexp)
 
+sc_prohibit_strdup:
+	@prohibit='\<strdup\>'							\
+    halt='use VIR_STRUP, not strdup'				\
+	  $(_sc_search_regexp)
+
 # Prefer virSetUIDGID.
 sc_prohibit_setuid:
 	@prohibit='\<set(re)?[ug]id\> *\('				\
@@ -814,6 +819,9 @@ exclude_file_name_regexp--sc_prohibit_always_true_header_tests = \
 exclude_file_name_regexp--sc_prohibit_asprintf = \
  
^(bootstrap.conf$$|src/util/virstring\.c$$|examples/domain-events/events-c/event-test\.c$$)
 
+exclude_file_name_regexp--sc_prohibit_strdup = \
+ 
^(bootstrap.conf$$|cfg.mk$$|docs/|examples/|python/|src/storage/parthelper.c$$|src/util/virerror.c$$|src/util/virstring.c$$|tests/|tools/)
+
 exclude_file_name_regexp--sc_prohibit_close = \
   (\.p[yl]$$|^docs/|^(src/util/virfile\.c|src/libvirt\.c)$$)
 
diff --git a/daemon/libvirtd-config.c b/daemon/libvirtd-config.c
index cc60098..915c7f3 100644
--- a/daemon/libvirtd-config.c
+++ b/daemon/libvirtd-config.c
@@ -59,7 +59,7 @@ remoteConfigGetStringList(virConfPtr conf, const char *key, char
***list_arg,
                            key);
             return -1;
         }
-        list[0] = strdup(p->str);
+        list[0] = VIR_STRDUP(p->str);
         list[1] = NULL;
         if (list[0] == NULL) {
             virReportError(VIR_ERR_CONFIG_UNSUPPORTED,
@@ -90,7 +90,7 @@ remoteConfigGetStringList(virConfPtr conf, const char *key, char
***list_arg,
                 VIR_FREE(list);
                 return -1;
             }
-            list[i] = strdup(pp->str);
+            list[i] = VIR_STRDUP(pp->str);
             if (list[i] == NULL) {
                 int j;
                 for (j = 0 ; j < i ; j++)
@@ -136,8 +136,8 @@ checkType(virConfValuePtr p, const char *filename,
 }
 
 /* If there is no config data for the key, #var_name, then do nothing.
-   If there is valid data of type VIR_CONF_STRING, and strdup succeeds,
-   store the result in var_name.  Otherwise, (i.e. invalid type, or strdup
+   If there is valid data of type VIR_CONF_STRING, and VIR_STRDUP succeeds,
+   store the result in var_name.  Otherwise, (i.e. invalid type, or VIR_STRDUP
    failure), give a diagnostic and "goto" the cleanup-and-fail label.  */
 #define GET_CONF_STR(conf, filename, var_name)                          \
     do {                                                                \
@@ -146,7 +146,7 @@ checkType(virConfValuePtr p, const char *filename,
             if (checkType(p, filename, #var_name, VIR_CONF_STRING) < 0) \
                 goto error;                                             \
             VIR_FREE(data->var_name);                                   \
-            if (!(data->var_name = strdup(p->str))) {                   \
+            if (!(data->var_name = VIR_STRDUP(p->str))) {                   \
                 virReportOOMError();                                    \
                 goto error;                                             \
             }                                                           \
@@ -200,7 +200,7 @@ int
 daemonConfigFilePath(bool privileged, char **configfile)
 {
     if (privileged) {
-        if (!(*configfile = strdup(SYSCONFDIR "/libvirt/libvirtd.conf")))
+        if (!(*configfile = VIR_STRDUP(SYSCONFDIR "/libvirt/libvirtd.conf")))
             goto no_memory;
     } else {
         char *configdir = NULL;
@@ -238,9 +238,9 @@ daemonConfigNew(bool privileged ATTRIBUTE_UNUSED)
     data->listen_tls = 1;
     data->listen_tcp = 0;
 
-    if (!(data->tls_port = strdup(LIBVIRTD_TLS_PORT)))
+    if (!(data->tls_port = VIR_STRDUP(LIBVIRTD_TLS_PORT)))
         goto no_memory;
-    if (!(data->tcp_port = strdup(LIBVIRTD_TCP_PORT)))
+    if (!(data->tcp_port = VIR_STRDUP(LIBVIRTD_TCP_PORT)))
         goto no_memory;
 
     /* Only default to PolicyKit if running as root */
@@ -257,10 +257,10 @@ daemonConfigNew(bool privileged ATTRIBUTE_UNUSED)
 #endif
 
     if (data->auth_unix_rw == REMOTE_AUTH_POLKIT)
-        data->unix_sock_rw_perms = strdup("0777"); /* Allow world */
+        data->unix_sock_rw_perms = VIR_STRDUP("0777"); /* Allow world */
     else
-        data->unix_sock_rw_perms = strdup("0700"); /* Allow user only */
-    data->unix_sock_ro_perms = strdup("0777"); /* Always allow world */
+        data->unix_sock_rw_perms = VIR_STRDUP("0700"); /* Allow user only
*/
+    data->unix_sock_ro_perms = VIR_STRDUP("0777"); /* Always allow world */
     if (!data->unix_sock_ro_perms ||
         !data->unix_sock_rw_perms)
         goto no_memory;
@@ -382,7 +382,7 @@ daemonConfigLoadOptions(struct daemonConfig *data,
      */
     if (data->auth_unix_rw == REMOTE_AUTH_POLKIT) {
         VIR_FREE(data->unix_sock_rw_perms);
-        if (!(data->unix_sock_rw_perms = strdup("0777"))) {
+        if (!(data->unix_sock_rw_perms = VIR_STRDUP("0777"))) {
             virReportOOMError();
             goto error;
         }
diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 7ef826c..0fbb500 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -853,6 +853,14 @@
       virStrncpy(dest, src, strlen(src), sizeof(dest)).
     </p>
 
+<pre>
+  VIR_STRDUP(char *c)
+</pre>
+    <p>
+      You should avoid using strdup directly as it does not report OOM error.
+      Use VIR_STRDUP(c) macro instead (@c is type of char *).
+    </p>
+
     <h2><a name="strbuf">Variable length string
buffer</a></h2>
 
     <p>
-- 
1.8.1.5


    

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

[libvirt] [PATCH 2/5] Introduce VIR_STRDUP to replace strdup