2 * The USB Monitor, inspired by Dave Harding's USBMon.
4 * This is a text format reader.
7 #include <linux/kernel.h>
8 #include <linux/list.h>
10 #include <linux/slab.h>
11 #include <linux/time.h>
12 #include <linux/mutex.h>
13 #include <linux/debugfs.h>
14 #include <linux/scatterlist.h>
15 #include <asm/uaccess.h>
20 * No, we do not want arbitrarily long data strings.
21 * Use the binary interface if you want to capture bulk data!
26 * Defined by USB 2.0 clause 9.3, table 9.2.
31 * This limit exists to prevent OOMs when the user process stops reading.
32 * If usbmon were available to unprivileged processes, it might be open
33 * to a local DoS. But we have to keep to root in order to prevent
34 * password sniffing from HID devices.
36 #define EVENT_MAX (4*PAGE_SIZE / sizeof(struct mon_event_text))
39 * Potentially unlimited number; we limit it for similar allocations.
40 * The usbfs limits this to 128, but we're not quite as generous.
44 #define PRINTF_DFL 250 /* with 5 ISOs segs */
49 unsigned int length
; /* Unsigned here, signed in URB. Historic. */
52 struct mon_event_text
{
53 struct list_head e_link
;
54 int type
; /* submit, complete, etc. */
55 unsigned long id
; /* From pointer, most of the time */
62 int length
; /* Depends on type: xfer length or act length */
69 int numdesc
; /* Full number */
70 struct mon_iso_desc isodesc
[ISODESC_MAX
];
71 unsigned char setup
[SETUP_MAX
];
72 unsigned char data
[DATA_MAX
];
75 #define SLAB_NAME_SZ 30
76 struct mon_reader_text
{
77 struct kmem_cache
*e_slab
;
79 struct list_head e_list
;
80 struct mon_reader r
; /* In C, parent class can be placed anywhere */
82 wait_queue_head_t wait
;
85 struct mutex printf_lock
;
87 char slab_name
[SLAB_NAME_SZ
];
90 static struct dentry
*mon_dir
; /* Usually /sys/kernel/debug/usbmon */
92 static void mon_text_ctor(void *);
99 static struct mon_event_text
*
100 mon_text_read_wait(struct mon_reader_text
*rp
, struct file
*file
);
101 static void mon_text_read_head_t(struct mon_reader_text
*rp
,
102 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
);
103 static void mon_text_read_head_u(struct mon_reader_text
*rp
,
104 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
);
105 static void mon_text_read_statset(struct mon_reader_text
*rp
,
106 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
);
107 static void mon_text_read_intstat(struct mon_reader_text
*rp
,
108 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
);
109 static void mon_text_read_isostat(struct mon_reader_text
*rp
,
110 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
);
111 static void mon_text_read_isodesc(struct mon_reader_text
*rp
,
112 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
);
113 static void mon_text_read_data(struct mon_reader_text
*rp
,
114 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
);
120 * May be called from an interrupt.
122 * This is called with the whole mon_bus locked, so no additional lock.
125 static inline char mon_text_get_setup(struct mon_event_text
*ep
,
126 struct urb
*urb
, char ev_type
, struct mon_bus
*mbus
)
129 if (ep
->xfertype
!= USB_ENDPOINT_XFER_CONTROL
|| ev_type
!= 'S')
132 if (urb
->setup_packet
== NULL
)
133 return 'Z'; /* '0' would be not as pretty. */
135 memcpy(ep
->setup
, urb
->setup_packet
, SETUP_MAX
);
139 static inline char mon_text_get_data(struct mon_event_text
*ep
, struct urb
*urb
,
140 int len
, char ev_type
, struct mon_bus
*mbus
)
157 if (urb
->num_sgs
== 0) {
158 src
= urb
->transfer_buffer
;
160 return 'Z'; /* '0' would be not as pretty. */
162 struct scatterlist
*sg
= urb
->sg
;
164 if (PageHighMem(sg_page(sg
)))
167 /* For the text interface we copy only the first sg buffer */
168 len
= min_t(int, sg
->length
, len
);
172 memcpy(ep
->data
, src
, len
);
176 static inline unsigned int mon_get_timestamp(void)
181 do_gettimeofday(&tval
);
182 stamp
= tval
.tv_sec
& 0xFFF; /* 2^32 = 4294967296. Limit to 4096s. */
183 stamp
= stamp
* 1000000 + tval
.tv_usec
;
187 static void mon_text_event(struct mon_reader_text
*rp
, struct urb
*urb
,
188 char ev_type
, int status
)
190 struct mon_event_text
*ep
;
192 struct usb_iso_packet_descriptor
*fp
;
193 struct mon_iso_desc
*dp
;
196 stamp
= mon_get_timestamp();
198 if (rp
->nevents
>= EVENT_MAX
||
199 (ep
= kmem_cache_alloc(rp
->e_slab
, GFP_ATOMIC
)) == NULL
) {
200 rp
->r
.m_bus
->cnt_text_lost
++;
205 ep
->id
= (unsigned long) urb
;
206 ep
->busnum
= urb
->dev
->bus
->busnum
;
207 ep
->devnum
= urb
->dev
->devnum
;
208 ep
->epnum
= usb_endpoint_num(&urb
->ep
->desc
);
209 ep
->xfertype
= usb_endpoint_type(&urb
->ep
->desc
);
210 ep
->is_in
= usb_urb_dir_in(urb
);
212 ep
->length
= (ev_type
== 'S') ?
213 urb
->transfer_buffer_length
: urb
->actual_length
;
214 /* Collecting status makes debugging sense for submits, too */
217 if (ep
->xfertype
== USB_ENDPOINT_XFER_INT
) {
218 ep
->interval
= urb
->interval
;
219 } else if (ep
->xfertype
== USB_ENDPOINT_XFER_ISOC
) {
220 ep
->interval
= urb
->interval
;
221 ep
->start_frame
= urb
->start_frame
;
222 ep
->error_count
= urb
->error_count
;
224 ep
->numdesc
= urb
->number_of_packets
;
225 if (ep
->xfertype
== USB_ENDPOINT_XFER_ISOC
&&
226 urb
->number_of_packets
> 0) {
227 if ((ndesc
= urb
->number_of_packets
) > ISODESC_MAX
)
229 fp
= urb
->iso_frame_desc
;
231 for (i
= 0; i
< ndesc
; i
++) {
232 dp
->status
= fp
->status
;
233 dp
->offset
= fp
->offset
;
234 dp
->length
= (ev_type
== 'S') ?
235 fp
->length
: fp
->actual_length
;
239 /* Wasteful, but simple to understand: ISO 'C' is sparse. */
241 ep
->length
= urb
->transfer_buffer_length
;
244 ep
->setup_flag
= mon_text_get_setup(ep
, urb
, ev_type
, rp
->r
.m_bus
);
245 ep
->data_flag
= mon_text_get_data(ep
, urb
, ep
->length
, ev_type
,
249 list_add_tail(&ep
->e_link
, &rp
->e_list
);
253 static void mon_text_submit(void *data
, struct urb
*urb
)
255 struct mon_reader_text
*rp
= data
;
256 mon_text_event(rp
, urb
, 'S', -EINPROGRESS
);
259 static void mon_text_complete(void *data
, struct urb
*urb
, int status
)
261 struct mon_reader_text
*rp
= data
;
262 mon_text_event(rp
, urb
, 'C', status
);
265 static void mon_text_error(void *data
, struct urb
*urb
, int error
)
267 struct mon_reader_text
*rp
= data
;
268 struct mon_event_text
*ep
;
270 if (rp
->nevents
>= EVENT_MAX
||
271 (ep
= kmem_cache_alloc(rp
->e_slab
, GFP_ATOMIC
)) == NULL
) {
272 rp
->r
.m_bus
->cnt_text_lost
++;
277 ep
->id
= (unsigned long) urb
;
278 ep
->busnum
= urb
->dev
->bus
->busnum
;
279 ep
->devnum
= urb
->dev
->devnum
;
280 ep
->epnum
= usb_endpoint_num(&urb
->ep
->desc
);
281 ep
->xfertype
= usb_endpoint_type(&urb
->ep
->desc
);
282 ep
->is_in
= usb_urb_dir_in(urb
);
283 ep
->tstamp
= mon_get_timestamp();
287 ep
->setup_flag
= '-';
291 list_add_tail(&ep
->e_link
, &rp
->e_list
);
296 * Fetch next event from the circular buffer.
298 static struct mon_event_text
*mon_text_fetch(struct mon_reader_text
*rp
,
299 struct mon_bus
*mbus
)
304 spin_lock_irqsave(&mbus
->lock
, flags
);
305 if (list_empty(&rp
->e_list
)) {
306 spin_unlock_irqrestore(&mbus
->lock
, flags
);
312 spin_unlock_irqrestore(&mbus
->lock
, flags
);
313 return list_entry(p
, struct mon_event_text
, e_link
);
318 static int mon_text_open(struct inode
*inode
, struct file
*file
)
320 struct mon_bus
*mbus
;
321 struct mon_reader_text
*rp
;
324 mutex_lock(&mon_lock
);
325 mbus
= inode
->i_private
;
327 rp
= kzalloc(sizeof(struct mon_reader_text
), GFP_KERNEL
);
332 INIT_LIST_HEAD(&rp
->e_list
);
333 init_waitqueue_head(&rp
->wait
);
334 mutex_init(&rp
->printf_lock
);
336 rp
->printf_size
= PRINTF_DFL
;
337 rp
->printf_buf
= kmalloc(rp
->printf_size
, GFP_KERNEL
);
338 if (rp
->printf_buf
== NULL
) {
345 rp
->r
.rnf_submit
= mon_text_submit
;
346 rp
->r
.rnf_error
= mon_text_error
;
347 rp
->r
.rnf_complete
= mon_text_complete
;
349 snprintf(rp
->slab_name
, SLAB_NAME_SZ
, "mon_text_%p", rp
);
350 rp
->e_slab
= kmem_cache_create(rp
->slab_name
,
351 sizeof(struct mon_event_text
), sizeof(long), 0,
353 if (rp
->e_slab
== NULL
) {
358 mon_reader_add(mbus
, &rp
->r
);
360 file
->private_data
= rp
;
361 mutex_unlock(&mon_lock
);
365 // kmem_cache_destroy(rp->e_slab);
367 kfree(rp
->printf_buf
);
371 mutex_unlock(&mon_lock
);
376 * For simplicity, we read one record in one system call and throw out
377 * what does not fit. This means that the following does not work:
378 * dd if=/dbg/usbmon/0t bs=10
379 * Also, we do not allow seeks and do not bother advancing the offset.
381 static ssize_t
mon_text_read_t(struct file
*file
, char __user
*buf
,
382 size_t nbytes
, loff_t
*ppos
)
384 struct mon_reader_text
*rp
= file
->private_data
;
385 struct mon_event_text
*ep
;
386 struct mon_text_ptr ptr
;
388 if (IS_ERR(ep
= mon_text_read_wait(rp
, file
)))
390 mutex_lock(&rp
->printf_lock
);
392 ptr
.pbuf
= rp
->printf_buf
;
393 ptr
.limit
= rp
->printf_size
;
395 mon_text_read_head_t(rp
, &ptr
, ep
);
396 mon_text_read_statset(rp
, &ptr
, ep
);
397 ptr
.cnt
+= snprintf(ptr
.pbuf
+ ptr
.cnt
, ptr
.limit
- ptr
.cnt
,
399 mon_text_read_data(rp
, &ptr
, ep
);
401 if (copy_to_user(buf
, rp
->printf_buf
, ptr
.cnt
))
403 mutex_unlock(&rp
->printf_lock
);
404 kmem_cache_free(rp
->e_slab
, ep
);
408 static ssize_t
mon_text_read_u(struct file
*file
, char __user
*buf
,
409 size_t nbytes
, loff_t
*ppos
)
411 struct mon_reader_text
*rp
= file
->private_data
;
412 struct mon_event_text
*ep
;
413 struct mon_text_ptr ptr
;
415 if (IS_ERR(ep
= mon_text_read_wait(rp
, file
)))
417 mutex_lock(&rp
->printf_lock
);
419 ptr
.pbuf
= rp
->printf_buf
;
420 ptr
.limit
= rp
->printf_size
;
422 mon_text_read_head_u(rp
, &ptr
, ep
);
423 if (ep
->type
== 'E') {
424 mon_text_read_statset(rp
, &ptr
, ep
);
425 } else if (ep
->xfertype
== USB_ENDPOINT_XFER_ISOC
) {
426 mon_text_read_isostat(rp
, &ptr
, ep
);
427 mon_text_read_isodesc(rp
, &ptr
, ep
);
428 } else if (ep
->xfertype
== USB_ENDPOINT_XFER_INT
) {
429 mon_text_read_intstat(rp
, &ptr
, ep
);
431 mon_text_read_statset(rp
, &ptr
, ep
);
433 ptr
.cnt
+= snprintf(ptr
.pbuf
+ ptr
.cnt
, ptr
.limit
- ptr
.cnt
,
435 mon_text_read_data(rp
, &ptr
, ep
);
437 if (copy_to_user(buf
, rp
->printf_buf
, ptr
.cnt
))
439 mutex_unlock(&rp
->printf_lock
);
440 kmem_cache_free(rp
->e_slab
, ep
);
444 static struct mon_event_text
*mon_text_read_wait(struct mon_reader_text
*rp
,
447 struct mon_bus
*mbus
= rp
->r
.m_bus
;
448 DECLARE_WAITQUEUE(waita
, current
);
449 struct mon_event_text
*ep
;
451 add_wait_queue(&rp
->wait
, &waita
);
452 set_current_state(TASK_INTERRUPTIBLE
);
453 while ((ep
= mon_text_fetch(rp
, mbus
)) == NULL
) {
454 if (file
->f_flags
& O_NONBLOCK
) {
455 set_current_state(TASK_RUNNING
);
456 remove_wait_queue(&rp
->wait
, &waita
);
457 return ERR_PTR(-EWOULDBLOCK
);
460 * We do not count nwaiters, because ->release is supposed
461 * to be called when all openers are gone only.
464 if (signal_pending(current
)) {
465 remove_wait_queue(&rp
->wait
, &waita
);
466 return ERR_PTR(-EINTR
);
468 set_current_state(TASK_INTERRUPTIBLE
);
470 set_current_state(TASK_RUNNING
);
471 remove_wait_queue(&rp
->wait
, &waita
);
475 static void mon_text_read_head_t(struct mon_reader_text
*rp
,
476 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
)
480 udir
= (ep
->is_in
? 'i' : 'o');
481 switch (ep
->xfertype
) {
482 case USB_ENDPOINT_XFER_ISOC
: utype
= 'Z'; break;
483 case USB_ENDPOINT_XFER_INT
: utype
= 'I'; break;
484 case USB_ENDPOINT_XFER_CONTROL
: utype
= 'C'; break;
485 default: /* PIPE_BULK */ utype
= 'B';
487 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
488 "%lx %u %c %c%c:%03u:%02u",
489 ep
->id
, ep
->tstamp
, ep
->type
,
490 utype
, udir
, ep
->devnum
, ep
->epnum
);
493 static void mon_text_read_head_u(struct mon_reader_text
*rp
,
494 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
)
498 udir
= (ep
->is_in
? 'i' : 'o');
499 switch (ep
->xfertype
) {
500 case USB_ENDPOINT_XFER_ISOC
: utype
= 'Z'; break;
501 case USB_ENDPOINT_XFER_INT
: utype
= 'I'; break;
502 case USB_ENDPOINT_XFER_CONTROL
: utype
= 'C'; break;
503 default: /* PIPE_BULK */ utype
= 'B';
505 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
506 "%lx %u %c %c%c:%d:%03u:%u",
507 ep
->id
, ep
->tstamp
, ep
->type
,
508 utype
, udir
, ep
->busnum
, ep
->devnum
, ep
->epnum
);
511 static void mon_text_read_statset(struct mon_reader_text
*rp
,
512 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
)
515 if (ep
->setup_flag
== 0) { /* Setup packet is present and captured */
516 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
517 " s %02x %02x %04x %04x %04x",
520 (ep
->setup
[3] << 8) | ep
->setup
[2],
521 (ep
->setup
[5] << 8) | ep
->setup
[4],
522 (ep
->setup
[7] << 8) | ep
->setup
[6]);
523 } else if (ep
->setup_flag
!= '-') { /* Unable to capture setup packet */
524 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
525 " %c __ __ ____ ____ ____", ep
->setup_flag
);
526 } else { /* No setup for this kind of URB */
527 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
532 static void mon_text_read_intstat(struct mon_reader_text
*rp
,
533 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
)
535 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
536 " %d:%d", ep
->status
, ep
->interval
);
539 static void mon_text_read_isostat(struct mon_reader_text
*rp
,
540 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
)
542 if (ep
->type
== 'S') {
543 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
544 " %d:%d:%d", ep
->status
, ep
->interval
, ep
->start_frame
);
546 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
548 ep
->status
, ep
->interval
, ep
->start_frame
, ep
->error_count
);
552 static void mon_text_read_isodesc(struct mon_reader_text
*rp
,
553 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
)
555 int ndesc
; /* Display this many */
557 const struct mon_iso_desc
*dp
;
559 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
562 if (ndesc
> ISODESC_MAX
)
567 for (i
= 0; i
< ndesc
; i
++) {
568 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
569 " %d:%u:%u", dp
->status
, dp
->offset
, dp
->length
);
574 static void mon_text_read_data(struct mon_reader_text
*rp
,
575 struct mon_text_ptr
*p
, const struct mon_event_text
*ep
)
579 if ((data_len
= ep
->length
) > 0) {
580 if (ep
->data_flag
== 0) {
581 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
583 if (data_len
>= DATA_MAX
)
585 for (i
= 0; i
< data_len
; i
++) {
587 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
,
591 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
,
593 "%02x", ep
->data
[i
]);
595 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
598 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
,
599 " %c\n", ep
->data_flag
);
602 p
->cnt
+= snprintf(p
->pbuf
+ p
->cnt
, p
->limit
- p
->cnt
, "\n");
606 static int mon_text_release(struct inode
*inode
, struct file
*file
)
608 struct mon_reader_text
*rp
= file
->private_data
;
609 struct mon_bus
*mbus
;
610 /* unsigned long flags; */
612 struct mon_event_text
*ep
;
614 mutex_lock(&mon_lock
);
615 mbus
= inode
->i_private
;
617 if (mbus
->nreaders
<= 0) {
618 printk(KERN_ERR TAG
": consistency error on close\n");
619 mutex_unlock(&mon_lock
);
622 mon_reader_del(mbus
, &rp
->r
);
625 * In theory, e_list is protected by mbus->lock. However,
626 * after mon_reader_del has finished, the following is the case:
627 * - we are not on reader list anymore, so new events won't be added;
628 * - whole mbus may be dropped if it was orphaned.
629 * So, we better not touch mbus.
631 /* spin_lock_irqsave(&mbus->lock, flags); */
632 while (!list_empty(&rp
->e_list
)) {
634 ep
= list_entry(p
, struct mon_event_text
, e_link
);
637 kmem_cache_free(rp
->e_slab
, ep
);
639 /* spin_unlock_irqrestore(&mbus->lock, flags); */
641 kmem_cache_destroy(rp
->e_slab
);
642 kfree(rp
->printf_buf
);
645 mutex_unlock(&mon_lock
);
649 static const struct file_operations mon_fops_text_t
= {
650 .owner
= THIS_MODULE
,
651 .open
= mon_text_open
,
653 .read
= mon_text_read_t
,
654 .release
= mon_text_release
,
657 static const struct file_operations mon_fops_text_u
= {
658 .owner
= THIS_MODULE
,
659 .open
= mon_text_open
,
661 .read
= mon_text_read_u
,
662 .release
= mon_text_release
,
665 int mon_text_add(struct mon_bus
*mbus
, const struct usb_bus
*ubus
)
668 enum { NAMESZ
= 10 };
670 int busnum
= ubus
? ubus
->busnum
: 0;
674 rc
= snprintf(name
, NAMESZ
, "%dt", busnum
);
675 if (rc
<= 0 || rc
>= NAMESZ
)
677 d
= debugfs_create_file(name
, 0600, mon_dir
, mbus
,
684 rc
= snprintf(name
, NAMESZ
, "%du", busnum
);
685 if (rc
<= 0 || rc
>= NAMESZ
)
687 d
= debugfs_create_file(name
, 0600, mon_dir
, mbus
, &mon_fops_text_u
);
692 rc
= snprintf(name
, NAMESZ
, "%ds", busnum
);
693 if (rc
<= 0 || rc
>= NAMESZ
)
695 d
= debugfs_create_file(name
, 0600, mon_dir
, mbus
, &mon_fops_stat
);
704 debugfs_remove(mbus
->dent_u
);
709 debugfs_remove(mbus
->dent_t
);
717 void mon_text_del(struct mon_bus
*mbus
)
719 debugfs_remove(mbus
->dent_u
);
720 if (mbus
->dent_t
!= NULL
)
721 debugfs_remove(mbus
->dent_t
);
722 debugfs_remove(mbus
->dent_s
);
726 * Slab interface: constructor.
728 static void mon_text_ctor(void *mem
)
731 * Nothing to initialize. No, really!
732 * So, we fill it with garbage to emulate a reused object.
734 memset(mem
, 0xe5, sizeof(struct mon_event_text
));
737 int __init
mon_text_init(void)
739 struct dentry
*mondir
;
741 mondir
= debugfs_create_dir("usbmon", usb_debug_root
);
742 if (IS_ERR(mondir
)) {
743 printk(KERN_NOTICE TAG
": debugfs is not available\n");
746 if (mondir
== NULL
) {
747 printk(KERN_NOTICE TAG
": unable to create usbmon directory\n");
754 void mon_text_exit(void)
756 debugfs_remove(mon_dir
);