ip: better --help
[oweals/busybox.git] / networking / ip.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
4  *
5  * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
6  *
7  * Changes:
8  * Rani Assaf <rani@magic.metawire.com> 980929: resolve addresses
9  * Bernhard Reutner-Fischer rewrote to use index_in_substr_array
10  */
11 //config:config IP
12 //config:       bool "ip"
13 //config:       default y
14 //config:       select PLATFORM_LINUX
15 //config:       help
16 //config:         The "ip" applet is a TCP/IP interface configuration and routing
17 //config:         utility. You generally don't need "ip" to use busybox with
18 //config:         TCP/IP.
19 //config:
20 //config:config IPADDR
21 //config:       bool "ipaddr"
22 //config:       default y
23 //config:       select FEATURE_IP_ADDRESS
24 //config:       select PLATFORM_LINUX
25 //config:       help
26 //config:         Support short form of ip addr: ipaddr
27 //config:
28 //config:config IPLINK
29 //config:       bool "iplink"
30 //config:       default y
31 //config:       select FEATURE_IP_LINK
32 //config:       select PLATFORM_LINUX
33 //config:       help
34 //config:         Support short form of ip link: iplink
35 //config:
36 //config:config IPROUTE
37 //config:       bool "iproute"
38 //config:       default y
39 //config:       select FEATURE_IP_ROUTE
40 //config:       select PLATFORM_LINUX
41 //config:       help
42 //config:         Support short form of ip route: iproute
43 //config:
44 //config:config IPTUNNEL
45 //config:       bool "iptunnel"
46 //config:       default y
47 //config:       select FEATURE_IP_TUNNEL
48 //config:       select PLATFORM_LINUX
49 //config:       help
50 //config:         Support short form of ip tunnel: iptunnel
51 //config:
52 //config:config IPRULE
53 //config:       bool "iprule"
54 //config:       default y
55 //config:       select FEATURE_IP_RULE
56 //config:       select PLATFORM_LINUX
57 //config:       help
58 //config:         Support short form of ip rule: iprule
59 //config:
60 //config:config IPNEIGH
61 //config:       bool "ipneigh"
62 //config:       default y
63 //config:       select FEATURE_IP_NEIGH
64 //config:       select PLATFORM_LINUX
65 //config:       help
66 //config:         Support short form of ip neigh: ipneigh
67 //config:
68 //config:config FEATURE_IP_ADDRESS
69 //config:       bool "ip address"
70 //config:       default y
71 //config:       depends on IP || IPADDR
72 //config:       help
73 //config:         Address manipulation support for the "ip" applet.
74 //config:
75 //config:config FEATURE_IP_LINK
76 //config:       bool "ip link"
77 //config:       default y
78 //config:       depends on IP || IPLINK
79 //config:       help
80 //config:         Configure network devices with "ip".
81 //config:
82 //config:config FEATURE_IP_ROUTE
83 //config:       bool "ip route"
84 //config:       default y
85 //config:       depends on IP || IPROUTE
86 //config:       help
87 //config:         Add support for routing table management to "ip".
88 //config:
89 //config:config FEATURE_IP_ROUTE_DIR
90 //config:       string "ip route configuration directory"
91 //config:       default "/etc/iproute2"
92 //config:       depends on FEATURE_IP_ROUTE
93 //config:       help
94 //config:         Location of the "ip" applet routing configuration.
95 //config:
96 //config:config FEATURE_IP_TUNNEL
97 //config:       bool "ip tunnel"
98 //config:       default y
99 //config:       depends on IP || IPTUNNEL
100 //config:       help
101 //config:         Add support for tunneling commands to "ip".
102 //config:
103 //config:config FEATURE_IP_RULE
104 //config:       bool "ip rule"
105 //config:       default y
106 //config:       depends on IP || IPRULE
107 //config:       help
108 //config:         Add support for rule commands to "ip".
109 //config:
110 //config:config FEATURE_IP_NEIGH
111 //config:       bool "ip neighbor"
112 //config:       default y
113 //config:       depends on IP || IPNEIGH
114 //config:       help
115 //config:         Add support for neighbor commands to "ip".
116 //config:
117 //config:config FEATURE_IP_RARE_PROTOCOLS
118 //config:       bool "Support displaying rarely used link types"
119 //config:       default n
120 //config:       depends on IP || IPADDR || IPLINK || IPROUTE || IPTUNNEL || IPRULE || IPNEIGH
121 //config:       help
122 //config:         If you are not going to use links of type "frad", "econet",
123 //config:         "bif" etc, you probably don't need to enable this.
124 //config:         Ethernet, wireless, infrared, ppp/slip, ip tunnelling
125 //config:         link types are supported without this option selected.
126
127 //applet:IF_IP(APPLET(ip, BB_DIR_SBIN, BB_SUID_DROP))
128 //applet:IF_IPADDR(APPLET(ipaddr, BB_DIR_SBIN, BB_SUID_DROP))
129 //applet:IF_IPLINK(APPLET(iplink, BB_DIR_SBIN, BB_SUID_DROP))
130 //applet:IF_IPROUTE(APPLET(iproute, BB_DIR_SBIN, BB_SUID_DROP))
131 //applet:IF_IPRULE(APPLET(iprule, BB_DIR_SBIN, BB_SUID_DROP))
132 //applet:IF_IPTUNNEL(APPLET(iptunnel, BB_DIR_SBIN, BB_SUID_DROP))
133 //applet:IF_IPNEIGH(APPLET(ipneigh, BB_DIR_SBIN, BB_SUID_DROP))
134
135 //kbuild:lib-$(CONFIG_IP) += ip.o
136 //kbuild:lib-$(CONFIG_IPADDR) += ip.o
137 //kbuild:lib-$(CONFIG_IPLINK) += ip.o
138 //kbuild:lib-$(CONFIG_IPROUTE) += ip.o
139 //kbuild:lib-$(CONFIG_IPRULE) += ip.o
140 //kbuild:lib-$(CONFIG_IPTUNNEL) += ip.o
141 //kbuild:lib-$(CONFIG_IPNEIGH) += ip.o
142
143 //usage:#define ipaddr_trivial_usage
144 //usage:       "add|del IFADDR dev IFACE | show|flush [dev IFACE] [to PREFIX]"
145 //usage:#define ipaddr_full_usage "\n\n"
146 //usage:       "ipaddr add|change|replace|delete IFADDR dev IFACE\n"
147 //usage:       "ipaddr show|flush [dev IFACE] [scope SCOPE-ID]\n"
148 //usage:       "                [to PREFIX] [label PATTERN]\n"
149 //usage:       "        IFADDR := PREFIX | ADDR peer PREFIX\n"
150 //usage:       "                [broadcast ADDR] [anycast ADDR]\n"
151 //usage:       "                [label STRING] [scope SCOPE-ID]\n"
152 //usage:       "        SCOPE-ID := [host|link|global|NUMBER]"
153 //usage:
154 //usage:#define iplink_trivial_usage
155 //usage:       "set IFACE [up|down] [arp on|off] | show [IFACE]"
156 //usage:#define iplink_full_usage "\n\n"
157 //usage:       "iplink set IFACE [up|down]\n"
158 //usage:       "        [arp on|off]\n"
159 //usage:       "        [dynamic on|off]\n"
160 //usage:       "        [multicast on|off]\n"
161 //usage:       "        [mtu MTU]\n"
162 //usage:       "iplink show [IFACE]"
163 //usage:
164 //usage:#define iproute_trivial_usage
165 //usage:       "list|flush|add|del|change|append|replace|test ROUTE"
166 //usage:#define iproute_full_usage "\n\n"
167 //usage:       "iproute list|flush SELECTOR\n"
168 //usage:       "iproute get ADDRESS [from ADDRESS iif STRING]\n"
169 //usage:       "        [oif STRING] [tos TOS]\n"
170 //usage:       "iproute add|del|change|append|replace|test ROUTE\n"
171 //usage:       "        SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n"
172 //usage:       "        ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO] [metric METRIC]"
173 //usage:
174 //usage:#define iprule_trivial_usage
175 //usage:       "[list] | add|del SELECTOR ACTION"
176 //usage:#define iprule_full_usage "\n\n"
177 //usage:       "        SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n"
178 //usage:       "                        [dev IFACE] [pref NUMBER]\n"
179 //usage:       "        ACTION := [table TABLE_ID] [nat ADDRESS]\n"
180 //usage:       "                        [prohibit|reject|unreachable]\n"
181 //usage:       "                        [realms [SRCREALM/]DSTREALM]\n"
182 //usage:       "        TABLE_ID := [local|main|default|NUMBER]"
183 //usage:
184 //usage:#define iptunnel_trivial_usage
185 //usage:       "add|change|del|show [NAME]\n"
186 //usage:       "        [mode ipip|gre|sit]\n"
187 //usage:       "        [remote ADDR] [local ADDR] [ttl TTL]"
188 //usage:#define iptunnel_full_usage "\n\n"
189 //usage:       "iptunnel add|change|del|show [NAME]\n"
190 //usage:       "        [mode ipip|gre|sit] [remote ADDR] [local ADDR]\n"
191 //usage:       "        [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n"
192 //usage:       "        [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]"
193 //usage:
194 //usage:#define ipneigh_trivial_usage
195 //usage:       "show|flush [to PREFIX] [dev DEV] [nud STATE]"
196 //usage:#define ipneigh_full_usage ""
197 //usage:
198 //usage:#if ENABLE_FEATURE_IP_ADDRESS || ENABLE_FEATURE_IP_ROUTE
199 //usage:# define IP_BAR_LINK   "|"
200 //usage:#else
201 //usage:# define IP_BAR_LINK   ""
202 //usage:#endif
203 //usage:#if ENABLE_FEATURE_IP_ADDRESS || ENABLE_FEATURE_IP_ROUTE || ENABLE_FEATURE_IP_LINK
204 //usage:# define IP_BAR_TUNNEL "|"
205 //usage:#else
206 //usage:# define IP_BAR_TUNNEL ""
207 //usage:#endif
208 //usage:#if ENABLE_FEATURE_IP_ADDRESS || ENABLE_FEATURE_IP_ROUTE || ENABLE_FEATURE_IP_LINK || ENABLE_FEATURE_IP_TUNNEL
209 //usage:# define IP_BAR_NEIGH  "|"
210 //usage:#else
211 //usage:# define IP_BAR_NEIGH  ""
212 //usage:#endif
213 //usage:#if ENABLE_FEATURE_IP_ADDRESS || ENABLE_FEATURE_IP_ROUTE || ENABLE_FEATURE_IP_LINK || ENABLE_FEATURE_IP_TUNNEL || ENABLE_FEATURE_IP_NEIGH
214 //usage:# define IP_BAR_RULE   "|"
215 //usage:#else
216 //usage:# define IP_BAR_RULE   ""
217 //usage:#endif
218 //usage:
219 //usage:#define ip_trivial_usage
220 //usage:       "[OPTIONS] "
221 //usage:        IF_FEATURE_IP_ADDRESS("address")
222 //usage:        IF_FEATURE_IP_ROUTE(  IF_FEATURE_IP_ADDRESS("|")"route")
223 //usage:        IF_FEATURE_IP_LINK(   IP_BAR_LINK  "link")
224 //usage:        IF_FEATURE_IP_TUNNEL( IP_BAR_TUNNEL"tunnel")
225 //usage:        IF_FEATURE_IP_NEIGH(  IP_BAR_NEIGH "neigh")
226 //usage:        IF_FEATURE_IP_RULE(   IP_BAR_RULE  "rule")
227 //usage:       " [COMMAND]"
228 //usage:#define ip_full_usage "\n\n"
229 //usage:       "OPTIONS := -f[amily] inet|inet6|link | -o[neline]\n"
230 //usage:       "COMMAND :="
231 //usage:        IF_FEATURE_IP_ADDRESS("\n"
232 //usage:        "ip addr "ipaddr_trivial_usage)
233 //usage:        IF_FEATURE_IP_ROUTE("\n"
234 //usage:        "ip route "iproute_trivial_usage)
235 //usage:        IF_FEATURE_IP_LINK("\n"
236 //usage:        "ip link "iplink_trivial_usage)
237 //usage:        IF_FEATURE_IP_TUNNEL("\n"
238 //usage:        "ip tunnel "iptunnel_trivial_usage)
239 //usage:        IF_FEATURE_IP_NEIGH("\n"
240 //usage:        "ip neigh "ipneigh_trivial_usage)
241 //usage:        IF_FEATURE_IP_RULE("\n"
242 //usage:        "ip rule "iprule_trivial_usage)
243
244 #include "libbb.h"
245
246 #include "libiproute/utils.h"
247 #include "libiproute/ip_common.h"
248
249 typedef int FAST_FUNC (*ip_func_ptr_t)(char**);
250
251 #if ENABLE_IPADDR \
252  || ENABLE_IPLINK \
253  || ENABLE_IPROUTE \
254  || ENABLE_IPRULE \
255  || ENABLE_IPTUNNEL \
256  || ENABLE_IPNEIGH
257 static int ip_do(ip_func_ptr_t ip_func, char **argv)
258 {
259         argv = ip_parse_common_args(argv + 1);
260         return ip_func(argv);
261 }
262 #endif
263
264 #if ENABLE_IPADDR
265 int ipaddr_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
266 int ipaddr_main(int argc UNUSED_PARAM, char **argv)
267 {
268         return ip_do(do_ipaddr, argv);
269 }
270 #endif
271 #if ENABLE_IPLINK
272 int iplink_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
273 int iplink_main(int argc UNUSED_PARAM, char **argv)
274 {
275         return ip_do(do_iplink, argv);
276 }
277 #endif
278 #if ENABLE_IPROUTE
279 int iproute_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
280 int iproute_main(int argc UNUSED_PARAM, char **argv)
281 {
282         return ip_do(do_iproute, argv);
283 }
284 #endif
285 #if ENABLE_IPRULE
286 int iprule_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
287 int iprule_main(int argc UNUSED_PARAM, char **argv)
288 {
289         return ip_do(do_iprule, argv);
290 }
291 #endif
292 #if ENABLE_IPTUNNEL
293 int iptunnel_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
294 int iptunnel_main(int argc UNUSED_PARAM, char **argv)
295 {
296         return ip_do(do_iptunnel, argv);
297 }
298 #endif
299 #if ENABLE_IPNEIGH
300 int ipneigh_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
301 int ipneigh_main(int argc UNUSED_PARAM, char **argv)
302 {
303         return ip_do(do_ipneigh, argv);
304 }
305 #endif
306
307 #if ENABLE_IP
308 static int FAST_FUNC ip_print_help(char **argv UNUSED_PARAM)
309 {
310         bb_show_usage();
311 }
312
313 int ip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
314 int ip_main(int argc UNUSED_PARAM, char **argv)
315 {
316         static const char keywords[] ALIGN1 = ""
317                 IF_FEATURE_IP_ADDRESS("address\0")
318                 IF_FEATURE_IP_ROUTE("route\0")
319                 IF_FEATURE_IP_ROUTE("r\0")
320                 IF_FEATURE_IP_LINK("link\0")
321                 IF_FEATURE_IP_TUNNEL("tunnel\0")
322                 IF_FEATURE_IP_TUNNEL("tunl\0")
323                 IF_FEATURE_IP_RULE("rule\0")
324                 IF_FEATURE_IP_NEIGH("neigh\0")
325                 ;
326         static const ip_func_ptr_t ip_func_ptrs[] = {
327                 ip_print_help,
328                 IF_FEATURE_IP_ADDRESS(do_ipaddr,)
329                 IF_FEATURE_IP_ROUTE(do_iproute,)
330                 IF_FEATURE_IP_ROUTE(do_iproute,)
331                 IF_FEATURE_IP_LINK(do_iplink,)
332                 IF_FEATURE_IP_TUNNEL(do_iptunnel,)
333                 IF_FEATURE_IP_TUNNEL(do_iptunnel,)
334                 IF_FEATURE_IP_RULE(do_iprule,)
335                 IF_FEATURE_IP_NEIGH(do_ipneigh,)
336         };
337         ip_func_ptr_t ip_func;
338         int key;
339
340         argv = ip_parse_common_args(argv + 1);
341         if (ARRAY_SIZE(ip_func_ptrs) > 1 && *argv)
342                 key = index_in_substrings(keywords, *argv++);
343         else
344                 key = -1;
345         ip_func = ip_func_ptrs[key + 1];
346
347         return ip_func(argv);
348 }
349 #endif