]>
The Tcpdump Group git mirrors - libpcap/blob - pcap-usb-linux.c
2 * Copyright (c) 2006 Paolo Abeni (Italy)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote
15 * products derived from this software without specific prior written
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * USB sniffing API implementation for Linux platform
31 * By Paolo Abeni <paolo.abeni@email.it>
32 * Modifications: Kris Katterjohn <katterjohn@gmail.com>
36 static const char rcsid
[] _U_
=
37 "@(#) $Header: /tcpdump/master/libpcap/pcap-usb-linux.c,v 1.16.2.14 2008-12-23 20:14:13 guy Exp $ (LBL)";
45 #include "pcap-usb-linux.h"
48 #ifdef NEED_STRERROR_H
60 #include <netinet/in.h>
61 #include <sys/ioctl.h>
64 #define USB_IFACE "usb"
65 #define USB_TEXT_DIR "/sys/kernel/debug/usbmon"
66 #define SYS_USB_BUS_DIR "/sys/bus/usb/devices"
67 #define PROC_USB_BUS_DIR "/proc/bus/usb"
68 #define USB_LINE_LEN 4096
70 #if __BYTE_ORDER == __LITTLE_ENDIAN
75 #define htols(s) bswap_16(s)
76 #define htoll(l) bswap_32(l)
77 #define htol64(ll) bswap_64(ll)
80 struct mon_bin_stats
{
88 size_t data_len
; /* Length of data (can be zero) */
91 struct mon_bin_mfetch
{
92 int32_t *offvec
; /* Vector of events fetched */
93 int32_t nfetch
; /* Number of events to fetch (out: fetched) */
94 int32_t nflush
; /* Number of events to flush */
97 #define MON_IOC_MAGIC 0x92
99 #define MON_IOCQ_URB_LEN _IO(MON_IOC_MAGIC, 1)
100 #define MON_IOCX_URB _IOWR(MON_IOC_MAGIC, 2, struct mon_bin_hdr)
101 #define MON_IOCG_STATS _IOR(MON_IOC_MAGIC, 3, struct mon_bin_stats)
102 #define MON_IOCT_RING_SIZE _IO(MON_IOC_MAGIC, 4)
103 #define MON_IOCQ_RING_SIZE _IO(MON_IOC_MAGIC, 5)
104 #define MON_IOCX_GET _IOW(MON_IOC_MAGIC, 6, struct mon_bin_get)
105 #define MON_IOCX_MFETCH _IOWR(MON_IOC_MAGIC, 7, struct mon_bin_mfetch)
106 #define MON_IOCH_MFLUSH _IO(MON_IOC_MAGIC, 8)
108 #define MON_BIN_SETUP 0x1 /* setup hdr is present*/
109 #define MON_BIN_SETUP_ZERO 0x2 /* setup buffer is not available */
110 #define MON_BIN_DATA_ZERO 0x4 /* data buffer is not available */
111 #define MON_BIN_ERROR 0x8
113 /* forward declaration */
114 static int usb_activate(pcap_t
*);
115 static int usb_stats_linux(pcap_t
*, struct pcap_stat
*);
116 static int usb_stats_linux_bin(pcap_t
*, struct pcap_stat
*);
117 static int usb_read_linux(pcap_t
*, int , pcap_handler
, u_char
*);
118 static int usb_read_linux_bin(pcap_t
*, int , pcap_handler
, u_char
*);
119 static int usb_read_linux_mmap(pcap_t
*, int , pcap_handler
, u_char
*);
120 static int usb_inject_linux(pcap_t
*, const void *, size_t);
121 static int usb_setfilter_linux(pcap_t
*, struct bpf_program
*);
122 static int usb_setdirection_linux(pcap_t
*, pcap_direction_t
);
123 static void usb_cleanup_linux_mmap(pcap_t
*);
125 /* facility to add an USB device to the device list*/
127 usb_dev_add(pcap_if_t
** alldevsp
, int n
, char *err_str
)
131 snprintf(dev_name
, 10, USB_IFACE
"%d", n
);
132 snprintf(dev_descr
, 30, "USB bus number %d", n
);
134 if (pcap_add_if(alldevsp
, dev_name
, 0,
135 dev_descr
, err_str
) < 0)
141 usb_platform_finddevs(pcap_if_t
**alldevsp
, char *err_str
)
150 /* try scanning sysfs usb bus directory */
151 dir
= opendir(SYS_USB_BUS_DIR
);
153 while ((ret
== 0) && ((data
= readdir(dir
)) != 0)) {
156 if (strncmp(name
, "usb", 3) != 0)
159 if (sscanf(&name
[3], "%d", &n
) == 0)
162 ret
= usb_dev_add(alldevsp
, n
, err_str
);
169 /* that didn't work; try scanning procfs usb bus directory */
170 dir
= opendir(PROC_USB_BUS_DIR
);
172 while ((ret
== 0) && ((data
= readdir(dir
)) != 0)) {
176 /* if this file name does not end with a number it's not of our interest */
177 if ((len
< 1) || !isdigit(name
[--len
]))
179 while (isdigit(name
[--len
]));
180 if (sscanf(&name
[len
+1], "%d", &n
) != 1)
183 ret
= usb_dev_add(alldevsp
, n
, err_str
);
190 /* neither of them worked */
195 int usb_mmap(pcap_t
* handle
)
197 int len
= ioctl(handle
->fd
, MON_IOCQ_RING_SIZE
);
201 handle
->buffer
= mmap(0, len
, PROT_READ
, MAP_SHARED
, handle
->fd
, 0);
202 return handle
->buffer
!= MAP_FAILED
;
206 usb_create(const char *device
, char *ebuf
)
210 p
= pcap_create_common(device
, ebuf
);
214 p
->activate_op
= usb_activate
;
219 usb_activate(pcap_t
* handle
)
221 char full_path
[USB_LINE_LEN
];
223 /* Initialize some components of the pcap structure. */
224 handle
->bufsize
= handle
->snapshot
;
226 handle
->linktype
= DLT_USB_LINUX
;
228 handle
->inject_op
= usb_inject_linux
;
229 handle
->setfilter_op
= usb_setfilter_linux
;
230 handle
->setdirection_op
= usb_setdirection_linux
;
231 handle
->set_datalink_op
= NULL
; /* can't change data link type */
232 handle
->getnonblock_op
= pcap_getnonblock_fd
;
233 handle
->setnonblock_op
= pcap_setnonblock_fd
;
235 /*get usb bus index from device name */
236 if (sscanf(handle
->opt
.source
, USB_IFACE
"%d", &handle
->md
.ifindex
) != 1)
238 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
239 "Can't get USB bus index from %s", handle
->opt
.source
);
243 /*now select the read method: try to open binary interface */
244 snprintf(full_path
, USB_LINE_LEN
, LINUX_USB_MON_DEV
"%d", handle
->md
.ifindex
);
245 handle
->fd
= open(full_path
, O_RDONLY
, 0);
248 if (handle
->opt
.rfmon
) {
250 * Monitor mode doesn't apply to USB devices.
253 return PCAP_ERROR_RFMON_NOTSUP
;
256 /* binary api is available, try to use fast mmap access */
257 if (usb_mmap(handle
)) {
258 handle
->linktype
= DLT_USB_LINUX_MMAPPED
;
259 handle
->stats_op
= usb_stats_linux_bin
;
260 handle
->read_op
= usb_read_linux_mmap
;
261 handle
->cleanup_op
= usb_cleanup_linux_mmap
;
264 * "handle->fd" is a real file, so "select()" and
265 * "poll()" work on it.
267 handle
->selectable_fd
= handle
->fd
;
271 /* can't mmap, use plain binary interface access */
272 handle
->stats_op
= usb_stats_linux_bin
;
273 handle
->read_op
= usb_read_linux_bin
;
276 /*Binary interface not available, try open text interface */
277 snprintf(full_path
, USB_LINE_LEN
, USB_TEXT_DIR
"/%dt", handle
->md
.ifindex
);
278 handle
->fd
= open(full_path
, O_RDONLY
, 0);
281 /* no more fallback, give it up*/
282 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
283 "Can't open USB bus file %s: %s", full_path
, strerror(errno
));
287 if (handle
->opt
.rfmon
) {
289 * Monitor mode doesn't apply to USB devices.
292 return PCAP_ERROR_RFMON_NOTSUP
;
295 handle
->stats_op
= usb_stats_linux
;
296 handle
->read_op
= usb_read_linux
;
300 * "handle->fd" is a real file, so "select()" and "poll()"
303 handle
->selectable_fd
= handle
->fd
;
305 /* for plain binary access and text access we need to allocate the read
307 handle
->buffer
= malloc(handle
->bufsize
);
308 if (!handle
->buffer
) {
309 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
310 "malloc: %s", pcap_strerror(errno
));
319 return c
< 'A' ? c
- '0': ((c
<'a') ? c
- 'A' + 10: c
-'a'+10);
323 * see <linux-kernel-source>/Documentation/usb/usbmon.txt and
324 * <linux-kernel-source>/drivers/usb/mon/mon_text.c for urb string
328 usb_read_linux(pcap_t
*handle
, int max_packets
, pcap_handler callback
, u_char
*user
)
331 * /usr/src/linux/Documentation/usb/usbmon.txt
335 int tag
, cnt
, ep_num
, dev_addr
, dummy
, ret
, urb_len
, data_len
;
336 char etype
, pipeid1
, pipeid2
, status
[16], urb_tag
, line
[USB_LINE_LEN
];
338 u_char
* rawdata
= handle
->buffer
;
339 struct pcap_pkthdr pkth
;
340 pcap_usb_header
* uhdr
= (pcap_usb_header
*)handle
->buffer
;
341 u_char urb_transfer
=0;
344 /* ignore interrupt system call errors */
346 ret
= read(handle
->fd
, line
, USB_LINE_LEN
- 1);
347 if (handle
->break_loop
)
349 handle
->break_loop
= 0;
352 } while ((ret
== -1) && (errno
== EINTR
));
356 return 0; /* no data there */
358 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
359 "Can't read from fd %d: %s", handle
->fd
, strerror(errno
));
363 /* read urb header; %n argument may increment return value, but it's
364 * not mandatory, so does not count on it*/
366 ret
= sscanf(string
, "%x %d %c %c%c:%d:%d %s%n", &tag
, ×tamp
, &etype
,
367 &pipeid1
, &pipeid2
, &dev_addr
, &ep_num
, status
,
371 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
372 "Can't parse USB bus message '%s', too few tokens (expected 8 got %d)",
377 uhdr
->device_address
= dev_addr
;
378 uhdr
->bus_id
= handle
->md
.ifindex
;
382 /* don't use usbmon provided timestamp, since it have low precision*/
383 if (gettimeofday(&pkth
.ts
, NULL
) < 0)
385 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
386 "Can't get timestamp for message '%s' %d:%s",
387 string
, errno
, strerror(errno
));
390 uhdr
->ts_sec
= pkth
.ts
.tv_sec
;
391 uhdr
->ts_usec
= pkth
.ts
.tv_usec
;
393 /* parse endpoint information */
395 urb_transfer
= URB_CONTROL
;
396 else if (pipeid1
== 'Z')
397 urb_transfer
= URB_ISOCHRONOUS
;
398 else if (pipeid1
== 'I')
399 urb_transfer
= URB_INTERRUPT
;
400 else if (pipeid1
== 'B')
401 urb_transfer
= URB_BULK
;
402 if (pipeid2
== 'i') {
403 ep_num
|= URB_TRANSFER_IN
;
407 incoming
= !incoming
;
412 if (handle
->direction
== PCAP_D_OUT
)
416 if (handle
->direction
== PCAP_D_IN
)
418 uhdr
->event_type
= etype
;
419 uhdr
->transfer_type
= urb_transfer
;
420 uhdr
->endpoint_number
= ep_num
;
421 pkth
.caplen
= sizeof(pcap_usb_header
);
422 rawdata
+= sizeof(pcap_usb_header
);
424 /* check if this is a setup packet */
425 ret
= sscanf(status
, "%d", &dummy
);
428 /* this a setup packet, setup data can be filled with underscore if
429 * usbmon has not been able to read them, so we must parse this fields as
431 pcap_usb_setup
* shdr
;
432 char str1
[3], str2
[3], str3
[5], str4
[5], str5
[5];
433 ret
= sscanf(string
, "%s %s %s %s %s%n", str1
, str2
, str3
, str4
,
437 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
438 "Can't parse USB bus message '%s', too few tokens (expected 5 got %d)",
444 /* try to convert to corresponding integer */
446 shdr
->bmRequestType
= strtoul(str1
, 0, 16);
447 shdr
->bRequest
= strtoul(str2
, 0, 16);
448 shdr
->wValue
= htols(strtoul(str3
, 0, 16));
449 shdr
->wIndex
= htols(strtoul(str4
, 0, 16));
450 shdr
->wLength
= htols(strtoul(str5
, 0, 16));
452 uhdr
->setup_flag
= 0;
455 uhdr
->setup_flag
= 1;
458 ret
= sscanf(string
, " %d%n", &urb_len
, &cnt
);
461 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
462 "Can't parse urb length from '%s'", string
);
467 /* urb tag is not present if urb length is 0, so we can stop here
469 pkth
.len
= urb_len
+pkth
.caplen
;
470 uhdr
->urb_len
= urb_len
;
473 if (uhdr
->urb_len
== 0)
476 /* check for data presence; data is present if and only if urb tag is '=' */
477 if (sscanf(string
, " %c", &urb_tag
) != 1)
479 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
480 "Can't parse urb tag from '%s'", string
);
487 /* skip urb tag and following space */
490 /* if we reach this point we got some urb data*/
493 /* read all urb data; if urb length is greater then the usbmon internal
494 * buffer length used by the kernel to spool the URB, we get only
495 * a partial information.
496 * At least until linux 2.6.17 there is no way to set usbmon intenal buffer
497 * length and default value is 130. */
498 while ((string
[0] != 0) && (string
[1] != 0) && (pkth
.caplen
< handle
->snapshot
))
500 rawdata
[0] = ascii_to_int(string
[0]) * 16 + ascii_to_int(string
[1]);
503 if (string
[0] == ' ')
510 uhdr
->data_len
= data_len
;
511 handle
->md
.packets_read
++;
512 if (pkth
.caplen
> handle
->snapshot
)
513 pkth
.caplen
= handle
->snapshot
;
515 callback(user
, &pkth
, handle
->buffer
);
520 usb_inject_linux(pcap_t
*handle
, const void *buf
, size_t size
)
522 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
, "inject not supported on "
528 usb_stats_linux(pcap_t
*handle
, struct pcap_stat
*stats
)
530 int dummy
, ret
, consumed
, cnt
;
531 char string
[USB_LINE_LEN
];
532 char token
[USB_LINE_LEN
];
534 snprintf(string
, USB_LINE_LEN
, USB_TEXT_DIR
"/%ds", handle
->md
.ifindex
);
536 int fd
= open(string
, O_RDONLY
, 0);
539 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
540 "Can't open USB stats file %s: %s",
541 string
, strerror(errno
));
545 /* read stats line */
547 ret
= read(fd
, string
, USB_LINE_LEN
-1);
548 } while ((ret
== -1) && (errno
== EINTR
));
553 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
554 "Can't read stats from fd %d ", fd
);
559 /* extract info on dropped urbs */
560 for (consumed
=0; consumed
< ret
; ) {
561 /* from the sscanf man page:
562 * The C standard says: "Execution of a %n directive does
563 * not increment the assignment count returned at the completion
564 * of execution" but the Corrigendum seems to contradict this.
565 * Do not make any assumptions on the effect of %n conversions
566 * on the return value and explicitly check for cnt assignmet*/
568 int ntok
= sscanf(ptr
, "%s%n", token
, &cnt
);
569 if ((ntok
< 1) || (cnt
< 0))
573 if (strcmp(token
, "nreaders") == 0)
574 ret
= sscanf(ptr
, "%d", &stats
->ps_drop
);
576 ret
= sscanf(ptr
, "%d", &dummy
);
583 stats
->ps_recv
= handle
->md
.packets_read
;
584 stats
->ps_ifdrop
= 0;
589 usb_setfilter_linux(pcap_t
*p
, struct bpf_program
*fp
)
595 usb_setdirection_linux(pcap_t
*p
, pcap_direction_t d
)
603 usb_stats_linux_bin(pcap_t
*handle
, struct pcap_stat
*stats
)
606 struct mon_bin_stats st
;
607 ret
= ioctl(handle
->fd
, MON_IOCG_STATS
, &st
);
610 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
611 "Can't read stats from fd %d:%s ", handle
->fd
, strerror(errno
));
615 stats
->ps_recv
= handle
->md
.packets_read
+ st
.queued
;
616 stats
->ps_ifdrop
= 0;
617 stats
->ps_drop
= st
.dropped
;
622 * see <linux-kernel-source>/Documentation/usb/usbmon.txt and
623 * <linux-kernel-source>/drivers/usb/mon/mon_bin.c binary ABI
626 usb_read_linux_bin(pcap_t
*handle
, int max_packets
, pcap_handler callback
, u_char
*user
)
628 struct mon_bin_get info
;
630 struct pcap_pkthdr pkth
;
631 int clen
= handle
->snapshot
- sizeof(pcap_usb_header
);
633 /* the usb header is going to be part of 'packet' data*/
634 info
.hdr
= (pcap_usb_header
*) handle
->buffer
;
635 info
.data
= handle
->buffer
+ sizeof(pcap_usb_header
);
636 info
.data_len
= clen
;
638 /* ignore interrupt system call errors */
640 ret
= ioctl(handle
->fd
, MON_IOCX_GET
, &info
);
641 if (handle
->break_loop
)
643 handle
->break_loop
= 0;
646 } while ((ret
== -1) && (errno
== EINTR
));
650 return 0; /* no data there */
652 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
653 "Can't read from fd %d: %s", handle
->fd
, strerror(errno
));
657 /* we can get less that than really captured from kernel, depending on
658 * snaplen, so adjust header accordingly */
659 if (info
.hdr
->data_len
< clen
)
660 clen
= info
.hdr
->data_len
;
661 info
.hdr
->data_len
= clen
;
662 pkth
.caplen
= clen
+ sizeof(pcap_usb_header
);
663 pkth
.len
= info
.hdr
->data_len
+ sizeof(pcap_usb_header
);
664 pkth
.ts
.tv_sec
= info
.hdr
->ts_sec
;
665 pkth
.ts
.tv_usec
= info
.hdr
->ts_usec
;
667 handle
->md
.packets_read
++;
668 callback(user
, &pkth
, handle
->buffer
);
673 * see <linux-kernel-source>/Documentation/usb/usbmon.txt and
674 * <linux-kernel-source>/drivers/usb/mon/mon_bin.c binary ABI
678 usb_read_linux_mmap(pcap_t
*handle
, int max_packets
, pcap_handler callback
, u_char
*user
)
680 struct mon_bin_mfetch fetch
;
681 int32_t vec
[VEC_SIZE
];
682 struct pcap_pkthdr pkth
;
683 pcap_usb_header
* hdr
;
688 max_clen
= handle
->snapshot
- sizeof(pcap_usb_header
);
692 int limit
= max_packets
- packets
;
695 if (limit
> VEC_SIZE
)
698 /* try to fetch as many events as possible*/
700 fetch
.nfetch
= limit
;
701 fetch
.nflush
= nflush
;
702 /* ignore interrupt system call errors */
704 ret
= ioctl(handle
->fd
, MON_IOCX_MFETCH
, &fetch
);
705 if (handle
->break_loop
)
707 handle
->break_loop
= 0;
710 } while ((ret
== -1) && (errno
== EINTR
));
714 return 0; /* no data there */
716 snprintf(handle
->errbuf
, PCAP_ERRBUF_SIZE
,
717 "Can't mfetch fd %d: %s", handle
->fd
, strerror(errno
));
721 /* keep track of processed events, we will flush them later */
722 nflush
= fetch
.nfetch
;
723 for (i
=0; i
<fetch
.nfetch
; ++i
) {
725 hdr
= (pcap_usb_header
*) &handle
->buffer
[vec
[i
]];
726 if (hdr
->event_type
== '@')
729 /* we can get less that than really captured from kernel, depending on
730 * snaplen, so adjust header accordingly */
732 if (hdr
->data_len
< clen
)
733 clen
= hdr
->data_len
;
735 /* get packet info from header*/
736 pkth
.caplen
= clen
+ sizeof(pcap_usb_header_mmapped
);
737 pkth
.len
= hdr
->data_len
+ sizeof(pcap_usb_header_mmapped
);
738 pkth
.ts
.tv_sec
= hdr
->ts_sec
;
739 pkth
.ts
.tv_usec
= hdr
->ts_usec
;
741 handle
->md
.packets_read
++;
742 callback(user
, &pkth
, (u_char
*) hdr
);
746 /* with max_packets <= 0 we stop afer the first chunk*/
747 if ((max_packets
<= 0) || (packets
== max_packets
))
751 /* flush pending events*/
752 ioctl(handle
->fd
, MON_IOCH_MFLUSH
, nflush
);
757 usb_cleanup_linux_mmap(pcap_t
* handle
)
759 /* buffer must not be freed because it's memory mapped */
760 /* XXX - does it need to be unmapped? */
761 handle
->buffer
= NULL
;
762 pcap_cleanup_live_common(handle
);