source: rtems/cpukit/libnetworking/sys/sysctl.h @ df49c60

4.104.114.84.95
Last change on this file since df49c60 was 39e6e65a, checked in by Joel Sherrill <joel.sherrill@…>, on 08/19/98 at 21:32:28

Base files

  • Property mode set to 100644
File size: 13.9 KB
Line 
1/*
2 * Copyright (c) 1989, 1993
3 *      The Regents of the University of California.  All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Mike Karels at Berkeley Software Design, Inc.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 *    must display the following acknowledgement:
18 *      This product includes software developed by the University of
19 *      California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 *    may be used to endorse or promote products derived from this software
22 *    without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 *      @(#)sysctl.h    8.1 (Berkeley) 6/2/93
37 * $Id$
38 */
39
40#ifndef _SYS_SYSCTL_H_
41#define _SYS_SYSCTL_H_
42
43/*
44 * Definitions for sysctl call.  The sysctl call uses a hierarchical name
45 * for objects that can be examined or modified.  The name is expressed as
46 * a sequence of integers.  Like a file path name, the meaning of each
47 * component depends on its place in the hierarchy.  The top-level and kern
48 * identifiers are defined here, and other identifiers are defined in the
49 * respective subsystem header files.
50 */
51
52#define CTL_MAXNAME     12      /* largest number of components supported */
53
54/*
55 * Each subsystem defined by sysctl defines a list of variables
56 * for that subsystem. Each name is either a node with further
57 * levels defined below it, or it is a leaf of some particular
58 * type given below. Each sysctl level defines a set of name/type
59 * pairs to be used by sysctl(1) in manipulating the subsystem.
60 */
61struct ctlname {
62        char    *ctl_name;      /* subsystem name */
63        int     ctl_type;       /* type of name */
64};
65
66#define CTLTYPE         0xf     /* Mask for the type */
67#define CTLTYPE_NODE    1       /* name is a node */
68#define CTLTYPE_INT     2       /* name describes an integer */
69#define CTLTYPE_STRING  3       /* name describes a string */
70#define CTLTYPE_QUAD    4       /* name describes a 64-bit number */
71#define CTLTYPE_OPAQUE  5       /* name describes a structure */
72#define CTLTYPE_STRUCT  CTLTYPE_OPAQUE  /* name describes a structure */
73
74#define CTLFLAG_RD      0x80000000      /* Allow reads of variable */
75#define CTLFLAG_WR      0x40000000      /* Allow writes to the variable */
76#define CTLFLAG_RW      (CTLFLAG_RD|CTLFLAG_WR)
77#define CTLFLAG_NOLOCK  0x20000000      /* XXX Don't Lock */
78#define CTLFLAG_ANYBODY 0x10000000      /* All users can set this var */
79
80/*
81 * USE THIS instead of a hardwired number from the categories below
82 * to get dynamically assigned sysctl entries using the linker-set
83 * technology. This is the way nearly all new sysctl variables should
84 * be implimented.
85 * e.g. SYSCTL_INT(_parent, OID_AUTO, name, CTLFLAG_RW, &variable, 0, "");
86 */
87#define OID_AUTO        (-1)
88
89#ifdef KERNEL
90#define SYSCTL_HANDLER_ARGS (struct sysctl_oid *oidp, void *arg1, int arg2, \
91        struct sysctl_req *req)
92
93/*
94 * This describes the access space for a sysctl request.  This is needed
95 * so that we can use the interface from the kernel or from user-space.
96 */
97struct sysctl_req {
98        struct proc     *p;
99        int             lock;
100        void            *oldptr;
101        int             oldlen;
102        int             oldidx;
103        int             (*oldfunc)(struct sysctl_req *, const void *, int);
104        void            *newptr;
105        int             newlen;
106        int             newidx;
107        int             (*newfunc)(struct sysctl_req *, void *, int);
108};
109
110/*
111 * This describes one "oid" in the MIB tree.  Potentially more nodes can
112 * be hidden behind it, expanded by the handler.
113 */
114struct sysctl_oid {
115        int             oid_number;
116        int             oid_kind;
117        void            *oid_arg1;
118        int             oid_arg2;
119        const char      *oid_name;
120        int             (*oid_handler) SYSCTL_HANDLER_ARGS;
121        const char      *oid_fmt;
122};
123
124#define SYSCTL_IN(r, p, l)
125#define SYSCTL_OUT(r, p, l)
126
127int sysctl_handle_int SYSCTL_HANDLER_ARGS;
128int sysctl_handle_string SYSCTL_HANDLER_ARGS;
129int sysctl_handle_opaque SYSCTL_HANDLER_ARGS;
130
131/* This is the "raw" function for a mib-oid */
132#define SYSCTL_OID(parent, nbr, name, kind, a1, a2, handler, fmt, descr)
133
134/* This makes a node from which other oids can hang */
135#define SYSCTL_NODE(parent, nbr, name, access, handler, descr)
136
137/* This is a string len can be 0 to indicate '\0' termination */
138#define SYSCTL_STRING(parent, nbr, name, access, arg, len, descr)
139
140/* This is a integer, if ptr is NULL, val is returned */
141#define SYSCTL_INT(parent, nbr, name, access, ptr, val, descr)
142
143/* This is anything, specified by a pointer and a lenth */
144#define SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr)
145
146/* This is a struct, specified by a pointer and type */
147#define SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr)
148
149/* Needs a proc.  Specify by pointer and arg */
150#define SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt, descr)
151#endif /* KERNEL */
152
153/*
154 * Top-level identifiers
155 */
156#define CTL_UNSPEC      0               /* unused */
157#define CTL_KERN        1               /* "high kernel": proc, limits */
158#define CTL_VM          2               /* virtual memory */
159#define CTL_VFS         3               /* file system, mount type is next */
160#define CTL_NET         4               /* network, see socket.h */
161#define CTL_DEBUG       5               /* debugging parameters */
162#define CTL_HW          6               /* generic cpu/io */
163#define CTL_MACHDEP     7               /* machine dependent */
164#define CTL_USER        8               /* user-level */
165#define CTL_MAXID       9               /* number of valid top-level ids */
166
167#define CTL_NAMES { \
168        { 0, 0 }, \
169        { "kern", CTLTYPE_NODE }, \
170        { "vm", CTLTYPE_NODE }, \
171        { "vfs", CTLTYPE_NODE }, \
172        { "net", CTLTYPE_NODE }, \
173        { "debug", CTLTYPE_NODE }, \
174        { "hw", CTLTYPE_NODE }, \
175        { "machdep", CTLTYPE_NODE }, \
176        { "user", CTLTYPE_NODE }, \
177}
178
179/*
180 * CTL_KERN identifiers
181 */
182#define KERN_OSTYPE              1      /* string: system version */
183#define KERN_OSRELEASE           2      /* string: system release */
184#define KERN_OSREV               3      /* int: system revision */
185#define KERN_VERSION             4      /* string: compile time info */
186#define KERN_MAXVNODES           5      /* int: max vnodes */
187#define KERN_MAXPROC             6      /* int: max processes */
188#define KERN_MAXFILES            7      /* int: max open files */
189#define KERN_ARGMAX              8      /* int: max arguments to exec */
190#define KERN_SECURELVL           9      /* int: system security level */
191#define KERN_HOSTNAME           10      /* string: hostname */
192#define KERN_HOSTID             11      /* int: host identifier */
193#define KERN_CLOCKRATE          12      /* struct: struct clockrate */
194#define KERN_VNODE              13      /* struct: vnode structures */
195#define KERN_PROC               14      /* struct: process entries */
196#define KERN_FILE               15      /* struct: file entries */
197#define KERN_PROF               16      /* node: kernel profiling info */
198#define KERN_POSIX1             17      /* int: POSIX.1 version */
199#define KERN_NGROUPS            18      /* int: # of supplemental group ids */
200#define KERN_JOB_CONTROL        19      /* int: is job control available */
201#define KERN_SAVED_IDS          20      /* int: saved set-user/group-ID */
202#define KERN_BOOTTIME           21      /* struct: time kernel was booted */
203#define KERN_NISDOMAINNAME      22      /* string: YP domain name */
204#define KERN_UPDATEINTERVAL     23      /* int: update process sleep time */
205#define KERN_OSRELDATE          24      /* int: OS release date */
206#define KERN_NTP_PLL            25      /* node: NTP PLL control */
207#define KERN_BOOTFILE           26      /* string: name of booted kernel */
208#define KERN_MAXFILESPERPROC    27      /* int: max open files per proc */
209#define KERN_MAXPROCPERUID      28      /* int: max processes per uid */
210#define KERN_DUMPDEV            29      /* dev_t: device to dump on */
211#define KERN_SOMAXCONN          30      /* int: max connections in listen q */
212#define KERN_MAXSOCKBUF         31      /* int: max size of a socket buffer */
213#define KERN_PS_STRINGS         32      /* int: address of PS_STRINGS */
214#define KERN_USRSTACK           33      /* int: address of USRSTACK */
215#define KERN_MAXID              34      /* number of valid kern ids */
216
217#define CTL_KERN_NAMES { \
218        { 0, 0 }, \
219        { "ostype", CTLTYPE_STRING }, \
220        { "osrelease", CTLTYPE_STRING }, \
221        { "osrevision", CTLTYPE_INT }, \
222        { "version", CTLTYPE_STRING }, \
223        { "maxvnodes", CTLTYPE_INT }, \
224        { "maxproc", CTLTYPE_INT }, \
225        { "maxfiles", CTLTYPE_INT }, \
226        { "argmax", CTLTYPE_INT }, \
227        { "securelevel", CTLTYPE_INT }, \
228        { "hostname", CTLTYPE_STRING }, \
229        { "hostid", CTLTYPE_INT }, \
230        { "clockrate", CTLTYPE_STRUCT }, \
231        { "vnode", CTLTYPE_STRUCT }, \
232        { "proc", CTLTYPE_STRUCT }, \
233        { "file", CTLTYPE_STRUCT }, \
234        { "profiling", CTLTYPE_NODE }, \
235        { "posix1version", CTLTYPE_INT }, \
236        { "ngroups", CTLTYPE_INT }, \
237        { "job_control", CTLTYPE_INT }, \
238        { "saved_ids", CTLTYPE_INT }, \
239        { "boottime", CTLTYPE_STRUCT }, \
240        { "nisdomainname", CTLTYPE_STRING }, \
241        { "update", CTLTYPE_INT }, \
242        { "osreldate", CTLTYPE_INT }, \
243        { "ntp_pll", CTLTYPE_NODE }, \
244        { "bootfile", CTLTYPE_STRING }, \
245        { "maxfilesperproc", CTLTYPE_INT }, \
246        { "maxprocperuid", CTLTYPE_INT }, \
247        { "dumpdev", CTLTYPE_STRUCT }, /* we lie; don't print as int */ \
248        { "somaxconn", CTLTYPE_INT }, \
249        { "maxsockbuf", CTLTYPE_INT }, \
250        { "ps_strings", CTLTYPE_INT }, \
251        { "usrstack", CTLTYPE_INT }, \
252}
253
254/*
255 * CTL_VFS identifiers
256 */
257#define VFS_VFSCONF             0       /* get configured filesystems */
258#define VFS_MAXID               1       /* number of items */
259
260#define CTL_VFS_NAMES { \
261        { "vfsconf", CTLTYPE_STRUCT }, \
262}
263
264/*
265 * KERN_PROC subtypes
266 */
267#define KERN_PROC_ALL           0       /* everything */
268#define KERN_PROC_PID           1       /* by process id */
269#define KERN_PROC_PGRP          2       /* by process group id */
270#define KERN_PROC_SESSION       3       /* by session of pid */
271#define KERN_PROC_TTY           4       /* by controlling tty */
272#define KERN_PROC_UID           5       /* by effective uid */
273#define KERN_PROC_RUID          6       /* by real uid */
274
275/*
276 * CTL_HW identifiers
277 */
278#define HW_MACHINE       1              /* string: machine class */
279#define HW_MODEL         2              /* string: specific machine model */
280#define HW_NCPU          3              /* int: number of cpus */
281#define HW_BYTEORDER     4              /* int: machine byte order */
282#define HW_PHYSMEM       5              /* int: total memory */
283#define HW_USERMEM       6              /* int: non-kernel memory */
284#define HW_PAGESIZE      7              /* int: software page size */
285#define HW_DISKNAMES     8              /* strings: disk drive names */
286#define HW_DISKSTATS     9              /* struct: diskstats[] */
287#define HW_FLOATINGPT   10              /* int: has HW floating point? */
288#define HW_MACHINE_ARCH 11              /* string: machine architecture */
289#define HW_MAXID        12              /* number of valid hw ids */
290
291#define CTL_HW_NAMES { \
292        { 0, 0 }, \
293        { "machine", CTLTYPE_STRING }, \
294        { "model", CTLTYPE_STRING }, \
295        { "ncpu", CTLTYPE_INT }, \
296        { "byteorder", CTLTYPE_INT }, \
297        { "physmem", CTLTYPE_INT }, \
298        { "usermem", CTLTYPE_INT }, \
299        { "pagesize", CTLTYPE_INT }, \
300        { "disknames", CTLTYPE_STRUCT }, \
301        { "diskstats", CTLTYPE_STRUCT }, \
302        { "floatingpoint", CTLTYPE_INT }, \
303}
304
305/*
306 * CTL_USER definitions
307 */
308#define USER_CS_PATH             1      /* string: _CS_PATH */
309#define USER_BC_BASE_MAX         2      /* int: BC_BASE_MAX */
310#define USER_BC_DIM_MAX          3      /* int: BC_DIM_MAX */
311#define USER_BC_SCALE_MAX        4      /* int: BC_SCALE_MAX */
312#define USER_BC_STRING_MAX       5      /* int: BC_STRING_MAX */
313#define USER_COLL_WEIGHTS_MAX    6      /* int: COLL_WEIGHTS_MAX */
314#define USER_EXPR_NEST_MAX       7      /* int: EXPR_NEST_MAX */
315#define USER_LINE_MAX            8      /* int: LINE_MAX */
316#define USER_RE_DUP_MAX          9      /* int: RE_DUP_MAX */
317#define USER_POSIX2_VERSION     10      /* int: POSIX2_VERSION */
318#define USER_POSIX2_C_BIND      11      /* int: POSIX2_C_BIND */
319#define USER_POSIX2_C_DEV       12      /* int: POSIX2_C_DEV */
320#define USER_POSIX2_CHAR_TERM   13      /* int: POSIX2_CHAR_TERM */
321#define USER_POSIX2_FORT_DEV    14      /* int: POSIX2_FORT_DEV */
322#define USER_POSIX2_FORT_RUN    15      /* int: POSIX2_FORT_RUN */
323#define USER_POSIX2_LOCALEDEF   16      /* int: POSIX2_LOCALEDEF */
324#define USER_POSIX2_SW_DEV      17      /* int: POSIX2_SW_DEV */
325#define USER_POSIX2_UPE         18      /* int: POSIX2_UPE */
326#define USER_STREAM_MAX         19      /* int: POSIX2_STREAM_MAX */
327#define USER_TZNAME_MAX         20      /* int: POSIX2_TZNAME_MAX */
328#define USER_MAXID              21      /* number of valid user ids */
329
330#define CTL_USER_NAMES { \
331        { 0, 0 }, \
332        { "cs_path", CTLTYPE_STRING }, \
333        { "bc_base_max", CTLTYPE_INT }, \
334        { "bc_dim_max", CTLTYPE_INT }, \
335        { "bc_scale_max", CTLTYPE_INT }, \
336        { "bc_string_max", CTLTYPE_INT }, \
337        { "coll_weights_max", CTLTYPE_INT }, \
338        { "expr_nest_max", CTLTYPE_INT }, \
339        { "line_max", CTLTYPE_INT }, \
340        { "re_dup_max", CTLTYPE_INT }, \
341        { "posix2_version", CTLTYPE_INT }, \
342        { "posix2_c_bind", CTLTYPE_INT }, \
343        { "posix2_c_dev", CTLTYPE_INT }, \
344        { "posix2_char_term", CTLTYPE_INT }, \
345        { "posix2_fort_dev", CTLTYPE_INT }, \
346        { "posix2_fort_run", CTLTYPE_INT }, \
347        { "posix2_localedef", CTLTYPE_INT }, \
348        { "posix2_sw_dev", CTLTYPE_INT }, \
349        { "posix2_upe", CTLTYPE_INT }, \
350        { "stream_max", CTLTYPE_INT }, \
351        { "tzname_max", CTLTYPE_INT }, \
352}
353
354#ifdef KERNEL
355
356extern char     cpu_model[];
357extern char     machine[];
358extern char     osrelease[];
359extern char     ostype[];
360
361int kernel_sysctl(struct proc *p, int *name, u_int namelen, void *old, size_t *oldlenp, void *new, size_t newlen, int *retval);
362int userland_sysctl(struct proc *p, int *name, u_int namelen, void *old, size_t *oldlenp, int inkernel, void *new, size_t newlen, int *retval);
363/*
364int     sysctl_clockrate __P((char *, size_t*));
365int     sysctl_file __P((char *, size_t*));
366int     sysctl_doproc __P((int *, u_int, char *, size_t*));
367int     sysctl_doprof __P((int *, u_int, void *, size_t *, void *, size_t));
368*/
369
370#else   /* !KERNEL */
371#include <sys/cdefs.h>
372
373__BEGIN_DECLS
374int     sysctl __P((int *, u_int, void *, size_t *, void *, size_t));
375int     sysctlbyname __P((const char *, void *, size_t *, void *, size_t));
376__END_DECLS
377#endif  /* KERNEL */
378
379#endif  /* !_SYS_SYSCTL_H_ */
Note: See TracBrowser for help on using the repository browser.