]> wimlib.net Git - wimlib/commitdiff
tagged_item updates
authorEric Biggers <ebiggers3@gmail.com>
Mon, 26 Dec 2016 21:14:41 +0000 (15:14 -0600)
committerEric Biggers <ebiggers3@gmail.com>
Tue, 27 Dec 2016 03:15:13 +0000 (21:15 -0600)
- expose tagged_item functions in new header tagged_items.h
- make object_id functions inline functions in object_id.h
- add a new function inode_set_tagged_data() which removes existing
  items, and use it for inode_set_object_id()

Makefile.am
include/wimlib/object_id.h
include/wimlib/tagged_items.h [new file with mode: 0644]
src/tagged_items.c

index e65172ebfa9ff387c74687ebaf64f29dbbff6d33..fbaecee818db3a3253fe37934c21fefb5fbccc8f 100644 (file)
@@ -143,6 +143,7 @@ libwim_la_SOURCES =         \
        include/wimlib/security_descriptor.h    \
        include/wimlib/sha1.h           \
        include/wimlib/solid.h          \
+       include/wimlib/tagged_items.h   \
        include/wimlib/textfile.h       \
        include/wimlib/timestamp.h      \
        include/wimlib/types.h          \
index 21c1b4a71a9865f39e2ce0a92c22ce9da443f094..b3fd8abc6e9764a2aba2b0fb5ce46ece1682cb24 100644 (file)
@@ -1,15 +1,29 @@
 #ifndef _WIMLIB_OBJECT_ID_H
 #define _WIMLIB_OBJECT_ID_H
 
-#include "wimlib/types.h"
+#include "wimlib/tagged_items.h"
 
-extern bool
-inode_has_object_id(const struct wim_inode *inode);
+/* Unconfirmed: are all 64 bytes of the object ID always present?  Since NTFS-3G
+ * permits shorter object IDs, we'll do the same for now.  */
+#define OBJECT_ID_MIN_LENGTH   16
 
-extern const void *
-inode_get_object_id(const struct wim_inode *inode, u32 *len_ret);
+static inline const void *
+inode_get_object_id(const struct wim_inode *inode, u32 *len_ret)
+{
+       return inode_get_tagged_item(inode, TAG_OBJECT_ID, OBJECT_ID_MIN_LENGTH,
+                                    len_ret);
+}
 
-extern bool
-inode_set_object_id(struct wim_inode *inode, const void *object_id, u32 len);
+static inline bool
+inode_has_object_id(const struct wim_inode *inode)
+{
+       return inode_get_object_id(inode, NULL) != NULL;
+}
+
+static inline bool
+inode_set_object_id(struct wim_inode *inode, const void *object_id, u32 len)
+{
+       return inode_set_tagged_data(inode, TAG_OBJECT_ID, object_id, len);
+}
 
 #endif /* _WIMLIB_OBJECT_ID_H  */
diff --git a/include/wimlib/tagged_items.h b/include/wimlib/tagged_items.h
new file mode 100644 (file)
index 0000000..64aae86
--- /dev/null
@@ -0,0 +1,22 @@
+#ifndef _WIMLIB_TAGGED_ITEMS_H
+#define _WIMLIB_TAGGED_ITEMS_H
+
+#include "wimlib/types.h"
+
+struct wim_inode;
+
+/* Windows-style object ID */
+#define TAG_OBJECT_ID                  0x00000001
+
+/* [wimlib extension] Standard UNIX metadata: uid, gid, mode, and rdev */
+#define TAG_WIMLIB_UNIX_DATA           0x337DD873
+
+extern bool
+inode_set_tagged_data(struct wim_inode *inode, u32 tag,
+                     const void *data, u32 len);
+
+extern void *
+inode_get_tagged_item(const struct wim_inode *inode, u32 desired_tag,
+                     u32 min_data_len, u32 *actual_len_ret);
+
+#endif /* _WIMLIB_TAGGED_ITEMS_H */
index a851cfd64058604cbb81e2c90ccc2851a042cbd6..ea0d1bf953ae6a6131505a4ad7c76260e8d2ca69 100644 (file)
 
 #include "wimlib/endianness.h"
 #include "wimlib/inode.h"
-#include "wimlib/object_id.h"
-#include "wimlib/types.h"
+#include "wimlib/tagged_items.h"
 #include "wimlib/unix_data.h"
 
-/* Object ID tag; this is also used by the Microsoft implementation.  */
-#define TAG_OBJECT_ID          0x00000001
-
-/* Random number that we'll use for tagging our UNIX data items.  */
-#define TAG_WIMLIB_UNIX_DATA   0x337DD873
-
 /* Header that begins each tagged metadata item in the metadata resource  */
 struct tagged_item_header {
 
@@ -52,31 +45,14 @@ struct tagged_item_header {
        u8 data[];
 };
 
-/* Unconfirmed: are all 64 bytes of the object ID always present?  Since NTFS-3G
- * permits shorter object IDs, we'll do the same for now.  */
-#define OBJECT_ID_MIN_LENGTH   16
-
-struct object_id_disk {
-       u8 object_id[16];
-       u8 birth_volume_id[16];
-       u8 birth_object_id[16];
-       u8 domain_id[16];
-};
-
-struct wimlib_unix_data_disk {
-       le32 uid;
-       le32 gid;
-       le32 mode;
-       le32 rdev;
-};
-
-/* Retrieves the first tagged item with the specified tag and minimum length
- * from the WIM inode.  Returns a pointer to the tagged data, which can be read
- * and/or modified in place.  Or, if no matching tagged item is found, returns
- * NULL.  */
-static void *
-inode_get_tagged_item(const struct wim_inode *inode,
-                     u32 desired_tag, u32 min_data_len, u32 *actual_len_ret)
+/*
+ * Retrieves the first tagged item with the specified tag and minimum length
+ * from the specified inode.  Returns a pointer to the tagged data, which can be
+ * read and/or modified in place, or NULL if not found.
+ */
+void *
+inode_get_tagged_item(const struct wim_inode *inode, u32 desired_tag,
+                     u32 min_data_len, u32 *actual_len_ret)
 {
        size_t minlen_with_hdr = sizeof(struct tagged_item_header) + min_data_len;
        size_t len_remaining;
@@ -115,8 +91,11 @@ inode_get_tagged_item(const struct wim_inode *inode,
        return NULL;
 }
 
-/* Adds a tagged item to a WIM inode and returns a pointer to its uninitialized
- * data, which must be initialized in-place by the caller.  */
+/*
+ * Add a tagged item to the specified inode and return a pointer to its zeroed
+ * data, which the caller may further initialize in-place.  No check is made for
+ * whether the inode already has item(s) with the specified tag.
+ */
 static void *
 inode_add_tagged_item(struct wim_inode *inode, u32 tag, u32 len)
 {
@@ -149,6 +128,42 @@ inode_add_tagged_item(struct wim_inode *inode, u32 tag, u32 len)
        return memset(hdr->data, 0, ALIGN(len, 8));
 }
 
+/*
+ * Assign a tagged item containing the specified data to the specified inode,
+ * removing any existing items with the same tag.  Returns %true if successful,
+ * %false if failed (out of memory).
+ */
+bool
+inode_set_tagged_data(struct wim_inode *inode, u32 tag,
+                     const void *data, u32 len)
+{
+       u8 *p;
+       u32 old_len;
+
+       /* Remove any existing items with this tag */
+       while ((p = inode_get_tagged_item(inode, tag, 0, &old_len)) != NULL) {
+               p -= sizeof(struct tagged_item_header);
+               old_len += sizeof(struct tagged_item_header);
+               memmove(p, p + old_len, (inode->i_extra->data +
+                                        inode->i_extra->size) - (p + old_len));
+               inode->i_extra->size -= old_len;
+       }
+
+       /* Add the new item */
+       p = inode_add_tagged_item(inode, tag, len);
+       if (!p)
+               return false;
+       memcpy(p, data, len);
+       return true;
+}
+
+struct wimlib_unix_data_disk {
+       le32 uid;
+       le32 gid;
+       le32 mode;
+       le32 rdev;
+};
+
 static inline struct wimlib_unix_data_disk *
 inode_get_unix_data_disk(const struct wim_inode *inode)
 {
@@ -157,26 +172,19 @@ inode_get_unix_data_disk(const struct wim_inode *inode)
                                     NULL);
 }
 
-static inline struct wimlib_unix_data_disk *
-inode_add_unix_data_disk(struct wim_inode *inode)
-{
-       return inode_add_tagged_item(inode, TAG_WIMLIB_UNIX_DATA,
-                                    sizeof(struct wimlib_unix_data_disk));
-}
-
-/* Returns %true if the specified WIM inode has UNIX data; otherwise %false.
- * This is a wimlib extension.  */
+/* Return %true iff the specified inode has standard UNIX metadata. */
 bool
 inode_has_unix_data(const struct wim_inode *inode)
 {
        return inode_get_unix_data_disk(inode) != NULL;
 }
 
-/* Retrieves UNIX data from the specified WIM inode.
- * This is a wimlib extension.
+/*
+ * Get an inode's standard UNIX metadata.
  *
- * Returns %true and fills @unix_data if the inode has UNIX data.
- * Otherwise returns %false.  */
+ * If the inode has standard UNIX metadata, returns %true and fills @unix_data.
+ * Otherwise returns %false.
+ */
 bool
 inode_get_unix_data(const struct wim_inode *inode,
                    struct wimlib_unix_data *unix_data)
@@ -194,14 +202,15 @@ inode_get_unix_data(const struct wim_inode *inode,
        return true;
 }
 
-/* Sets UNIX data on the specified WIM inode.
- * This is a wimlib extension.
+/*
+ * Set an inode's standard UNIX metadata.
  *
  * Callers must specify all members in @unix_data.  If the inode does not yet
- * have UNIX data, it is given these values.  Otherwise, only the values that
- * also have the corresponding flags in @which set are changed.
+ * have standard UNIX metadata, it is given these values.  Otherwise, only the
+ * values that also have the corresponding flags in @which set are changed.
  *
- * Returns %true if successful, %false if failed (out of memory).  */
+ * Returns %true if successful, %false if failed (out of memory).
+ */
 bool
 inode_set_unix_data(struct wim_inode *inode, struct wimlib_unix_data *unix_data,
                    int which)
@@ -210,7 +219,8 @@ inode_set_unix_data(struct wim_inode *inode, struct wimlib_unix_data *unix_data,
 
        p = inode_get_unix_data_disk(inode);
        if (!p) {
-               p = inode_add_unix_data_disk(inode);
+               p = inode_add_tagged_item(inode, TAG_WIMLIB_UNIX_DATA,
+                                         sizeof(struct wimlib_unix_data_disk));
                if (!p)
                        return false;
                which = UNIX_DATA_ALL;
@@ -225,35 +235,3 @@ inode_set_unix_data(struct wim_inode *inode, struct wimlib_unix_data *unix_data,
                p->rdev = cpu_to_le32(unix_data->rdev);
        return true;
 }
-
-/* Return %true iff the specified inode has an object ID.  */
-bool
-inode_has_object_id(const struct wim_inode *inode)
-{
-       return inode_get_object_id(inode, NULL) != NULL;
-}
-
-/* Retrieve a pointer to the object ID of the specified inode and write its
- * length to @len_ret.  Return NULL if the inode does not have an object ID.  */
-const void *
-inode_get_object_id(const struct wim_inode *inode, u32 *len_ret)
-{
-       return inode_get_tagged_item(inode, TAG_OBJECT_ID,
-                                    OBJECT_ID_MIN_LENGTH, len_ret);
-}
-
-/* Set the inode's object ID to the value specified by @object_id and @len.
- * Assumes the inode didn't already have an object ID set.  Returns %true if
- * successful, %false if failed (out of memory).  */
-bool
-inode_set_object_id(struct wim_inode *inode, const void *object_id, u32 len)
-{
-       void *p;
-
-       p = inode_add_tagged_item(inode, TAG_OBJECT_ID, len);
-       if (!p)
-               return false;
-
-       memcpy(p, object_id, len);
-       return true;
-}