]> git.sur5r.net Git - bacula/bacula/blobdiff - bacula/src/filed/xattr.c
Rename bEventVssSnapshotLetters to bEventPrepareSnapshot
[bacula/bacula] / bacula / src / filed / xattr.c
index a222a8b3fbc74cb55ef29ed64d5e7a60315411dc..5781e76feb44bf136ef0b111d33fd8e07c5d5dc7 100644 (file)
@@ -25,7 +25,7 @@
    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
    Switzerland, email:ftf@fsfeurope.org.
 */
-/*
+/**
  * Functions to handle Extended Attributes for bacula.
  *
  * Extended Attributes are so OS specific we only restore Extended Attributes if
  * Currently we support the following OSes:
  *   - AIX (Extended Attributes)
  *   - Darwin (Extended Attributes)
+ *   - FreeBSD (Extended Attributes)
  *   - IRIX (Extended Attributes)
  *   - Linux (Extended Attributes)
  *   - NetBSD (Extended Attributes)
- *   - FreeBSD (Extended Attributes)
  *   - OpenBSD (Extended Attributes)
  *     (As it seems either they never implemented xattr or they are removed
  *      the support as it stated it was in version 3.1 but the current syscall
  *      might eventually support xattr on OpenBSD when they implemented them using
  *      the same interface as FreeBSD and NetBSD.
  *   - Solaris (Extended Attributes and Extensible Attributes)
+ *   - Tru64 (Extended Attributes)
  *
  *   Written by Marco van Wieringen, November MMVIII
- *
  */
 
 #include "bacula.h"
 #include "filed.h"
 
 #if !defined(HAVE_XATTR)
-/*
+/**
  * Entry points when compiled without support for XATTRs or on an unsupported platform.
  */
 bxattr_exit_code build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
@@ -67,7 +67,7 @@ bxattr_exit_code parse_xattr_streams(JCR *jcr, int stream)
    return bxattr_exit_fatal;
 }
 #else
-/*
+/**
  * Send a XATTR stream to the SD.
  */
 static bxattr_exit_code send_xattr_stream(JCR *jcr, int stream)
@@ -120,7 +120,7 @@ static bxattr_exit_code send_xattr_stream(JCR *jcr, int stream)
    return bxattr_exit_ok;
 }
 
-/*
+/**
  * First some generic functions for OSes that use the same xattr encoding scheme.
  * Currently for all OSes except for Solaris.
  */
@@ -150,7 +150,7 @@ static void xattr_drop_internal_table(alist *xattr_value_list)
    delete xattr_value_list;
 }
 
-/*
+/**
  * The xattr stream for OSX, FreeBSD, Linux and NetBSD is a serialized stream of bytes
  * which encodes one or more xattr_t structures.
  *
@@ -213,7 +213,7 @@ static bxattr_exit_code unserialize_xattr_stream(JCR *jcr, alist *xattr_value_li
    xattr_t *current_xattr;
    bxattr_exit_code retval = bxattr_exit_ok;
 
-   /*
+   /**
     * Parse the stream and call restore_xattr_on_file for each extended attribute.
     *
     * Start unserializing the data. We keep on looping while we have not
@@ -225,7 +225,6 @@ static bxattr_exit_code unserialize_xattr_stream(JCR *jcr, alist *xattr_value_li
        * First make sure the magic is present. This way we can easily catch corruption.
        * Any missing MAGIC is fatal we do NOT try to continue.
        */
-
       current_xattr = (xattr_t *)malloc(sizeof(xattr_t));
       unser_uint32(current_xattr->magic);
       if (current_xattr->magic != XATTR_MAGIC) {
@@ -393,8 +392,6 @@ static bxattr_exit_code aix_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
    }
    xattr_list[xattr_list_len] = '\0';
 
-   xattr_value_list = New(alist(10, not_owned_by_alist));
-
    /*
     * Walk the list of extended attributes names and retrieve the data.
     * We already count the bytes needed for serializing the stream later on.
@@ -497,6 +494,10 @@ static bxattr_exit_code aix_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
          }
       }
 
+      if (xattr_value_list == NULL) {
+         xattr_value_list = New(alist(10, not_owned_by_alist));
+      }
+
       xattr_value_list->append(current_xattr);
       current_xattr = NULL;
       xattr_count++;
@@ -522,16 +523,12 @@ static bxattr_exit_code aix_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
          goto bail_out;
       }
 
-      xattr_drop_internal_table(xattr_value_list);
-
       /*
        * Send the datastream to the SD.
        */
-      return send_xattr_stream(jcr, os_default_xattr_streams[0]);
+      retval = send_xattr_stream(jcr, os_default_xattr_streams[0]);
    } else {
-      xattr_drop_internal_table(xattr_value_list);
-
-      return bxattr_exit_ok;
+      retval = bxattr_exit_ok;
    }
 
 bail_out:
@@ -630,8 +627,6 @@ static bxattr_exit_code irix_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
    POOLMEM *xattrbuf = get_memory(ATTR_MAX_VALUELEN);
    berrno be;
 
-   xattr_value_list = New(alist(10, not_owned_by_alist));
-
    for (cnt = 0; xattr_naming_spaces[cnt].name != NULL; cnt++) {
       memset(cursor, 0, sizeof(attrlist_cursor_t));
       while (1) {
@@ -652,20 +647,20 @@ static bxattr_exit_code irix_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
 
          attrlist = (attrlist_t *)xattrbuf;
 
-         /**
+         /*
           * Walk the available attributes.
           */
          for (cnt = 0; cnt < attrlist->al_count; cnt++) {
             attrlist_ent = ATTR_ENTRY(xattrbuf, cnt);
 
-            /**
+            /*
              * Each xattr valuepair starts with a magic so we can parse it easier.
              */
             current_xattr = (xattr_t *)malloc(sizeof(xattr_t));
             current_xattr->magic = XATTR_MAGIC;
             expected_serialize_len += sizeof(current_xattr->magic);
 
-            /**
+            /*
              * Allocate space for storing the name.
              * We store the name as <naming_space_name><xattr_name>
              */
@@ -679,7 +674,7 @@ static bxattr_exit_code irix_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
             current_xattr->value_length = attrlist_ent->a_valuelen;
             current_xattr->value = (char *)malloc(current_xattr->value_length);
 
-            /**
+            /*
              * Retrieve the actual value of the xattr.
              */
             if (attr_get(jcr->last_fname, attrlist_ent->a_name, current_xattr->value,
@@ -690,7 +685,7 @@ static bxattr_exit_code irix_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
                   retval = bxattr_exit_ok;
                   goto bail_out;
                case E2BIG:
-                  /**
+                  /*
                    * The buffer for the xattr isn't big enough. the value of
                    * current_xattr->value_length is updated with the actual size
                    * of the xattr. So we free the old buffer and create a new one
@@ -734,12 +729,16 @@ static bxattr_exit_code irix_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
                goto bail_out;
             }
 
+            if (xattr_value_list == NULL) {
+               xattr_value_list = New(alist(10, not_owned_by_alist));
+            }
+
             xattr_value_list->append(current_xattr);
             current_xattr = NULL;
             xattr_count++;
          }
 
-         /**
+         /*
           * See if there are more attributes available for a next run of attr_list.
           */
          if (attrlist->al_more == 0) {
@@ -763,16 +762,12 @@ static bxattr_exit_code irix_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
          goto bail_out;
       }
 
-      xattr_drop_internal_table(xattr_value_list);
-
       /*
        * Send the datastream to the SD.
        */
-      return send_xattr_stream(jcr, os_default_xattr_streams[0]);
+      retval = send_xattr_stream(jcr, os_default_xattr_streams[0]);
    } else {
-      xattr_drop_internal_table(xattr_value_list);
-
-      return bxattr_exit_ok;
+      retval = bxattr_exit_ok;
    }
 
 bail_out:
@@ -809,7 +804,7 @@ static bxattr_exit_code irix_xattr_parse_streams(JCR *jcr, int stream)
    }
 
    foreach_alist(current_xattr, xattr_value_list) {
-      /**
+      /*
        * See to what namingspace this xattr belongs to.
        */
       name_space_index = 0;
@@ -823,8 +818,8 @@ static bxattr_exit_code irix_xattr_parse_streams(JCR *jcr, int stream)
          }
       }
 
-      /**
-       * If we got a xattr that doesn't belong to ant valid namespace complain.
+      /*
+       * If we got a xattr that doesn't belong to an valid namespace complain.
        */
       if (name_space_index == 0) {
          Mmsg2(jcr->errmsg, _("Received illegal xattr named %s on file \"%s\"\n"),
@@ -834,7 +829,7 @@ static bxattr_exit_code irix_xattr_parse_streams(JCR *jcr, int stream)
          goto bail_out;
       }
 
-      /**
+      /*
        * Restore the xattr first try to create the attribute from scratch.
        */
       flags = xattr_naming_spaces[name_space_index].flags | ATTR_CREATE;
@@ -846,7 +841,7 @@ static bxattr_exit_code irix_xattr_parse_streams(JCR *jcr, int stream)
             retval = bxattr_exit_ok;
             goto bail_out;
          case EEXIST:
-            /**
+            /*
              * The xattr already exists we need to replace it.
              */
             flags = xattr_naming_spaces[name_space_index].flags | ATTR_REPLACE;
@@ -947,6 +942,7 @@ static bxattr_exit_code generic_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
    bool skip_xattr;
    char *xattr_list, *bp;
    int cnt, xattr_count = 0;
+   uint32_t name_length;
    int32_t xattr_list_len,
            xattr_value_len;
    uint32_t expected_serialize_len = 0;
@@ -1009,15 +1005,12 @@ static bxattr_exit_code generic_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
    }
    xattr_list[xattr_list_len] = '\0';
 
-   xattr_value_list = New(alist(10, not_owned_by_alist));
-
    /*
     * Walk the list of extended attributes names and retrieve the data.
     * We already count the bytes needed for serializing the stream later on.
     */
    bp = xattr_list;
    while ((bp - xattr_list) + 1 < xattr_list_len) {
-      int name_len;
       skip_xattr = false;
 
       /*
@@ -1046,8 +1039,8 @@ static bxattr_exit_code generic_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
          }
       }
 
-      name_len = strlen(bp);
-      if (skip_xattr || name_len == 0) {
+      name_length = strlen(bp);
+      if (skip_xattr || name_length == 0) {
          Dmsg1(100, "Skipping xattr named %s\n", bp);
          bp = strchr(bp, '\0') + 1;
          continue;
@@ -1063,7 +1056,7 @@ static bxattr_exit_code generic_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
       /*
        * Allocate space for storing the name.
        */
-      current_xattr->name_length = name_len;
+      current_xattr->name_length = name_length;
       current_xattr->name = (char *)malloc(current_xattr->name_length);
       memcpy((caddr_t)current_xattr->name, (caddr_t)bp, current_xattr->name_length);
 
@@ -1131,6 +1124,10 @@ static bxattr_exit_code generic_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
          }
       }
 
+      if (xattr_value_list == NULL) {
+         xattr_value_list = New(alist(10, not_owned_by_alist));
+      }
+
       xattr_value_list->append(current_xattr);
       current_xattr = NULL;
       xattr_count++;
@@ -1156,16 +1153,12 @@ static bxattr_exit_code generic_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
          goto bail_out;
       }
 
-      xattr_drop_internal_table(xattr_value_list);
-
       /*
        * Send the datastream to the SD.
        */
-      return send_xattr_stream(jcr, os_default_xattr_streams[0]);
+      retval = send_xattr_stream(jcr, os_default_xattr_streams[0]);
    } else {
-      xattr_drop_internal_table(xattr_value_list);
-
-      return bxattr_exit_ok;
+      retval = bxattr_exit_ok;
    }
 
 bail_out:
@@ -1296,8 +1289,6 @@ static bxattr_exit_code bsd_build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
    bxattr_exit_code retval = bxattr_exit_error;
    berrno be;
 
-   xattr_value_list = New(alist(10, not_owned_by_alist));
-
    /*
     * Loop over all available xattr namespaces.
     */
@@ -1518,6 +1509,10 @@ static bxattr_exit_code bsd_build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
             break;
          }
 
+         if (xattr_value_list == NULL) {
+            xattr_value_list = New(alist(10, not_owned_by_alist));
+         }
+
          xattr_value_list->append(current_xattr);
          current_xattr = NULL;
          xattr_count++;
@@ -1552,16 +1547,12 @@ static bxattr_exit_code bsd_build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
          goto bail_out;
       }
 
-      xattr_drop_internal_table(xattr_value_list);
-
       /*
        * Send the datastream to the SD.
        */
-      return send_xattr_stream(jcr, os_default_xattr_streams[0]);
+      retval = send_xattr_stream(jcr, os_default_xattr_streams[0]);
    } else {
-      xattr_drop_internal_table(xattr_value_list);
-
-      return bxattr_exit_ok;
+      retval = bxattr_exit_ok;
    }
 
 bail_out:
@@ -1710,7 +1701,7 @@ static bxattr_exit_code tru64_build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
    xattr_list_len = getproplist(jcr->last_fname, 1, &prop_args, xattrbuf_size,
                                 xattrbuf, &xattrbuf_min_size);
 
-   /**
+   /*
     * See what xattr are available.
     */
    switch (xattr_list_len) {
@@ -1729,7 +1720,7 @@ static bxattr_exit_code tru64_build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
       break;
    case 0:
       if (xattrbuf_min_size) {
-         /**
+         /*
           * The buffer isn't big enough to hold the xattr data, we now have
           * a minimum buffersize so we resize the buffer and try again.
           */
@@ -1752,7 +1743,7 @@ static bxattr_exit_code tru64_build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
             }
             break;
          case 0:
-            /**
+            /*
              * This should never happen as we sized the buffer according to the minimumsize
              * returned by a previous getproplist call. If it does happen things are fishy and
              * we are better of forgetting this xattr as it seems its list is changing at this
@@ -1775,9 +1766,7 @@ static bxattr_exit_code tru64_build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
       break;
    }
 
-   xattr_value_list = New(alist(10, not_owned_by_alist));
-
-   /**
+   /*
     * Walk the list of extended attributes names and retrieve the data.
     * We already count the bytes needed for serializing the stream later on.
     */
@@ -1847,6 +1836,10 @@ static bxattr_exit_code tru64_build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
          goto bail_out;
       }
 
+      if (xattr_value_list == NULL) {
+         xattr_value_list = New(alist(10, not_owned_by_alist));
+      }
+
       xattr_value_list->append(current_xattr);
       current_xattr = NULL;
       xattr_count++;
@@ -1906,7 +1899,7 @@ static bxattr_exit_code tru64_parse_xattr_streams(JCR *jcr, int stream)
       return bxattr_exit_error;
    }
 
-   /**
+   /*
     * See how big the propertylist must be.
     */
    xattrbuf_size = 0;
@@ -1916,7 +1909,7 @@ static bxattr_exit_code tru64_parse_xattr_streams(JCR *jcr, int stream)
 
    xattrbuf = (char *)malloc(xattrbuf_size);
 
-   /**
+   /*
     * Add all value pairs to the proplist.
     */
    cnt = 0;
@@ -1926,7 +1919,7 @@ static bxattr_exit_code tru64_parse_xattr_streams(JCR *jcr, int stream)
                                current_xattr->value, &bp);
    }
 
-   /**
+   /*
     * Sanity check.
     */
    if (cnt != xattrbuf_size) {
@@ -1937,7 +1930,7 @@ static bxattr_exit_code tru64_parse_xattr_streams(JCR *jcr, int stream)
       goto bail_out;
    }
 
-   /**
+   /*
     * Restore the list of extended attributes on the file.
     */
    cnt = setproplist(jcr->last_fname, 1, xattrbuf_size, xattrbuf);