xref: /dragonfly/sbin/ifconfig/ifconfig.h (revision 6e316fcd)
1 /*
2  * Copyright (c) 1997 Peter Wemm.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed for the FreeBSD Project
16  *	by Peter Wemm.
17  * 4. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * so there!
33  *
34  * $FreeBSD: src/sbin/ifconfig/ifconfig.h,v 1.16.2.1 2005/07/21 12:25:40 rwatson Exp $
35  */
36 
37 #ifndef IFCONFIG_IFCONFIG_H
38 #define IFCONFIG_IFCONFIG_H
39 
40 struct afswtch;
41 struct cmd;
42 
43 typedef	void c_func(const char *cmd, int arg, int s, const struct afswtch *afp);
44 typedef	void c_func2(const char *arg1, const char *arg2, int s, const struct afswtch *afp);
45 
46 struct cmd {
47 	const char *c_name;
48 	int	c_parameter;
49 #define	NEXTARG		0xffffff	/* has following arg */
50 #define	NEXTARG2	0xfffffe	/* has 2 following args */
51 #define	OPTARG		0xfffffd	/* has optional following arg */
52 	union {
53 		c_func	*c_func;
54 		c_func2	*c_func2;
55 	} c_u;
56 	int	c_iscloneop;
57 	struct cmd *c_next;
58 };
59 void	cmd_register(struct cmd *);
60 
61 typedef	void callback_func(int s, void *);
62 void	callback_register(callback_func *, void *);
63 
64 /*
65  * Macros for declaring command functions and initializing entries.
66  */
67 #define	DECL_CMD_FUNC(name, cmd, arg)		\
68 	void name(const char *cmd, int arg, int s, const struct afswtch *afp)
69 #define	DECL_CMD_FUNC2(name, arg1, arg2)	\
70 	void name(const char *arg1, const char *arg2, int s, const struct afswtch *afp)
71 
72 #define	DEF_CMD(name, param, func)	\
73 	{ name, param, { .c_func = func }, 0, NULL }
74 #define	DEF_CMD_ARG(name, func)		\
75 	{ .c_name = name, .c_parameter = NEXTARG, \
76 		.c_u = { .c_func = func }, 0, NULL }
77 #define	DEF_CMD_OPTARG(name, func)	\
78 	{ name, OPTARG, { .c_func = func }, 0, NULL }
79 #define	DEF_CMD_ARG2(name, func)	\
80 	{ name, NEXTARG2, { .c_func2 = func }, 0, NULL }
81 #define	DEF_CLONE_CMD(name, param, func) \
82 	{ name, param, { .c_func = func }, 1, NULL }
83 #define	DEF_CLONE_CMD_ARG(name, func)	\
84 	{ name, NEXTARG, { .c_func = func }, 1, NULL }
85 
86 
87 struct rt_addrinfo;
88 struct addrinfo;
89 
90 enum {
91 	RIDADDR,
92 	ADDR,
93 	MASK,
94 	DSTADDR,
95 };
96 
97 struct afswtch {
98 	const char	*af_name;	/* as given on cmd line, e.g. "inet" */
99 	short		af_af;		/* AF_* */
100 	/*
101 	 * Status is handled one of two ways; if there is an
102 	 * address associated with the interface then the
103 	 * associated address family af_status method is invoked
104 	 * with the appropriate addressin info.  Otherwise, if
105 	 * all possible info is to be displayed and af_other_status
106 	 * is defined then it is invoked after all address status
107 	 * is presented.
108 	 */
109 	void		(*af_status)(int, const struct rt_addrinfo *);
110 	void		(*af_other_status)(int);
111 					/* parse address method */
112 	void		(*af_getaddr)(const char *, int);
113 					/* parse prefix method (IPv6) */
114 	void		(*af_getprefix)(const char *, int);
115 	void		(*af_postproc)(int s, const struct afswtch *);
116 	u_long		af_difaddr;	/* set dst if address ioctl */
117 	u_long		af_aifaddr;	/* set if address ioctl */
118 	void		*af_ridreq;	/* */
119 	void		*af_addreq;	/* */
120 	struct afswtch	*af_next;
121 
122 	/* XXX doesn't fit model */
123 	void		(*af_status_tunnel)(int);
124 	void		(*af_settunnel)(int s, struct addrinfo *srcres,
125 				struct addrinfo *dstres);
126 };
127 void	af_register(struct afswtch *);
128 
129 struct option {
130 	const char *opt;
131 	const char *opt_usage;
132 	void	(*cb)(const char *arg);
133 	struct option *next;
134 };
135 void	opt_register(struct option *);
136 
137 extern	struct ifreq ifr;
138 extern	char name[IFNAMSIZ];	/* name of interface */
139 extern	int supmedia;
140 extern	int printkeys;
141 extern	int printifname;
142 extern	int flags;
143 extern	int newaddr;
144 extern	int verbose;
145 
146 void	setifcap(const char *, int value, int s, const struct afswtch *);
147 
148 void	Perror(const char *cmd) __dead2;
149 void	printb(const char *s, unsigned value, const char *bits);
150 
151 void	ifmaybeload(const char *);
152 
153 typedef void clone_callback_func(int, struct ifreq *);
154 void	clone_setdefcallback(const char *, clone_callback_func *);
155 
156 /*
157  * XXX expose this so modules that neeed to know of any pending
158  * operations on ifmedia can avoid cmd line ordering confusion.
159  */
160 struct ifmediareq *ifmedia_getstate(int s);
161 
162 #endif  /* !IFCONFIG_IFCONFIG_H */
163