Add support for zpool user properties

[allanjude]

zpool set org.freebsd:comment="this is my pool" poolname

Signed-off-by: Allan Jude allan@klarasystems.com

Motivation and Context

Allow users to create and set arbitrary pool properties, with the same syntax as dataset user properties (a user property is identified by the colon separator, and by convention is formatted org.name:propername)

Description

Allows to set and get user properties on the pool (district from dataset properties on the root dataset)

How Has This Been Tested?

Not very much

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Performance enhancement (non-breaking change which improves efficiency)
• Code cleanup (non-breaking change which makes code smaller or more readable)
• Breaking change (fix or feature that would cause existing functionality to change)
• Library ABI change (libzfs, libzfs_core, libnvpair, libuutil and libzfsbootenv)
• Documentation (a change to man pages or other documentation)

Checklist:

• My code follows the OpenZFS code style requirements.
• I have updated the documentation accordingly.
• I have read the contributing document.
• I have added tests to cover my changes.
• I have run the ZFS Test Suite with this change applied.
• All commit messages are properly formatted and contain Signed-off-by.

[AndyLavr]

Error:

free(): invalid pointer
Aborted

# zpool set org.linux:comment="test pool" test2

# zpool get all test2                          

--- skip

test2  compatibility                  off                            default
test2  org.linux:comment              test pool                      local
test2  feature@async_destroy          enabled                        local

--- skip

test2  feature@draid                  enabled                        local
test2  feature@compress_adaptive      enabled                        local
free(): invalid pointer
Aborted

[allanjude]

Error:

free(): invalid pointer
Aborted

in zpool_expand_proplist() I had:

entry->pl_user_prop = propname;

But later in zprop_free_list() it would free pl_user_prop, which was the middle of the nvlist allocation. Solved by using zfs_strdup() to keep a separate copy of the property name.

[allanjude]

Fixed style

[behlendorf]

The code looks good to me. But I think we should add a couple basic test cases to exercise this new functionality. It looks like in particular you could adapt cli_root/zfs_set/user_property_001_pos.ksh and cli_root/zfs_set/user_property_003_neg.ksh pretty easily and that would provide some coverage.

[allanjude]

Mateusz has written the first few tests for this, and cleaned things up.

[behlendorf]

You'll want to also update man/man7/zpoolprops.7 to reflect that user properties are supported for the pool. Modeling this after what was done in man/man7/zfsprops.7 seems like a reasonable way to go.

[allanjude]

The new tests are working correctly now

[0mp]

Hmm, I pushed the fixes to the https://github.com/allanjude/zfs/tree/zpool_user_props branch but GitHub does not seem to have propagated the changes to this PR... It should be pointing to allanjude@cf20058 now.

[behlendorf]

@0mp we're resolved the FreeBSD build failure. Can you rebase on the latest commits to master so we can verify this builds cleanly on FreeBSD.

[0mp]

@0mp we're resolved the FreeBSD build failure. Can you rebase on the latest commits to master so we can verify this builds cleanly on FreeBSD.

Rebased!

[behlendorf]

Sorry, it looks like this has some minor conflicts with the recently merged 3e4ed42. One last rebase is needed, then I'll get it merged.

[0mp]

Sorry, it looks like this has some minor conflicts with the recently merged 3e4ed42. One last rebase is needed, then I'll get it merged.

Hey Brian, I've resolved the conflict, rebased, and pushed the latest version. :)