[07/33] vfs: Add configuration parser helpers [ver #11]

Because the new API passes in key,value parameters, match_token() cannot be
used with it.  Instead, provide three new helpers to aid with parsing:

 (1) fs_parse().  This takes a parameter and a simple static description of
     all the parameters and maps the key name to an ID.  It returns 1 on a
     match, 0 on no match if unknowns should be ignored and some other
     negative error code on a parse error.

     The parameter description includes a list of key names to IDs, desired
     parameter types and a list of enumeration name -> ID mappings.

     [!] Note that for the moment I've required that the key->ID mapping
     array is expected to be sorted and unterminated.  The size of the
     array is noted in the fsconfig_parser struct.  This allows me to use
     bsearch(), but I'm not sure any performance gain is worth the hassle
     of requiring people to keep the array sorted.

     The parameter type array is sized according to the number of parameter
     IDs and is indexed directly.  The optional enum mapping array is an
     unterminated, unsorted list and the size goes into the fsconfig_parser
     struct.

     The function can do some additional things:

	(a) If it's not ambiguous and no value is given, the prefix "no" on
	    a key name is permitted to indicate that the parameter should
	    be considered negatory.

	(b) If the desired type is a single simple integer, it will perform
	    an appropriate conversion and store the result in a union in
	    the parse result.

	(c) If the desired type is an enumeration, {key ID, name} will be
	    looked up in the enumeration list and the matching value will
	    be stored in the parse result union.

	(d) Optionally generate an error if the key is unrecognised.

     This is called something like:

	enum rdt_param {
		Opt_cdp,
		Opt_cdpl2,
		Opt_mba_mpbs,
		nr__rdt_params
	};

	const struct fs_parameter_spec rdt_param_specs[nr__rdt_params] = {
		[Opt_cdp]	= { fs_param_is_bool },
		[Opt_cdpl2]	= { fs_param_is_bool },
		[Opt_mba_mpbs]	= { fs_param_is_bool },
	};

	const struct constant_table rdt_param_keys[] = {
		{ "cdp",	Opt_cdp },
		{ "cdpl2",	Opt_cdpl2 },
		{ "mba_mbps",	Opt_mba_mpbs },
	};

	const struct fs_parameter_description rdt_parser = {
		.name		= "rdt",
		.nr_params	= nr__rdt_params,
		.nr_keys	= ARRAY_SIZE(rdt_param_keys),
		.keys		= rdt_param_keys,
		.specs		= rdt_param_specs,
		.no_source	= true,
	};

	int rdt_parse_param(struct fs_context *fc,
			    struct fs_parameter *param)
	{
		struct fs_parse_result parse;
		struct rdt_fs_context *ctx = rdt_fc2context(fc);
		int ret;

		ret = fs_parse(fc, &rdt_parser, param, &parse);
		if (ret < 0)
			return ret;

		switch (parse.key) {
		case Opt_cdp:
			ctx->enable_cdpl3 = true;
			return 0;
		case Opt_cdpl2:
			ctx->enable_cdpl2 = true;
			return 0;
		case Opt_mba_mpbs:
			ctx->enable_mba_mbps = true;
			return 0;
		}

		return -EINVAL;
	}

 (2) fs_lookup_param().  This takes a { dirfd, path, LOOKUP_EMPTY? } or
     string value and performs an appropriate path lookup to convert it
     into a path object, which it will then return.

     If the desired type was a blockdev, the type of the looked up inode
     will be checked to make sure it is one.

     This can be used like:

	enum foo_param {
		Opt_source,
		nr__foo_params
	};

	const struct fs_parameter_spec foo_param_specs[nr__foo_params] = {
		[Opt_source]	= { fs_param_is_blockdev },
	};

	const struct constant_table foo_param_keys[] = {
		{ "source",	Opt_source },
	};

	const struct fs_parameter_description foo_parser = {
		.name		= "foo",
		.nr_params	= nr__foo_params,
		.nr_keys	= ARRAY_SIZE(foo_param_keys),
		.keys		= foo_param_keys,
		.specs		= foo_param_specs,
	};

	int foo_parse_param(struct fs_context *fc,
			    struct fs_parameter *param)
	{
		struct fs_parse_result parse;
		struct foo_fs_context *ctx = foo_fc2context(fc);
		int ret;

		ret = fs_parse(fc, &foo_parser, param, &parse);
		if (ret < 0)
			return ret;

		switch (parse.key) {
		case Opt_source:
			return fs_lookup_param(fc, &foo_parser, param,
					       &parse, &ctx->source);
		default:
			return -EINVAL;
		}
	}

 (3) lookup_constant().  This takes a table of named constants and looks up
     the given name within it.  The table is expected to be sorted such
     that bsearch() be used upon it.

     Possibly I should require the table be terminated and just use a
     for-loop to scan it instead of using bsearch() to reduce hassle.

     Tables look something like:

	static const struct constant_table bool_names[] = {
		{ "0",		false },
		{ "1",		true },
		{ "false",	false },
		{ "no",		false },
		{ "true",	true },
		{ "yes",	true },
	};

     and a lookup is done with something like:

	b = lookup_constant(bool_names, param->string, -1);

Additionally, optional validation routines for the parameter description
are provided that can be enabled at compile time.  A later patch will
invoke these when a filesystem is registered.

Signed-off-by: David Howells <dhowells@redhat.com>
---

 fs/Kconfig                |    7 +
 fs/Makefile               |    3 
 fs/fs_parser.c            |  476 +++++++++++++++++++++++++++++++++++++++++++++
 fs/internal.h             |    2 
 fs/namei.c                |    4 
 include/linux/fs_parser.h |  116 +++++++++++
 6 files changed, 605 insertions(+), 3 deletions(-)
 create mode 100644 fs/fs_parser.c
 create mode 100644 include/linux/fs_parser.h

Message ID	153313709137.13253.4069745270412536237.stgit@warthog.procyon.org.uk (mailing list archive)
State	New, archived
Headers	show Return-Path: <linux-fsdevel-owner@kernel.org> Organization: Red Hat UK Ltd. Registered Address: Red Hat UK Ltd, Amberley Place, 107-111 Peascod Street, Windsor, Berkshire, SI4 1TE, United Kingdom. Registered in England and Wales under Company Registration No. 3798903 Subject: [PATCH 07/33] vfs: Add configuration parser helpers [ver #11] From: David Howells <dhowells@redhat.com> To: viro@zeniv.linux.org.uk Cc: torvalds@linux-foundation.org, dhowells@redhat.com, linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org Date: Wed, 01 Aug 2018 16:24:51 +0100 Message-ID: <153313709137.13253.4069745270412536237.stgit@warthog.procyon.org.uk> In-Reply-To: <153313703562.13253.5766498657900728120.stgit@warthog.procyon.org.uk> References: <153313703562.13253.5766498657900728120.stgit@warthog.procyon.org.uk> User-Agent: StGit/unknown-version MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Sender: linux-fsdevel-owner@vger.kernel.org Precedence: bulk
Series	VFS: Introduce filesystem context [ver #11] \| expand [00/33] VFS: Introduce filesystem context [ver #11] [01/33] vfs: syscall: Add open_tree(2) to reference or clone a mount [ver #11] [02/33] vfs: syscall: Add move_mount(2) to move mounts around [ver #11] [03/33] teach move_mount(2) to work with OPEN_TREE_CLONE [ver #11] [04/33] vfs: Suppress MS_* flag defs within the kernel unless explicitly enabled [ver #11] [05/33] vfs: Introduce the basic header for the new mount API's filesystem context [ver #11] [06/33] vfs: Introduce logging functions [ver #11] [07/33] vfs: Add configuration parser helpers [ver #11] [08/33] vfs: Add LSM hooks for the new mount API [ver #11] [09/33] selinux: Implement the new mount API LSM hooks [ver #11] [10/33] smack: Implement filesystem context security hooks [ver #11] [11/33] apparmor: Implement security hooks for the new mount API [ver #11] [12/33] tomoyo: Implement security hooks for the new mount API [ver #11] [13/33] vfs: Separate changing mount flags full remount [ver #11] [14/33] vfs: Implement a filesystem superblock creation/configuration context [ver #11] [15/33] vfs: Remove unused code after filesystem context changes [ver #11] [16/33] procfs: Move proc_fill_super() to fs/proc/root.c [ver #11] [17/33] proc: Add fs_context support to procfs [ver #11] [18/33] ipc: Convert mqueue fs to fs_context [ver #11] [19/33] cpuset: Use fs_context [ver #11] [20/33] kernfs, sysfs, cgroup, intel_rdt: Support fs_context [ver #11] [21/33] hugetlbfs: Convert to fs_context [ver #11] [22/33] vfs: Remove kern_mount_data() [ver #11] [23/33] vfs: Provide documentation for new mount API [ver #11] [24/33] Make anon_inodes unconditional [ver #11] [25/33] vfs: syscall: Add fsopen() to prepare for superblock creation [ver #11] [26/33] vfs: Implement logging through fs_context [ver #11] [27/33] vfs: Add some logging to the core users of the fs_context log [ver #11] [28/33] vfs: syscall: Add fsconfig() for configuring and managing a context [ver #11] [29/33] vfs: syscall: Add fsmount() to create a mount for a superblock [ver #11] [30/33] vfs: syscall: Add fspick() to select a superblock for reconfiguration [ver #11] [31/33] afs: Add fs_context support [ver #11] [32/33] afs: Use fs_context to pass parameters over automount [ver #11] [33/33] vfs: Add a sample program for the new mount API [ver #11]

[07/33] vfs: Add configuration parser helpers [ver #11]

Commit Message

Patch