xref: /freebsd/contrib/libpcap/pcap-libdlpi.c (revision 313376588638950ba1e93c403dd8c97bc52fd3a2)
1 /*
2  * Copyright (c) 1993, 1994, 1995, 1996, 1997
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that: (1) source code distributions
7  * retain the above copyright notice and this paragraph in its entirety, (2)
8  * distributions including binary code include the above copyright notice and
9  * this paragraph in its entirety in the documentation or other materials
10  * provided with the distribution, and (3) all advertising materials mentioning
11  * features or use of this software display the following acknowledgement:
12  * ``This product includes software developed by the University of California,
13  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
14  * the University nor the names of its contributors may be used to endorse
15  * or promote products derived from this software without specific prior
16  * written permission.
17  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
18  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
20  *
21  * This code contributed by Sagun Shakya (sagun.shakya@sun.com)
22  */
23 /*
24  * Packet capture routines for DLPI using libdlpi under SunOS 5.11.
25  */
26 
27 #ifndef lint
28 static const char rcsid[] _U_ =
29 	"@(#) $Header: /tcpdump/master/libpcap/pcap-libdlpi.c,v 1.6 2008-04-14 20:40:58 guy Exp $ (LBL)";
30 #endif
31 
32 #ifdef HAVE_CONFIG_H
33 #include "config.h"
34 #endif
35 
36 #include <sys/types.h>
37 #include <sys/time.h>
38 #include <sys/bufmod.h>
39 #include <sys/stream.h>
40 #include <libdlpi.h>
41 #include <errno.h>
42 #include <memory.h>
43 #include <stropts.h>
44 #include <stdio.h>
45 #include <stdlib.h>
46 #include <string.h>
47 
48 #include "pcap-int.h"
49 #include "dlpisubs.h"
50 
51 /* Forwards. */
52 static int dlpromiscon(pcap_t *, bpf_u_int32);
53 static int pcap_read_libdlpi(pcap_t *, int, pcap_handler, u_char *);
54 static int pcap_inject_libdlpi(pcap_t *, const void *, size_t);
55 static void pcap_close_libdlpi(pcap_t *);
56 static void pcap_libdlpi_err(const char *, const char *, int, char *);
57 static void pcap_cleanup_libdlpi(pcap_t *);
58 
59 /*
60  * list_interfaces() will list all the network links that are
61  * available on a system.
62  */
63 static boolean_t list_interfaces(const char *, void *);
64 
65 typedef struct linknamelist {
66 	char	linkname[DLPI_LINKNAME_MAX];
67 	struct linknamelist *lnl_next;
68 } linknamelist_t;
69 
70 typedef struct linkwalk {
71 	linknamelist_t	*lw_list;
72 	int		lw_err;
73 } linkwalk_t;
74 
75 /*
76  * The caller of this function should free the memory allocated
77  * for each linknamelist_t "entry" allocated.
78  */
79 static boolean_t
80 list_interfaces(const char *linkname, void *arg)
81 {
82 	linkwalk_t	*lwp = arg;
83 	linknamelist_t	*entry;
84 
85 	if ((entry = calloc(1, sizeof(linknamelist_t))) == NULL) {
86 		lwp->lw_err = ENOMEM;
87 		return (B_TRUE);
88 	}
89 	(void) strlcpy(entry->linkname, linkname, DLPI_LINKNAME_MAX);
90 
91 	if (lwp->lw_list == NULL) {
92 		lwp->lw_list = entry;
93 	} else {
94 		entry->lnl_next = lwp->lw_list;
95 		lwp->lw_list = entry;
96 	}
97 
98 	return (B_FALSE);
99 }
100 
101 static int
102 pcap_activate_libdlpi(pcap_t *p)
103 {
104 	int retv;
105 	dlpi_handle_t dh;
106 	dlpi_info_t dlinfo;
107 	int err = PCAP_ERROR;
108 
109 	/*
110 	 * Enable Solaris raw and passive DLPI extensions;
111 	 * dlpi_open() will not fail if the underlying link does not support
112 	 * passive mode. See dlpi(7P) for details.
113 	 */
114 	retv = dlpi_open(p->opt.source, &dh, DLPI_RAW|DLPI_PASSIVE);
115 	if (retv != DLPI_SUCCESS) {
116 		if (retv == DLPI_ELINKNAMEINVAL || retv == DLPI_ENOLINK)
117 			err = PCAP_ERROR_NO_SUCH_DEVICE;
118 		else if (retv == DL_SYSERR &&
119 		    (errno == EPERM || errno == EACCES))
120 			err = PCAP_ERROR_PERM_DENIED;
121 		pcap_libdlpi_err(p->opt.source, "dlpi_open", retv,
122 		    p->errbuf);
123 		return (err);
124 	}
125 	p->dlpi_hd = dh;
126 
127 	if (p->opt.rfmon) {
128 		/*
129 		 * This device exists, but we don't support monitor mode
130 		 * any platforms that support DLPI.
131 		 */
132 		err = PCAP_ERROR_RFMON_NOTSUP;
133 		goto bad;
134 	}
135 
136 	/* Bind with DLPI_ANY_SAP. */
137 	if ((retv = dlpi_bind(p->dlpi_hd, DLPI_ANY_SAP, 0)) != DLPI_SUCCESS) {
138 		pcap_libdlpi_err(p->opt.source, "dlpi_bind", retv, p->errbuf);
139 		goto bad;
140 	}
141 
142 	/* Enable promiscuous mode. */
143 	if (p->opt.promisc) {
144 		err = dlpromiscon(p, DL_PROMISC_PHYS);
145 		if (err < 0) {
146 			/*
147 			 * "You don't have permission to capture on
148 			 * this device" and "you don't have permission
149 			 * to capture in promiscuous mode on this
150 			 * device" are different; let the user know,
151 			 * so if they can't get permission to
152 			 * capture in promiscuous mode, they can at
153 			 * least try to capture in non-promiscuous
154 			 * mode.
155 			 *
156 			 * XXX - you might have to capture in
157 			 * promiscuous mode to see outgoing packets.
158 			 */
159 			if (err == PCAP_ERROR_PERM_DENIED)
160 				err = PCAP_ERROR_PROMISC_PERM_DENIED;
161 			goto bad;
162 		}
163 	} else {
164 		/* Try to enable multicast. */
165 		err = dlpromiscon(p, DL_PROMISC_MULTI);
166 		if (err < 0)
167 			goto bad;
168 	}
169 
170 	/* Try to enable SAP promiscuity. */
171 	err = dlpromiscon(p, DL_PROMISC_SAP);
172 	if (err < 0) {
173 		/*
174 		 * Not fatal, since the DL_PROMISC_PHYS mode worked.
175 		 * Report it as a warning, however.
176 		 */
177 		if (p->opt.promisc)
178 			err = PCAP_WARNING;
179 		else
180 			goto bad;
181 	}
182 
183 	/* Determine link type.  */
184 	if ((retv = dlpi_info(p->dlpi_hd, &dlinfo, 0)) != DLPI_SUCCESS) {
185 		pcap_libdlpi_err(p->opt.source, "dlpi_info", retv, p->errbuf);
186 		goto bad;
187 	}
188 
189 	if (pcap_process_mactype(p, dlinfo.di_mactype) != 0)
190 		goto bad;
191 
192 	p->fd = dlpi_fd(p->dlpi_hd);
193 
194 	/* Push and configure bufmod. */
195 	if (pcap_conf_bufmod(p, p->snapshot, p->md.timeout) != 0)
196 		goto bad;
197 
198 	/*
199 	 * Flush the read side.
200 	 */
201 	if (ioctl(p->fd, I_FLUSH, FLUSHR) != 0) {
202 		snprintf(p->errbuf, PCAP_ERRBUF_SIZE, "FLUSHR: %s",
203 		    pcap_strerror(errno));
204 		goto bad;
205 	}
206 
207 	/* Allocate data buffer. */
208 	if (pcap_alloc_databuf(p) != 0)
209 		goto bad;
210 
211 	/*
212 	 * "p->fd" is a FD for a STREAMS device, so "select()" and
213 	 * "poll()" should work on it.
214 	 */
215 	p->selectable_fd = p->fd;
216 
217 	p->read_op = pcap_read_libdlpi;
218 	p->inject_op = pcap_inject_libdlpi;
219 	p->setfilter_op = install_bpf_program;	/* No kernel filtering */
220 	p->setdirection_op = NULL;	/* Not implemented */
221 	p->set_datalink_op = NULL;	/* Can't change data link type */
222 	p->getnonblock_op = pcap_getnonblock_fd;
223 	p->setnonblock_op = pcap_setnonblock_fd;
224 	p->stats_op = pcap_stats_dlpi;
225 	p->cleanup_op = pcap_cleanup_libdlpi;
226 
227 	return (0);
228 bad:
229 	pcap_cleanup_libdlpi(p);
230 	return (err);
231 }
232 
233 #define STRINGIFY(n)	#n
234 
235 static int
236 dlpromiscon(pcap_t *p, bpf_u_int32 level)
237 {
238 	int err;
239 
240 	retv = dlpi_promiscon(p->dlpi_hd, level);
241 	if (retv != DLPI_SUCCESS) {
242 		if (retv == DL_SYSERR &&
243 		    (errno == EPERM || errno == EACCES))
244 			err = PCAP_ERROR_PERM_DENIED;
245 		else
246 			err = PCAP_ERROR;
247 		pcap_libdlpi_err(p->opt.source, "dlpi_promiscon" STRINGIFY(level),
248 		    retv, p->errbuf);
249 		return (err);
250 	}
251 	return (0);
252 }
253 
254 /*
255  * In Solaris, the "standard" mechanism" i.e SIOCGLIFCONF will only find
256  * network links that are plumbed and are up. dlpi_walk(3DLPI) will find
257  * additional network links present in the system.
258  */
259 int
260 pcap_platform_finddevs(pcap_if_t **alldevsp, char *errbuf)
261 {
262 	int retv = 0;
263 
264 	linknamelist_t	*entry, *next;
265 	linkwalk_t	lw = {NULL, 0};
266 	int 		save_errno;
267 
268 	/* dlpi_walk() for loopback will be added here. */
269 
270 	dlpi_walk(list_interfaces, &lw, 0);
271 
272 	if (lw.lw_err != 0) {
273 		snprintf(errbuf, PCAP_ERRBUF_SIZE,
274 		    "dlpi_walk: %s", pcap_strerror(lw.lw_err));
275 		retv = -1;
276 		goto done;
277 	}
278 
279 	/* Add linkname if it does not exist on the list. */
280 	for (entry = lw.lw_list; entry != NULL; entry = entry->lnl_next) {
281 		if (pcap_add_if(alldevsp, entry->linkname, 0, NULL, errbuf) < 0)
282 			retv = -1;
283 	}
284 done:
285 	save_errno = errno;
286 	for (entry = lw.lw_list; entry != NULL; entry = next) {
287 		next = entry->lnl_next;
288 		free(entry);
289 	}
290 	errno = save_errno;
291 
292 	return (retv);
293 }
294 
295 /*
296  * Read data received on DLPI handle. Returns -2 if told to terminate, else
297  * returns the number of packets read.
298  */
299 static int
300 pcap_read_libdlpi(pcap_t *p, int count, pcap_handler callback, u_char *user)
301 {
302 	int len;
303 	u_char *bufp;
304 	size_t msglen;
305 	int retv;
306 
307 	len = p->cc;
308 	if (len != 0) {
309 		bufp = p->bp;
310 		goto process_pkts;
311 	}
312 	do {
313 		/* Has "pcap_breakloop()" been called? */
314 		if (p->break_loop) {
315 			/*
316 			 * Yes - clear the flag that indicates that it has,
317 			 * and return -2 to indicate that we were told to
318 			 * break out of the loop.
319 			 */
320 			p->break_loop = 0;
321 			return (-2);
322 		}
323 
324 		msglen = p->bufsize;
325 		bufp = p->buffer + p->offset;
326 
327 		retv = dlpi_recv(p->dlpi_hd, NULL, NULL, bufp,
328 		    &msglen, -1, NULL);
329 		if (retv != DLPI_SUCCESS) {
330 			/*
331 			 * This is most likely a call to terminate out of the
332 			 * loop. So, do not return an error message, instead
333 			 * check if "pcap_breakloop()" has been called above.
334 			 */
335 			if (retv == DL_SYSERR && errno == EINTR) {
336 				len = 0;
337 				continue;
338 			}
339 			pcap_libdlpi_err(dlpi_linkname(p->dlpi_hd),
340 			    "dlpi_recv", retv, p->errbuf);
341 			return (-1);
342 		}
343 		len = msglen;
344 	} while (len == 0);
345 
346 process_pkts:
347 	return (pcap_process_pkts(p, callback, user, count, bufp, len));
348 }
349 
350 static int
351 pcap_inject_libdlpi(pcap_t *p, const void *buf, size_t size)
352 {
353 	int retv;
354 
355 	retv = dlpi_send(p->dlpi_hd, NULL, 0, buf, size, NULL);
356 	if (retv != DLPI_SUCCESS) {
357 		pcap_libdlpi_err(dlpi_linkname(p->dlpi_hd), "dlpi_send", retv,
358 		    p->errbuf);
359 		return (-1);
360 	}
361 	/*
362 	 * dlpi_send(3DLPI) does not provide a way to return the number of
363 	 * bytes sent on the wire. Based on the fact that DLPI_SUCCESS was
364 	 * returned we are assuming 'size' bytes were sent.
365 	 */
366 	return (size);
367 }
368 
369 /*
370  * Close dlpi handle.
371  */
372 static void
373 pcap_cleanup_libdlpi(pcap_t *p)
374 {
375 	if (p->dlpi_hd != NULL) {
376 		dlpi_close(p->dlpi_hd);
377 		p->dlpi_hd = NULL;
378 		p->fd = -1;
379 	}
380 	pcap_cleanup_live_common(p);
381 }
382 
383 /*
384  * Write error message to buffer.
385  */
386 static void
387 pcap_libdlpi_err(const char *linkname, const char *func, int err, char *errbuf)
388 {
389 	snprintf(errbuf, PCAP_ERRBUF_SIZE, "libpcap: %s failed on %s: %s",
390 	    func, linkname, dlpi_strerror(err));
391 }
392 
393 pcap_t *
394 pcap_create_interface(const char *device, char *ebuf)
395 {
396 	pcap_t *p;
397 
398 	p = pcap_create_common(device, ebuf);
399 	if (p == NULL)
400 		return (NULL);
401 
402 	p->activate_op = pcap_activate_libdlpi;
403 	return (p);
404 }
405