xref: /titanic_41/usr/src/cmd/cmd-inet/usr.sbin/snoop/snoop.h (revision 03831d35f7499c87d51205817c93e9a8d42c4bae)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_SNOOP_H
28 #define	_SNOOP_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"	/* SunOS	*/
31 
32 #include <rpc/types.h>
33 #include <sys/pfmod.h>
34 #include <sys/time.h>
35 #include <sys/types.h>
36 #include <sys/socket.h>
37 #include <sys/bufmod.h>
38 #include <net/if.h>
39 #include <netinet/in.h>
40 #include <netinet/if_ether.h>
41 #include <netinet/in_systm.h>
42 #include <netinet/ip.h>
43 #include <netinet/ip6.h>
44 #include <netinet/ip_icmp.h>
45 #include <netinet/icmp6.h>
46 #include <net/pppoe.h>
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 /*
53  * Flags to control packet info display
54  */
55 #define	F_NOW		0x00000001	/* display in realtime */
56 #define	F_SUM		0x00000002	/* display summary line */
57 #define	F_ALLSUM	0x00000004	/* display all summary lines */
58 #define	F_DTAIL		0x00000008	/* display detail lines */
59 #define	F_TIME		0x00000010	/* display time */
60 #define	F_ATIME		0x00000020	/* display absolute time */
61 #define	F_RTIME		0x00000040	/* display relative time */
62 #define	F_DROPS		0x00000080	/* display drops */
63 #define	F_LEN		0x00000100	/* display pkt length */
64 #define	F_NUM		0x00000200	/* display pkt number */
65 #define	F_WHO		0x00000400	/* display src/dst */
66 
67 #define	MAXLINE		(1088)		/* max len of detail line */
68 
69 #define	MAX_HDRTRAILER	(64)		/* max hdr/trailer packet slack */
70 
71 /*
72  * The RPC XID cache structure.
73  * When analyzing RPC protocols we
74  * have to cache the xid of the RPC
75  * request together with the program
76  * number, proc, version etc since this
77  * information is missing in the reply
78  * packet.  Using the xid in the reply
79  * we can lookup this previously stashed
80  * information in the cache.
81  *
82  * For RPCSEC_GSS flavor, some special processing is
83  * needed for the argument interpretation based on its
84  * control procedure and service type.  This information
85  * is stored in the cache table during interpretation of
86  * the rpc header and will be referenced later when the rpc
87  * argument is interpreted.
88  */
89 #define	XID_CACHE_SIZE 256
90 struct cache_struct {
91 	int xid_num;	/* RPC transaction id */
92 	int xid_frame;	/* Packet number */
93 	int xid_prog;	/* RPC program number */
94 	int xid_vers;	/* RPC version number */
95 	int xid_proc;	/* RPC procedure number */
96 	unsigned int xid_gss_proc; /* control procedure */
97 	int xid_gss_service; /* none, integ, priv */
98 } xid_cache[XID_CACHE_SIZE];
99 
100 
101 /*
102  * The following macros advance the pointer passed to them.  They
103  * assume they are given a char *.
104  */
105 #define	GETINT8(v, ptr) { \
106 	(v) = (*(ptr)++); \
107 }
108 
109 #define	GETINT16(v, ptr) { \
110 	(v) = *(ptr)++ << 8; \
111 	(v) |= *(ptr)++; \
112 }
113 
114 #define	GETINT32(v, ptr) { \
115 	(v) = *(ptr)++ << 8; \
116 	(v) |= *(ptr)++; (v) <<= 8; \
117 	(v) |= *(ptr)++; (v) <<= 8; \
118 	(v) |= *(ptr)++; \
119 }
120 
121 /*
122  * Used to print nested protocol layers.  For example, an ip datagram included
123  * in an icmp error, or a PPP packet included in an LCP protocol reject..
124  */
125 extern char *prot_nest_prefix;
126 
127 extern char *get_sum_line(void);
128 extern char *get_detail_line(int, int);
129 extern struct timeval prev_time;
130 extern void process_pkt(struct sb_hdr *, char *, int, int);
131 extern char *getflag(int, int, char *, char *);
132 extern void show_header(char *, char *, int);
133 extern void xdr_init(char *, int);
134 extern char *get_line(int, int);
135 extern int get_line_remain(void);
136 extern char getxdr_char(void);
137 extern char showxdr_char(char *);
138 extern uchar_t getxdr_u_char(void);
139 extern uchar_t showxdr_u_char(char *);
140 extern short getxdr_short(void);
141 extern short showxdr_short(char *);
142 extern ushort_t getxdr_u_short(void);
143 extern ushort_t showxdr_u_short(char *);
144 extern long getxdr_long(void);
145 extern long showxdr_long(char *);
146 extern ulong_t getxdr_u_long(void);
147 extern ulong_t showxdr_u_long(char *);
148 extern longlong_t getxdr_longlong(void);
149 extern longlong_t showxdr_longlong(char *);
150 extern u_longlong_t getxdr_u_longlong(void);
151 extern u_longlong_t showxdr_u_longlong(char *);
152 extern char *getxdr_opaque(char *, int);
153 extern char *getxdr_string(char *, int);
154 extern char *showxdr_string(int, char *);
155 extern char *getxdr_bytes(uint_t *);
156 extern void xdr_skip(int);
157 extern int getxdr_pos(void);
158 extern void setxdr_pos(int);
159 extern char *getxdr_context(char *, int);
160 extern char *showxdr_context(char *);
161 extern enum_t getxdr_enum(void);
162 extern void show_space(void);
163 extern void show_trailer(void);
164 extern char *getxdr_date(void);
165 extern char *showxdr_date(char *);
166 extern char *getxdr_date_ns(void);
167 char *format_time(int64_t sec, uint32_t nsec);
168 extern char *showxdr_date_ns(char *);
169 extern char *getxdr_hex(int);
170 extern char *showxdr_hex(int, char *);
171 extern bool_t getxdr_bool(void);
172 extern bool_t showxdr_bool(char *);
173 extern char *concat_args(char **, int);
174 extern int pf_compile(char *, int);
175 extern void compile(char *, int);
176 extern void load_names(char *);
177 extern void cap_write(struct sb_hdr *, char *, int, int);
178 extern void cap_open_read(char *);
179 extern void cap_open_write(char *);
180 extern void cap_read(int, int, int, void (*)(), int);
181 extern void cap_close(void);
182 extern boolean_t check_device(char **, int *);
183 extern void initdevice(char *, ulong_t, ulong_t, struct timeval *,
184     struct Pf_ext_packetfilt *, int);
185 extern void net_read(int, int, void (*)(), int);
186 extern void click(int);
187 extern void show_pktinfo(int, int, char *, char *, struct timeval *,
188 		struct timeval *, int, int);
189 extern void show_line(char *);
190 extern char *getxdr_time(void);
191 extern char *showxdr_time(char *);
192 extern char *addrtoname(int, const void *);
193 extern char *show_string(const char *, int, int);
194 extern void pr_err(const char *, ...);
195 extern void check_retransmit(char *, ulong_t);
196 extern char *nameof_prog(int);
197 extern char *getproto(int);
198 extern uint8_t print_ipv6_extensions(int, uint8_t **, uint8_t *, int *, int *);
199 extern void protoprint(int, int, ulong_t, int, int, int, char *, int);
200 extern char *getportname(int, in_port_t);
201 
202 extern void interpret_arp(int, struct arphdr *, int);
203 extern void interpret_bparam(int, int, int, int, int, char *, int);
204 extern void interpret_dns(int, int, const uchar_t *, int);
205 extern void interpret_mount(int, int, int, int, int, char *, int);
206 extern void interpret_nfs(int, int, int, int, int, char *, int);
207 extern void interpret_nfs3(int, int, int, int, int, char *, int);
208 extern void interpret_nfs4(int, int, int, int, int, char *, int);
209 extern void interpret_nfs4_cb(int, int, int, int, int, char *, int);
210 extern void interpret_nfs_acl(int, int, int, int, int, char *, int);
211 extern void interpret_nis(int, int, int, int, int, char *, int);
212 extern void interpret_nisbind(int, int, int, int, int, char *, int);
213 extern void interpret_nisp_cb(int, int, int, int, int, char *, int);
214 extern void interpret_nisplus(int, int, int, int, int, char *, int);
215 extern void interpret_nlm(int, int, int, int, int, char *, int);
216 extern void interpret_pmap(int, int, int, int, int, char *, int);
217 extern int interpret_reserved(int, int, in_port_t, in_port_t, char *, int);
218 extern void interpret_rquota(int, int, int, int, int, char *, int);
219 extern void interpret_rstat(int, int, int, int, int, char *, int);
220 extern void interpret_solarnet_fw(int, int, int, int, int, char *, int);
221 extern void interpret_ldap(int, char *, int, int, int);
222 extern void interpret_icmp(int, struct icmp *, int, int);
223 extern void interpret_icmpv6(int, icmp6_t *, int, int);
224 extern int interpret_ip(int, const struct ip *, int);
225 extern int interpret_ipv6(int, const ip6_t *, int);
226 extern int interpret_ppp(int, uchar_t *, int);
227 extern int interpret_pppoe(int, poep_t *, int);
228 struct tcphdr;
229 extern int interpret_tcp(int, struct tcphdr *, int, int);
230 struct udphdr;
231 extern int interpret_udp(int, struct udphdr *, int, int);
232 extern int interpret_esp(int, uint8_t *, int, int);
233 extern int interpret_ah(int, uint8_t *, int, int);
234 struct sctp_hdr;
235 extern void interpret_sctp(int, struct sctp_hdr *, int, int);
236 extern void interpret_mip_cntrlmsg(int, uchar_t *, int);
237 struct dhcp;
238 extern int interpret_dhcp(int, struct dhcp *, int);
239 struct tftphdr;
240 extern int interpret_tftp(int, struct tftphdr *, int);
241 extern int interpret_http(int, char *, int);
242 struct ntpdata;
243 extern int interpret_ntp(int, struct ntpdata *, int);
244 extern void interpret_netbios_ns(int, uchar_t *, int);
245 extern void interpret_netbios_datagram(int, uchar_t *, int);
246 extern void interpret_netbios_ses(int, uchar_t *, int);
247 extern void interpret_slp(int, char *, int);
248 struct rip;
249 extern int interpret_rip(int, struct rip *, int);
250 struct rip6;
251 extern int interpret_rip6(int, struct rip6 *, int);
252 extern int interpret_socks_call(int, char *, int);
253 extern int interpret_socks_reply(int, char *, int);
254 extern void init_ldap(void);
255 extern boolean_t arp_for_ether(char *, struct ether_addr *);
256 extern char *ether_ouiname(uint32_t);
257 extern char *tohex(char *p, int len);
258 extern char *printether(struct ether_addr *);
259 extern char *print_ethertype(int);
260 
261 /*
262  * Describes characteristics of the Media Access Layer.
263  * The mac_type is one of the supported DLPI media
264  * types (see <sys/dlpi.h>).
265  * The mtu_size is the size of the largest frame.
266  * The header length is returned by a function to
267  * allow for variable header size - for ethernet it's
268  * just a constant 14 octets.
269  * The interpreter is the function that "knows" how
270  * to interpret the frame.
271  */
272 typedef struct interface {
273 	uint_t	mac_type;
274 	uint_t	mtu_size;
275 	uint_t	(*header_len)(char *);
276 	uint_t 	(*interpreter)(int, char *, int, int);
277 	uint_t	mac_hdr_fixed_size;
278 } interface_t;
279 
280 #define	IF_HDR_FIXED	0
281 #define	IF_HDR_VAR	1
282 
283 extern interface_t INTERFACES[], *interface;
284 extern char *device;
285 
286 extern char *dlc_header;
287 
288 extern char *src_name, *dst_name;
289 
290 extern char *prot_prefix;
291 extern char *prot_nest_prefix;
292 extern char *prot_title;
293 
294 /* Keep track of how many nested IP headers we have. */
295 extern unsigned int encap_levels, total_encap_levels;
296 
297 extern int quitting;
298 
299 /*
300  * Global error recovery routine: used to reset snoop variables after
301  * catastrophic failure.
302  */
303 void snoop_recover(void);
304 
305 /*
306  * Global alarm handler structure for managing multiple alarms within
307  * snoop.
308  */
309 typedef struct snoop_handler {
310 	struct snoop_handler *s_next;		/* next alarm handler */
311 	time_t s_time;				/* time to fire */
312 	void (*s_handler)();			/* alarm handler */
313 } snoop_handler_t;
314 
315 #define	SNOOP_MAXRECOVER	20	/* maxium number of recoveries */
316 #define	SNOOP_ALARM_GRAN	3	/* alarm() timeout multiplier */
317 
318 /*
319  * Global alarm handler management routine.
320  */
321 extern int snoop_alarm(int s_sec, void (*s_handler)());
322 
323 #ifdef __cplusplus
324 }
325 #endif
326 
327 #endif	/* _SNOOP_H */
328