xref: /freebsd/sys/geom/geom_ctl.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2003 Poul-Henning Kamp
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The names of the authors may not be used to endorse or promote
16  *    products derived from this software without specific prior written
17  *    permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef _GEOM_GEOM_CTL_H_
33 #define _GEOM_GEOM_CTL_H_
34 
35 #include <sys/ioccom.h>
36 
37 /*
38  * Version number.  Used to check consistency between kernel and libgeom.
39  */
40 #define GCTL_VERSION	2
41 
42 struct gctl_req_arg {
43 	u_int				nlen;
44 	char				*name;
45 	off_t				offset;
46 	int				flag;
47 	int				len;
48 	void				*value;
49 	/* kernel only fields */
50 	void				*kvalue;
51 };
52 
53 #define GCTL_PARAM_RD		1	/* Must match VM_PROT_READ */
54 #define GCTL_PARAM_WR		2	/* Must match VM_PROT_WRITE */
55 #define GCTL_PARAM_RW		(GCTL_PARAM_RD | GCTL_PARAM_WR)
56 #define GCTL_PARAM_ASCII	4
57 
58 /* These are used in the kernel only */
59 #define GCTL_PARAM_NAMEKERNEL	8
60 #define GCTL_PARAM_VALUEKERNEL	16
61 #define GCTL_PARAM_CHANGED	32
62 
63 struct gctl_req {
64 	u_int				version;
65 	u_int				serial;
66 	u_int				narg;
67 	struct gctl_req_arg		*arg;
68 	u_int				lerror;
69 	char				*error;
70 	struct gctl_req_table		*reqt;
71 
72 	/* kernel only fields */
73 	int				nerror;
74 	struct sbuf			*serror;
75 };
76 
77 #define GEOM_CTL	_IOW('G', GCTL_VERSION, struct gctl_req)
78 
79 #define GEOM_CTL_ARG_MAX 2048	/* maximum number of parameters */
80 
81 #define PATH_GEOM_CTL	"geom.ctl"
82 
83 #endif /* _GEOM_GEOM_CTL_H_ */
84