Add comments for portable dnode / objset flags

This patch adds some comments describing the purpose of "portable"
dnode and objset flags so that it is clear when new flags should
be added to the repective flag masks. This patch includes no
functional changes.

Reviewed-by: George Melikov <mail@gmelikov.ru>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Tom Caputi <tcaputi@datto.com>
Closes #7313

diff --git a/include/sys/dmu_objset.h b/include/sys/dmu_objset.h
index df9b1a73ac2fefded5afb248382486e4574dca5f..0060efd51d8ba2bd97442d8e2b81fb476523c5f2 100644 (file)
--- a/include/sys/dmu_objset.h
+++ b/include/sys/dmu_objset.h
@@ -62,7 +62,13 @@ struct dmu_tx;
 #define        OBJSET_FLAG_USEROBJACCOUNTING_COMPLETE  (1ULL << 1)
 #define        OBJSET_FLAG_PROJECTQUOTA_COMPLETE       (1ULL << 2)
 
-/* all flags are currently non-portable */
+/*
+ * This mask defines the set of flags which are "portable", meaning
+ * that they can be preserved when doing a raw encrypted zfs send.
+ * Flags included in this mask will be protected by os_portable_mac
+ * when the block of dnodes is encrypted. No portable flags currently
+ * exist.
+ */
 #define        OBJSET_CRYPT_PORTABLE_FLAGS_MASK        (0)
 
 typedef struct objset_phys {

diff --git a/include/sys/dnode.h b/include/sys/dnode.h
index 9c44a22324039b48b7582d88ad18a5cc303b3342..1cb7cae0935ae5a79a1c785c8c0b4669bb6ec035 100644 (file)
--- a/include/sys/dnode.h
+++ b/include/sys/dnode.h
@@ -150,6 +150,12 @@ enum dnode_dirtycontext {
 /* User/Group/Project dnode accounting */
 #define        DNODE_FLAG_USEROBJUSED_ACCOUNTED        (1 << 3)
 
+/*
+ * This mask defines the set of flags which are "portable", meaning
+ * that they can be preserved when doing a raw encrypted zfs send.
+ * Flags included in this mask will be protected by AAD when the block
+ * of dnodes is encrypted.
+ */
 #define        DNODE_CRYPT_PORTABLE_FLAGS_MASK         (DNODE_FLAG_SPILL_BLKPTR)
 
 /*