d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2da6a6b31d
freebsd-dev/sbin/geom/core/geom.h

91 lines
3.4 KiB
C
Raw Normal View History

Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
/*-
various: general adoption of SPDX licensing ID tags. Mainly focus on files that use BSD 2-Clause license, however the tool I was using misidentified many licenses so this was mostly a manual - error prone - task. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts. No functional change intended.
2017-11-27 15:37:16 +00:00
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
* Copyright (c) 2004 Pawel Jakub Dawidek <pjd@FreeBSD.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
Remove trailing spaces.
2006-02-01 12:11:37 +00:00
*
Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef _GEOM_H_
#define _GEOM_H_
- Remove gc_argname field. It was introduced for gpart(8), but if I understand everything correctly, we don't really need it. - Provide default numeric value as strings. This allows to simplify a lot of code. - Bump version number.
2010-09-13 13:48:18 +00:00
#define G_LIB_VERSION 5
Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
Allow GEOM utilities to specify a -v option. Geom utilities (geli(8), glabel(8), gmirror(8), gpart(8), gmirror(8), gmountver(8), etc) all use the geom(8) utility as their back end to process their commands and pass them into the kernel. Creating a new utility requires no more than filling out a template describing the commands and arguments that the utility supports. Consider the specification for the very simple gmountver(8) utility: struct g_command class_commands[] = { { "create", G_FLAG_VERBOSE | G_FLAG_LOADKLD, NULL, { G_OPT_SENTINEL }, "[-v] prov ..." }, { "destroy", G_FLAG_VERBOSE, NULL, { { 'f', "force", NULL, G_TYPE_BOOL }, G_OPT_SENTINEL }, "[-fv] name" }, G_CMD_SENTINEL }; It has just two commands of its own: "create" and "destroy" along with the four standard commands "list", "status", "load", and "unload" provided by the base geom(8) utility. The base geom(8) utility allows each command to use the G_FLAG_VERBOSE flag to specify that a command should accept the -v flag and when the -v flag is given the utility prints "Done." if the command completes successfully. In the above example, both of the commands set the G_FLAG_VERBOSE, so have the -v option available. In addition the "destroy" command accepts the -f boolean flag to force the destruction. If the "destroy" command wanted to also print out verbose information, it would need to explicitly declare its intent by adding a line: { 'v', "verbose", NULL, G_TYPE_BOOL }, Before this change, the geom utility would silently ignore the above line in the configuration file, so it was impossible for the utility to know that the -v flag had been set on the command. With this change a geom command can explicitly specify a -v option with a line as given above and handle it as it would any other option. If both a -v option and G_FLAG_VERBOSE are specified for a command then both types of verbose information will be output when that command is run with -v. MFC after: 1 week Sponsored by: Netflix
2021-10-29 05:49:48 +00:00
/*
* The G_FLAG_VERBOSE flag on a command specification means that the
geom(4): Fix a typo in a source code comment - s/comand/command/ MFC after: 3 days
2022-03-27 16:31:00 +00:00
* command will accept a -v option and the GEOM framework will print
Allow GEOM utilities to specify a -v option. Geom utilities (geli(8), glabel(8), gmirror(8), gpart(8), gmirror(8), gmountver(8), etc) all use the geom(8) utility as their back end to process their commands and pass them into the kernel. Creating a new utility requires no more than filling out a template describing the commands and arguments that the utility supports. Consider the specification for the very simple gmountver(8) utility: struct g_command class_commands[] = { { "create", G_FLAG_VERBOSE | G_FLAG_LOADKLD, NULL, { G_OPT_SENTINEL }, "[-v] prov ..." }, { "destroy", G_FLAG_VERBOSE, NULL, { { 'f', "force", NULL, G_TYPE_BOOL }, G_OPT_SENTINEL }, "[-fv] name" }, G_CMD_SENTINEL }; It has just two commands of its own: "create" and "destroy" along with the four standard commands "list", "status", "load", and "unload" provided by the base geom(8) utility. The base geom(8) utility allows each command to use the G_FLAG_VERBOSE flag to specify that a command should accept the -v flag and when the -v flag is given the utility prints "Done." if the command completes successfully. In the above example, both of the commands set the G_FLAG_VERBOSE, so have the -v option available. In addition the "destroy" command accepts the -f boolean flag to force the destruction. If the "destroy" command wanted to also print out verbose information, it would need to explicitly declare its intent by adding a line: { 'v', "verbose", NULL, G_TYPE_BOOL }, Before this change, the geom utility would silently ignore the above line in the configuration file, so it was impossible for the utility to know that the -v flag had been set on the command. With this change a geom command can explicitly specify a -v option with a line as given above and handle it as it would any other option. If both a -v option and G_FLAG_VERBOSE are specified for a command then both types of verbose information will be output when that command is run with -v. MFC after: 1 week Sponsored by: Netflix
2021-10-29 05:49:48 +00:00
* out status information after the command when it is run with -v.
* Additionally a GEOM command can explicitly specify a -v option and
* handle it as it would any other option. If both a -v option and
* G_FLAG_VERBOSE are specified for a command then both types of verbose
* information will be output when that command is run with -v.
*
* When the G_FLAG_LOADKLD is specified for a command, the GEOM kernel
* module will be loaded when that command is run if it has not yet been
* loaded. This flag is typically specified for the `create' command.
*/
Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
#define G_FLAG_NONE 0x0000
#define G_FLAG_VERBOSE 0x0001
#define G_FLAG_LOADKLD 0x0002
MFp4: - Print proper error message when argument is specified twice. Before the change it was detected properly, because of how G_OPT_DONE() macro worked. - Use err(3) functions where appropriate. - Add some assertions. - Bump version number, because G_TYPE_BOOL addition breaks API and ABI. Changes: 98721,98722,98723,101360,106985
2006-09-30 14:39:18 +00:00
#define G_TYPE_NONE 0x00
#define G_TYPE_BOOL 0x01
#define G_TYPE_STRING 0x02
#define G_TYPE_NUMBER 0x03
Allow humanized numbers for LBAs, as well as partition indices for gpart(8). LBAs in particular are ugly. The ganularity is a sector, but users expect byte granularity when specifying the size or offset with a SI unit. Handle LBAs specially to deal with this.
2009-06-07 20:12:14 +00:00
#define G_TYPE_MASK 0x0f
MFp4: - Print proper error message when argument is specified twice. Before the change it was detected properly, because of how G_OPT_DONE() macro worked. - Use err(3) functions where appropriate. - Add some assertions. - Bump version number, because G_TYPE_BOOL addition breaks API and ABI. Changes: 98721,98722,98723,101360,106985
2006-09-30 14:39:18 +00:00
#define G_TYPE_DONE 0x10
Add G_TYPE_MULTI flag, which when set for the given option, will allow the option to be specified multiple times. This will help to implement things like passing multiple keyfiles to geli(8) instead of cat(1)ing them all into stdin and reading from there using one '-k -' option.
2010-09-13 13:59:28 +00:00
#define G_TYPE_MULTI 0x20
#define G_TYPE_NUMMASK 0xff00
#define G_TYPE_NUMSHIFT 8
Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
#define G_OPT_MAX 16
MFp4: - Print proper error message when argument is specified twice. Before the change it was detected properly, because of how G_OPT_DONE() macro worked. - Use err(3) functions where appropriate. - Add some assertions. - Bump version number, because G_TYPE_BOOL addition breaks API and ABI. Changes: 98721,98722,98723,101360,106985
2006-09-30 14:39:18 +00:00
#define G_OPT_DONE(opt) do { (opt)->go_type |= G_TYPE_DONE; } while (0)
#define G_OPT_ISDONE(opt) ((opt)->go_type & G_TYPE_DONE)
Add G_TYPE_MULTI flag, which when set for the given option, will allow the option to be specified multiple times. This will help to implement things like passing multiple keyfiles to geli(8) instead of cat(1)ing them all into stdin and reading from there using one '-k -' option.
2010-09-13 13:59:28 +00:00
#define G_OPT_ISMULTI(opt) ((opt)->go_type & G_TYPE_MULTI)
MFp4: - Print proper error message when argument is specified twice. Before the change it was detected properly, because of how G_OPT_DONE() macro worked. - Use err(3) functions where appropriate. - Add some assertions. - Bump version number, because G_TYPE_BOOL addition breaks API and ABI. Changes: 98721,98722,98723,101360,106985
2006-09-30 14:39:18 +00:00
#define G_OPT_TYPE(opt) ((opt)->go_type & G_TYPE_MASK)
Add G_TYPE_MULTI flag, which when set for the given option, will allow the option to be specified multiple times. This will help to implement things like passing multiple keyfiles to geli(8) instead of cat(1)ing them all into stdin and reading from there using one '-k -' option.
2010-09-13 13:59:28 +00:00
#define G_OPT_NUM(opt) (((opt)->go_type & G_TYPE_NUMMASK) >> G_TYPE_NUMSHIFT)
#define G_OPT_NUMINC(opt) ((opt)->go_type += (1 << G_TYPE_NUMSHIFT))
Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
Introduce special G_VAL_OPTIONAL define, which when given in value field tells geom(8) to ignore it when it is not given and don't try to obtain default value.
2010-09-14 11:13:46 +00:00
#define G_VAL_OPTIONAL ((void *)-1)
Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
#define G_OPT_SENTINEL { '\0', NULL, NULL, G_TYPE_NONE }
#define G_NULL_OPTS { G_OPT_SENTINEL }
- Remove gc_argname field. It was introduced for gpart(8), but if I understand everything correctly, we don't really need it. - Provide default numeric value as strings. This allows to simplify a lot of code. - Bump version number.
2010-09-13 13:48:18 +00:00
#define G_CMD_SENTINEL { NULL, 0, NULL, G_NULL_OPTS, NULL }
Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
struct g_option {
char go_char;
const char *go_name;
- Allow to specify value as const pointers. - Make optional string values always an empty string.
2010-09-13 08:56:07 +00:00
const void *go_val;
Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
unsigned go_type;
};
struct g_command {
const char *gc_name;
unsigned gc_flags;
void (*gc_func)(struct gctl_req *, unsigned);
struct g_option gc_options[G_OPT_MAX];
- Add gc_usage field to g_command structure. This will allow to define usage for a subcommand, so no 'usage' function has to be implemented in class library. - Bump version number as it breaks ABI, but don't provide backward compatibility, because there are probably no external consumers of this geom(8). This allows to print more precise usage for standard commands and simplify class libraries a bit. MFC after: 1 week
2005-03-14 14:24:46 +00:00
const char *gc_usage;
Bring in geom(8) utility. It is an universal utility for operating on GEOM classes. It works by loading a shared library via dlopen(3) mechanism with class-specific code, it is also responsible for communicating with GEOM via libgeom(3). Per-class shared libraries are going to be stored in /lib/geom/ directory. It provides also few standard commands like 'list', 'load' and 'unload' for existing classes which aren't aware of geom(8). More info will be send on freebsd-current@ mailing list. Supported by: Wheel - Open Technologies - http://www.wheel.pl
2004-05-20 10:09:56 +00:00
};
#endif /* !_GEOM_H_ */
Reference in New Issue Copy Permalink