1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2019 Netflix, Inc
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28#ifndef	COMND_H
29#define	COMND_H
30
31#include <sys/queue.h>
32#include <sys/linker_set.h>
33
34/*
35 * Regularized parsing of simple arguments built on top of getopt_long.
36 */
37
38typedef enum arg_type {
39	arg_none = 0,
40	arg_uint8,
41	arg_uint16,
42	arg_uint32,
43	arg_uint64,
44	arg_size,
45	arg_string,
46	arg_path,
47} arg_type;
48
49// XXX need to change to offsetof for opts and args.
50// we then need to allocate ctx and pass that into the cmd
51// stuff. this will be a little tricky and we may need to expand
52// arg_type stuff.
53
54struct opts {
55	const char	*long_arg;
56	int		short_arg;
57	arg_type	at;
58	void 		*ptr;			//  XXXX change to offset of
59	const char	*descr;
60};
61
62// XXX TDB: subcommand vs actual argument. maybe with subcmd?
63// XXX TBD: do we need parsing callback functions?
64struct args {
65	arg_type	at;
66	void 		*ptr;			//  XXXX change to offset of
67	const char	*descr;
68};
69
70typedef void (cmd_load_cb_t)(void *, void *);
71struct cmd;
72typedef void (cmd_fn_t)(const struct cmd *nf, int argc, char *argv[]);
73
74struct cmd  {
75	SLIST_ENTRY(cmd)	link;
76	const char		*name;
77	cmd_fn_t		*fn;
78	size_t			ctx_size;
79	const struct opts	*opts;
80	const struct args	*args;
81	const char		*descr;
82	SLIST_HEAD(,cmd)	subcmd;
83	struct cmd		*parent;
84};
85
86void cmd_register(struct cmd *, struct cmd *);
87#define CMD_COMMAND(c)							\
88    static void cmd_register_##c(void) __attribute__((constructor));	\
89    static void cmd_register_##c(void) { cmd_register(NULL, &c); }
90#define CMD_SUBCOMMAND(c,sc)						\
91    static void cmd_register_##c_##sc(void) __attribute__((constructor)); \
92    static void cmd_register_##c_##sc(void) { cmd_register(&c, &sc); }
93
94int arg_parse(int argc, char * const *argv, const struct cmd *f);
95void arg_help(int argc, char * const *argv, const struct cmd *f);
96void cmd_init(void);
97void cmd_load_dir(const char *dir, cmd_load_cb_t *cb, void *argp);
98int cmd_dispatch(int argc, char *argv[], const struct cmd *);
99
100#endif /* COMND_H */
101