2 * The USB Monitor, inspired by Dave Harding's USBMon.
4 * This is a binary format reader.
6 * Copyright (C) 2006 Paolo Abeni (paolo.abeni@email.it)
7 * Copyright (C) 2006,2007 Pete Zaitcev (zaitcev@redhat.com)
10 #include <linux/kernel.h>
11 #include <linux/types.h>
13 #include <linux/cdev.h>
14 #include <linux/usb.h>
15 #include <linux/poll.h>
16 #include <linux/compat.h>
18 #include <linux/smp_lock.h>
20 #include <asm/uaccess.h>
25 * Defined by USB 2.0 clause 9.3, table 9.2.
30 #define MON_IOC_MAGIC 0x92
32 #define MON_IOCQ_URB_LEN _IO(MON_IOC_MAGIC, 1)
33 /* #2 used to be MON_IOCX_URB, removed before it got into Linus tree */
34 #define MON_IOCG_STATS _IOR(MON_IOC_MAGIC, 3, struct mon_bin_stats)
35 #define MON_IOCT_RING_SIZE _IO(MON_IOC_MAGIC, 4)
36 #define MON_IOCQ_RING_SIZE _IO(MON_IOC_MAGIC, 5)
37 #define MON_IOCX_GET _IOW(MON_IOC_MAGIC, 6, struct mon_bin_get)
38 #define MON_IOCX_MFETCH _IOWR(MON_IOC_MAGIC, 7, struct mon_bin_mfetch)
39 #define MON_IOCH_MFLUSH _IO(MON_IOC_MAGIC, 8)
41 #define MON_IOCX_GET32 _IOW(MON_IOC_MAGIC, 6, struct mon_bin_get32)
42 #define MON_IOCX_MFETCH32 _IOWR(MON_IOC_MAGIC, 7, struct mon_bin_mfetch32)
46 * Some architectures have enormous basic pages (16KB for ia64, 64KB for ppc).
47 * But it's all right. Just use a simple way to make sure the chunk is never
48 * smaller than a page.
50 * N.B. An application does not know our chunk size.
52 * Woops, get_zeroed_page() returns a single page. I guess we're stuck with
53 * page-sized chunks for the time being.
55 #define CHUNK_SIZE PAGE_SIZE
56 #define CHUNK_ALIGN(x) (((x)+CHUNK_SIZE-1) & ~(CHUNK_SIZE-1))
59 * The magic limit was calculated so that it allows the monitoring
60 * application to pick data once in two ticks. This way, another application,
61 * which presumably drives the bus, gets to hog CPU, yet we collect our data.
62 * If HZ is 100, a 480 mbit/s bus drives 614 KB every jiffy. USB has an
63 * enormous overhead built into the bus protocol, so we need about 1000 KB.
65 * This is still too much for most cases, where we just snoop a few
66 * descriptor fetches for enumeration. So, the default is a "reasonable"
67 * amount for systems with HZ=250 and incomplete bus saturation.
69 * XXX What about multi-megabyte URBs which take minutes to transfer?
71 #define BUFF_MAX CHUNK_ALIGN(1200*1024)
72 #define BUFF_DFL CHUNK_ALIGN(300*1024)
73 #define BUFF_MIN CHUNK_ALIGN(8*1024)
76 * The per-event API header (2 per URB).
78 * This structure is seen in userland as defined by the documentation.
81 u64 id
; /* URB ID - from submission to callback */
82 unsigned char type
; /* Same as in text API; extensible. */
83 unsigned char xfer_type
; /* ISO, Intr, Control, Bulk */
84 unsigned char epnum
; /* Endpoint number and transfer direction */
85 unsigned char devnum
; /* Device address */
86 unsigned short busnum
; /* Bus number */
89 s64 ts_sec
; /* gettimeofday */
90 s32 ts_usec
; /* gettimeofday */
92 unsigned int len_urb
; /* Length of data (submitted or actual) */
93 unsigned int len_cap
; /* Delivered length */
94 unsigned char setup
[SETUP_LEN
]; /* Only for Control S-type */
97 /* per file statistic */
98 struct mon_bin_stats
{
104 struct mon_bin_hdr __user
*hdr
; /* Only 48 bytes, not 64. */
106 size_t alloc
; /* Length of data (can be zero) */
109 struct mon_bin_mfetch
{
110 u32 __user
*offvec
; /* Vector of events fetched */
111 u32 nfetch
; /* Number of events to fetch (out: fetched) */
112 u32 nflush
; /* Number of events to flush */
116 struct mon_bin_get32
{
122 struct mon_bin_mfetch32
{
129 /* Having these two values same prevents wrapping of the mon_bin_hdr */
133 /* max number of USB bus supported */
134 #define MON_BIN_MAX_MINOR 128
137 * The buffer: map of used pages.
141 unsigned char *ptr
; /* XXX just use page_to_virt everywhere? */
145 * This gets associated with an open file struct.
147 struct mon_reader_bin
{
148 /* The buffer: one per open. */
149 spinlock_t b_lock
; /* Protect b_cnt, b_in */
150 unsigned int b_size
; /* Current size of the buffer - bytes */
151 unsigned int b_cnt
; /* Bytes used */
152 unsigned int b_in
, b_out
; /* Offsets into buffer - bytes */
153 unsigned int b_read
; /* Amount of read data in curr. pkt. */
154 struct mon_pgmap
*b_vec
; /* The map array */
155 wait_queue_head_t b_wait
; /* Wait for data here */
157 struct mutex fetch_lock
; /* Protect b_read, b_out */
160 /* A list of these is needed for "bus 0". Some time later. */
164 unsigned int cnt_lost
;
167 static inline struct mon_bin_hdr
*MON_OFF2HDR(const struct mon_reader_bin
*rp
,
170 return (struct mon_bin_hdr
*)
171 (rp
->b_vec
[offset
/ CHUNK_SIZE
].ptr
+ offset
% CHUNK_SIZE
);
174 #define MON_RING_EMPTY(rp) ((rp)->b_cnt == 0)
176 static unsigned char xfer_to_pipe
[4] = {
177 PIPE_CONTROL
, PIPE_ISOCHRONOUS
, PIPE_BULK
, PIPE_INTERRUPT
180 static struct class *mon_bin_class
;
181 static dev_t mon_bin_dev0
;
182 static struct cdev mon_bin_cdev
;
184 static void mon_buff_area_fill(const struct mon_reader_bin
*rp
,
185 unsigned int offset
, unsigned int size
);
186 static int mon_bin_wait_event(struct file
*file
, struct mon_reader_bin
*rp
);
187 static int mon_alloc_buff(struct mon_pgmap
*map
, int npages
);
188 static void mon_free_buff(struct mon_pgmap
*map
, int npages
);
191 * This is a "chunked memcpy". It does not manipulate any counters.
192 * But it returns the new offset for repeated application.
194 unsigned int mon_copy_to_buff(const struct mon_reader_bin
*this,
195 unsigned int off
, const unsigned char *from
, unsigned int length
)
197 unsigned int step_len
;
199 unsigned int in_page
;
203 * Determine step_len.
206 in_page
= CHUNK_SIZE
- (off
& (CHUNK_SIZE
-1));
207 if (in_page
< step_len
)
211 * Copy data and advance pointers.
213 buf
= this->b_vec
[off
/ CHUNK_SIZE
].ptr
+ off
% CHUNK_SIZE
;
214 memcpy(buf
, from
, step_len
);
215 if ((off
+= step_len
) >= this->b_size
) off
= 0;
223 * This is a little worse than the above because it's "chunked copy_to_user".
224 * The return value is an error code, not an offset.
226 static int copy_from_buf(const struct mon_reader_bin
*this, unsigned int off
,
227 char __user
*to
, int length
)
229 unsigned int step_len
;
231 unsigned int in_page
;
235 * Determine step_len.
238 in_page
= CHUNK_SIZE
- (off
& (CHUNK_SIZE
-1));
239 if (in_page
< step_len
)
243 * Copy data and advance pointers.
245 buf
= this->b_vec
[off
/ CHUNK_SIZE
].ptr
+ off
% CHUNK_SIZE
;
246 if (copy_to_user(to
, buf
, step_len
))
248 if ((off
+= step_len
) >= this->b_size
) off
= 0;
256 * Allocate an (aligned) area in the buffer.
257 * This is called under b_lock.
258 * Returns ~0 on failure.
260 static unsigned int mon_buff_area_alloc(struct mon_reader_bin
*rp
,
265 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
266 if (rp
->b_cnt
+ size
> rp
->b_size
)
270 if ((rp
->b_in
+= size
) >= rp
->b_size
)
271 rp
->b_in
-= rp
->b_size
;
276 * This is the same thing as mon_buff_area_alloc, only it does not allow
277 * buffers to wrap. This is needed by applications which pass references
278 * into mmap-ed buffers up their stacks (libpcap can do that).
280 * Currently, we always have the header stuck with the data, although
281 * it is not strictly speaking necessary.
283 * When a buffer would wrap, we place a filler packet to mark the space.
285 static unsigned int mon_buff_area_alloc_contiguous(struct mon_reader_bin
*rp
,
289 unsigned int fill_size
;
291 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
292 if (rp
->b_cnt
+ size
> rp
->b_size
)
294 if (rp
->b_in
+ size
> rp
->b_size
) {
296 * This would wrap. Find if we still have space after
297 * skipping to the end of the buffer. If we do, place
298 * a filler packet and allocate a new packet.
300 fill_size
= rp
->b_size
- rp
->b_in
;
301 if (rp
->b_cnt
+ size
+ fill_size
> rp
->b_size
)
303 mon_buff_area_fill(rp
, rp
->b_in
, fill_size
);
307 rp
->b_cnt
+= size
+ fill_size
;
308 } else if (rp
->b_in
+ size
== rp
->b_size
) {
321 * Return a few (kilo-)bytes to the head of the buffer.
322 * This is used if a DMA fetch fails.
324 static void mon_buff_area_shrink(struct mon_reader_bin
*rp
, unsigned int size
)
327 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
330 rp
->b_in
+= rp
->b_size
;
335 * This has to be called under both b_lock and fetch_lock, because
336 * it accesses both b_cnt and b_out.
338 static void mon_buff_area_free(struct mon_reader_bin
*rp
, unsigned int size
)
341 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
343 if ((rp
->b_out
+= size
) >= rp
->b_size
)
344 rp
->b_out
-= rp
->b_size
;
347 static void mon_buff_area_fill(const struct mon_reader_bin
*rp
,
348 unsigned int offset
, unsigned int size
)
350 struct mon_bin_hdr
*ep
;
352 ep
= MON_OFF2HDR(rp
, offset
);
353 memset(ep
, 0, PKT_SIZE
);
355 ep
->len_cap
= size
- PKT_SIZE
;
358 static inline char mon_bin_get_setup(unsigned char *setupb
,
359 const struct urb
*urb
, char ev_type
)
362 if (!usb_endpoint_xfer_control(&urb
->ep
->desc
) || ev_type
!= 'S')
365 if (urb
->setup_packet
== NULL
)
368 memcpy(setupb
, urb
->setup_packet
, SETUP_LEN
);
372 static char mon_bin_get_data(const struct mon_reader_bin
*rp
,
373 unsigned int offset
, struct urb
*urb
, unsigned int length
)
376 if (urb
->dev
->bus
->uses_dma
&&
377 (urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
)) {
378 mon_dmapeek_vec(rp
, offset
, urb
->transfer_dma
, length
);
382 if (urb
->transfer_buffer
== NULL
)
385 mon_copy_to_buff(rp
, offset
, urb
->transfer_buffer
, length
);
389 static void mon_bin_event(struct mon_reader_bin
*rp
, struct urb
*urb
,
390 char ev_type
, int status
)
392 const struct usb_endpoint_descriptor
*epd
= &urb
->ep
->desc
;
395 unsigned int urb_length
;
399 struct mon_bin_hdr
*ep
;
402 do_gettimeofday(&ts
);
404 spin_lock_irqsave(&rp
->b_lock
, flags
);
407 * Find the maximum allowable length, then allocate space.
409 urb_length
= (ev_type
== 'S') ?
410 urb
->transfer_buffer_length
: urb
->actual_length
;
413 if (length
>= rp
->b_size
/5)
414 length
= rp
->b_size
/5;
416 if (usb_urb_dir_in(urb
)) {
417 if (ev_type
== 'S') {
421 /* Cannot rely on endpoint number in case of control ep.0 */
424 if (ev_type
== 'C') {
432 offset
= mon_buff_area_alloc_contiguous(rp
, length
+ PKT_SIZE
);
434 offset
= mon_buff_area_alloc(rp
, length
+ PKT_SIZE
);
437 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
441 ep
= MON_OFF2HDR(rp
, offset
);
442 if ((offset
+= PKT_SIZE
) >= rp
->b_size
) offset
= 0;
445 * Fill the allocated area.
447 memset(ep
, 0, PKT_SIZE
);
449 ep
->xfer_type
= xfer_to_pipe
[usb_endpoint_type(epd
)];
450 ep
->epnum
= dir
| usb_endpoint_num(epd
);
451 ep
->devnum
= urb
->dev
->devnum
;
452 ep
->busnum
= urb
->dev
->bus
->busnum
;
453 ep
->id
= (unsigned long) urb
;
454 ep
->ts_sec
= ts
.tv_sec
;
455 ep
->ts_usec
= ts
.tv_usec
;
457 ep
->len_urb
= urb_length
;
458 ep
->len_cap
= length
;
460 ep
->flag_setup
= mon_bin_get_setup(ep
->setup
, urb
, ev_type
);
462 ep
->flag_data
= mon_bin_get_data(rp
, offset
, urb
, length
);
463 if (ep
->flag_data
!= 0) { /* Yes, it's 0x00, not '0' */
465 mon_buff_area_shrink(rp
, length
);
468 ep
->flag_data
= data_tag
;
471 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
473 wake_up(&rp
->b_wait
);
476 static void mon_bin_submit(void *data
, struct urb
*urb
)
478 struct mon_reader_bin
*rp
= data
;
479 mon_bin_event(rp
, urb
, 'S', -EINPROGRESS
);
482 static void mon_bin_complete(void *data
, struct urb
*urb
, int status
)
484 struct mon_reader_bin
*rp
= data
;
485 mon_bin_event(rp
, urb
, 'C', status
);
488 static void mon_bin_error(void *data
, struct urb
*urb
, int error
)
490 struct mon_reader_bin
*rp
= data
;
493 struct mon_bin_hdr
*ep
;
495 spin_lock_irqsave(&rp
->b_lock
, flags
);
497 offset
= mon_buff_area_alloc(rp
, PKT_SIZE
);
499 /* Not incrementing cnt_lost. Just because. */
500 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
504 ep
= MON_OFF2HDR(rp
, offset
);
506 memset(ep
, 0, PKT_SIZE
);
508 ep
->xfer_type
= xfer_to_pipe
[usb_endpoint_type(&urb
->ep
->desc
)];
509 ep
->epnum
= usb_urb_dir_in(urb
) ? USB_DIR_IN
: 0;
510 ep
->epnum
|= usb_endpoint_num(&urb
->ep
->desc
);
511 ep
->devnum
= urb
->dev
->devnum
;
512 ep
->busnum
= urb
->dev
->bus
->busnum
;
513 ep
->id
= (unsigned long) urb
;
516 ep
->flag_setup
= '-';
519 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
521 wake_up(&rp
->b_wait
);
524 static int mon_bin_open(struct inode
*inode
, struct file
*file
)
526 struct mon_bus
*mbus
;
527 struct mon_reader_bin
*rp
;
532 mutex_lock(&mon_lock
);
533 if ((mbus
= mon_bus_lookup(iminor(inode
))) == NULL
) {
534 mutex_unlock(&mon_lock
);
538 if (mbus
!= &mon_bus0
&& mbus
->u_bus
== NULL
) {
539 printk(KERN_ERR TAG
": consistency error on open\n");
540 mutex_unlock(&mon_lock
);
545 rp
= kzalloc(sizeof(struct mon_reader_bin
), GFP_KERNEL
);
550 spin_lock_init(&rp
->b_lock
);
551 init_waitqueue_head(&rp
->b_wait
);
552 mutex_init(&rp
->fetch_lock
);
554 rp
->b_size
= BUFF_DFL
;
556 size
= sizeof(struct mon_pgmap
) * (rp
->b_size
/CHUNK_SIZE
);
557 if ((rp
->b_vec
= kzalloc(size
, GFP_KERNEL
)) == NULL
) {
562 if ((rc
= mon_alloc_buff(rp
->b_vec
, rp
->b_size
/CHUNK_SIZE
)) < 0)
567 rp
->r
.rnf_submit
= mon_bin_submit
;
568 rp
->r
.rnf_error
= mon_bin_error
;
569 rp
->r
.rnf_complete
= mon_bin_complete
;
571 mon_reader_add(mbus
, &rp
->r
);
573 file
->private_data
= rp
;
574 mutex_unlock(&mon_lock
);
583 mutex_unlock(&mon_lock
);
589 * Extract an event from buffer and copy it to user space.
590 * Wait if there is no event ready.
591 * Returns zero or error.
593 static int mon_bin_get_event(struct file
*file
, struct mon_reader_bin
*rp
,
594 struct mon_bin_hdr __user
*hdr
, void __user
*data
, unsigned int nbytes
)
597 struct mon_bin_hdr
*ep
;
602 mutex_lock(&rp
->fetch_lock
);
604 if ((rc
= mon_bin_wait_event(file
, rp
)) < 0) {
605 mutex_unlock(&rp
->fetch_lock
);
609 ep
= MON_OFF2HDR(rp
, rp
->b_out
);
611 if (copy_to_user(hdr
, ep
, sizeof(struct mon_bin_hdr
))) {
612 mutex_unlock(&rp
->fetch_lock
);
616 step_len
= min(ep
->len_cap
, nbytes
);
617 if ((offset
= rp
->b_out
+ PKT_SIZE
) >= rp
->b_size
) offset
= 0;
619 if (copy_from_buf(rp
, offset
, data
, step_len
)) {
620 mutex_unlock(&rp
->fetch_lock
);
624 spin_lock_irqsave(&rp
->b_lock
, flags
);
625 mon_buff_area_free(rp
, PKT_SIZE
+ ep
->len_cap
);
626 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
629 mutex_unlock(&rp
->fetch_lock
);
633 static int mon_bin_release(struct inode
*inode
, struct file
*file
)
635 struct mon_reader_bin
*rp
= file
->private_data
;
636 struct mon_bus
* mbus
= rp
->r
.m_bus
;
638 mutex_lock(&mon_lock
);
640 if (mbus
->nreaders
<= 0) {
641 printk(KERN_ERR TAG
": consistency error on close\n");
642 mutex_unlock(&mon_lock
);
645 mon_reader_del(mbus
, &rp
->r
);
647 mon_free_buff(rp
->b_vec
, rp
->b_size
/CHUNK_SIZE
);
651 mutex_unlock(&mon_lock
);
655 static ssize_t
mon_bin_read(struct file
*file
, char __user
*buf
,
656 size_t nbytes
, loff_t
*ppos
)
658 struct mon_reader_bin
*rp
= file
->private_data
;
660 struct mon_bin_hdr
*ep
;
667 mutex_lock(&rp
->fetch_lock
);
669 if ((rc
= mon_bin_wait_event(file
, rp
)) < 0) {
670 mutex_unlock(&rp
->fetch_lock
);
674 ep
= MON_OFF2HDR(rp
, rp
->b_out
);
676 if (rp
->b_read
< sizeof(struct mon_bin_hdr
)) {
677 step_len
= min(nbytes
, sizeof(struct mon_bin_hdr
) - rp
->b_read
);
678 ptr
= ((char *)ep
) + rp
->b_read
;
679 if (step_len
&& copy_to_user(buf
, ptr
, step_len
)) {
680 mutex_unlock(&rp
->fetch_lock
);
685 rp
->b_read
+= step_len
;
689 if (rp
->b_read
>= sizeof(struct mon_bin_hdr
)) {
690 step_len
= min(nbytes
, (size_t)ep
->len_cap
);
691 offset
= rp
->b_out
+ PKT_SIZE
;
692 offset
+= rp
->b_read
- sizeof(struct mon_bin_hdr
);
693 if (offset
>= rp
->b_size
)
694 offset
-= rp
->b_size
;
695 if (copy_from_buf(rp
, offset
, buf
, step_len
)) {
696 mutex_unlock(&rp
->fetch_lock
);
701 rp
->b_read
+= step_len
;
706 * Check if whole packet was read, and if so, jump to the next one.
708 if (rp
->b_read
>= sizeof(struct mon_bin_hdr
) + ep
->len_cap
) {
709 spin_lock_irqsave(&rp
->b_lock
, flags
);
710 mon_buff_area_free(rp
, PKT_SIZE
+ ep
->len_cap
);
711 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
715 mutex_unlock(&rp
->fetch_lock
);
720 * Remove at most nevents from chunked buffer.
721 * Returns the number of removed events.
723 static int mon_bin_flush(struct mon_reader_bin
*rp
, unsigned nevents
)
726 struct mon_bin_hdr
*ep
;
729 mutex_lock(&rp
->fetch_lock
);
730 spin_lock_irqsave(&rp
->b_lock
, flags
);
731 for (i
= 0; i
< nevents
; ++i
) {
732 if (MON_RING_EMPTY(rp
))
735 ep
= MON_OFF2HDR(rp
, rp
->b_out
);
736 mon_buff_area_free(rp
, PKT_SIZE
+ ep
->len_cap
);
738 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
740 mutex_unlock(&rp
->fetch_lock
);
745 * Fetch at most max event offsets into the buffer and put them into vec.
746 * The events are usually freed later with mon_bin_flush.
747 * Return the effective number of events fetched.
749 static int mon_bin_fetch(struct file
*file
, struct mon_reader_bin
*rp
,
750 u32 __user
*vec
, unsigned int max
)
752 unsigned int cur_out
;
753 unsigned int bytes
, avail
;
755 unsigned int nevents
;
756 struct mon_bin_hdr
*ep
;
760 mutex_lock(&rp
->fetch_lock
);
762 if ((rc
= mon_bin_wait_event(file
, rp
)) < 0) {
763 mutex_unlock(&rp
->fetch_lock
);
767 spin_lock_irqsave(&rp
->b_lock
, flags
);
769 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
774 while (bytes
< avail
) {
778 ep
= MON_OFF2HDR(rp
, cur_out
);
779 if (put_user(cur_out
, &vec
[nevents
])) {
780 mutex_unlock(&rp
->fetch_lock
);
785 size
= ep
->len_cap
+ PKT_SIZE
;
786 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
787 if ((cur_out
+= size
) >= rp
->b_size
)
788 cur_out
-= rp
->b_size
;
792 mutex_unlock(&rp
->fetch_lock
);
797 * Count events. This is almost the same as the above mon_bin_fetch,
798 * only we do not store offsets into user vector, and we have no limit.
800 static int mon_bin_queued(struct mon_reader_bin
*rp
)
802 unsigned int cur_out
;
803 unsigned int bytes
, avail
;
805 unsigned int nevents
;
806 struct mon_bin_hdr
*ep
;
809 mutex_lock(&rp
->fetch_lock
);
811 spin_lock_irqsave(&rp
->b_lock
, flags
);
813 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
818 while (bytes
< avail
) {
819 ep
= MON_OFF2HDR(rp
, cur_out
);
822 size
= ep
->len_cap
+ PKT_SIZE
;
823 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
824 if ((cur_out
+= size
) >= rp
->b_size
)
825 cur_out
-= rp
->b_size
;
829 mutex_unlock(&rp
->fetch_lock
);
835 static int mon_bin_ioctl(struct inode
*inode
, struct file
*file
,
836 unsigned int cmd
, unsigned long arg
)
838 struct mon_reader_bin
*rp
= file
->private_data
;
839 // struct mon_bus* mbus = rp->r.m_bus;
841 struct mon_bin_hdr
*ep
;
846 case MON_IOCQ_URB_LEN
:
848 * N.B. This only returns the size of data, without the header.
850 spin_lock_irqsave(&rp
->b_lock
, flags
);
851 if (!MON_RING_EMPTY(rp
)) {
852 ep
= MON_OFF2HDR(rp
, rp
->b_out
);
855 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
858 case MON_IOCQ_RING_SIZE
:
862 case MON_IOCT_RING_SIZE
:
864 * Changing the buffer size will flush it's contents; the new
865 * buffer is allocated before releasing the old one to be sure
866 * the device will stay functional also in case of memory
871 struct mon_pgmap
*vec
;
873 if (arg
< BUFF_MIN
|| arg
> BUFF_MAX
)
876 size
= CHUNK_ALIGN(arg
);
877 if ((vec
= kzalloc(sizeof(struct mon_pgmap
) * (size
/CHUNK_SIZE
),
878 GFP_KERNEL
)) == NULL
) {
883 ret
= mon_alloc_buff(vec
, size
/CHUNK_SIZE
);
889 mutex_lock(&rp
->fetch_lock
);
890 spin_lock_irqsave(&rp
->b_lock
, flags
);
891 mon_free_buff(rp
->b_vec
, size
/CHUNK_SIZE
);
895 rp
->b_read
= rp
->b_in
= rp
->b_out
= rp
->b_cnt
= 0;
897 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
898 mutex_unlock(&rp
->fetch_lock
);
902 case MON_IOCH_MFLUSH
:
903 ret
= mon_bin_flush(rp
, arg
);
908 struct mon_bin_get getb
;
910 if (copy_from_user(&getb
, (void __user
*)arg
,
911 sizeof(struct mon_bin_get
)))
914 if (getb
.alloc
> 0x10000000) /* Want to cast to u32 */
916 ret
= mon_bin_get_event(file
, rp
,
917 getb
.hdr
, getb
.data
, (unsigned int)getb
.alloc
);
922 case MON_IOCX_GET32
: {
923 struct mon_bin_get32 getb
;
925 if (copy_from_user(&getb
, (void __user
*)arg
,
926 sizeof(struct mon_bin_get32
)))
929 ret
= mon_bin_get_event(file
, rp
,
930 compat_ptr(getb
.hdr32
), compat_ptr(getb
.data32
),
936 case MON_IOCX_MFETCH
:
938 struct mon_bin_mfetch mfetch
;
939 struct mon_bin_mfetch __user
*uptr
;
941 uptr
= (struct mon_bin_mfetch __user
*)arg
;
943 if (copy_from_user(&mfetch
, uptr
, sizeof(mfetch
)))
947 ret
= mon_bin_flush(rp
, mfetch
.nflush
);
950 if (put_user(ret
, &uptr
->nflush
))
953 ret
= mon_bin_fetch(file
, rp
, mfetch
.offvec
, mfetch
.nfetch
);
956 if (put_user(ret
, &uptr
->nfetch
))
963 case MON_IOCX_MFETCH32
:
965 struct mon_bin_mfetch32 mfetch
;
966 struct mon_bin_mfetch32 __user
*uptr
;
968 uptr
= (struct mon_bin_mfetch32 __user
*) compat_ptr(arg
);
970 if (copy_from_user(&mfetch
, uptr
, sizeof(mfetch
)))
973 if (mfetch
.nflush32
) {
974 ret
= mon_bin_flush(rp
, mfetch
.nflush32
);
977 if (put_user(ret
, &uptr
->nflush32
))
980 ret
= mon_bin_fetch(file
, rp
, compat_ptr(mfetch
.offvec32
),
984 if (put_user(ret
, &uptr
->nfetch32
))
991 case MON_IOCG_STATS
: {
992 struct mon_bin_stats __user
*sp
;
993 unsigned int nevents
;
994 unsigned int ndropped
;
996 spin_lock_irqsave(&rp
->b_lock
, flags
);
997 ndropped
= rp
->cnt_lost
;
999 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
1000 nevents
= mon_bin_queued(rp
);
1002 sp
= (struct mon_bin_stats __user
*)arg
;
1003 if (put_user(rp
->cnt_lost
, &sp
->dropped
))
1005 if (put_user(nevents
, &sp
->queued
))
1019 mon_bin_poll(struct file
*file
, struct poll_table_struct
*wait
)
1021 struct mon_reader_bin
*rp
= file
->private_data
;
1022 unsigned int mask
= 0;
1023 unsigned long flags
;
1025 if (file
->f_mode
& FMODE_READ
)
1026 poll_wait(file
, &rp
->b_wait
, wait
);
1028 spin_lock_irqsave(&rp
->b_lock
, flags
);
1029 if (!MON_RING_EMPTY(rp
))
1030 mask
|= POLLIN
| POLLRDNORM
; /* readable */
1031 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
1036 * open and close: just keep track of how many times the device is
1037 * mapped, to use the proper memory allocation function.
1039 static void mon_bin_vma_open(struct vm_area_struct
*vma
)
1041 struct mon_reader_bin
*rp
= vma
->vm_private_data
;
1045 static void mon_bin_vma_close(struct vm_area_struct
*vma
)
1047 struct mon_reader_bin
*rp
= vma
->vm_private_data
;
1052 * Map ring pages to user space.
1054 static int mon_bin_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
1056 struct mon_reader_bin
*rp
= vma
->vm_private_data
;
1057 unsigned long offset
, chunk_idx
;
1058 struct page
*pageptr
;
1060 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
1061 if (offset
>= rp
->b_size
)
1062 return VM_FAULT_SIGBUS
;
1063 chunk_idx
= offset
/ CHUNK_SIZE
;
1064 pageptr
= rp
->b_vec
[chunk_idx
].pg
;
1066 vmf
->page
= pageptr
;
1070 static struct vm_operations_struct mon_bin_vm_ops
= {
1071 .open
= mon_bin_vma_open
,
1072 .close
= mon_bin_vma_close
,
1073 .fault
= mon_bin_vma_fault
,
1076 static int mon_bin_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
1078 /* don't do anything here: "fault" will set up page table entries */
1079 vma
->vm_ops
= &mon_bin_vm_ops
;
1080 vma
->vm_flags
|= VM_RESERVED
;
1081 vma
->vm_private_data
= filp
->private_data
;
1082 mon_bin_vma_open(vma
);
1086 static const struct file_operations mon_fops_binary
= {
1087 .owner
= THIS_MODULE
,
1088 .open
= mon_bin_open
,
1089 .llseek
= no_llseek
,
1090 .read
= mon_bin_read
,
1091 /* .write = mon_text_write, */
1092 .poll
= mon_bin_poll
,
1093 .ioctl
= mon_bin_ioctl
,
1094 .release
= mon_bin_release
,
1095 .mmap
= mon_bin_mmap
,
1098 static int mon_bin_wait_event(struct file
*file
, struct mon_reader_bin
*rp
)
1100 DECLARE_WAITQUEUE(waita
, current
);
1101 unsigned long flags
;
1103 add_wait_queue(&rp
->b_wait
, &waita
);
1104 set_current_state(TASK_INTERRUPTIBLE
);
1106 spin_lock_irqsave(&rp
->b_lock
, flags
);
1107 while (MON_RING_EMPTY(rp
)) {
1108 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
1110 if (file
->f_flags
& O_NONBLOCK
) {
1111 set_current_state(TASK_RUNNING
);
1112 remove_wait_queue(&rp
->b_wait
, &waita
);
1113 return -EWOULDBLOCK
; /* Same as EAGAIN in Linux */
1116 if (signal_pending(current
)) {
1117 remove_wait_queue(&rp
->b_wait
, &waita
);
1120 set_current_state(TASK_INTERRUPTIBLE
);
1122 spin_lock_irqsave(&rp
->b_lock
, flags
);
1124 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
1126 set_current_state(TASK_RUNNING
);
1127 remove_wait_queue(&rp
->b_wait
, &waita
);
1131 static int mon_alloc_buff(struct mon_pgmap
*map
, int npages
)
1134 unsigned long vaddr
;
1136 for (n
= 0; n
< npages
; n
++) {
1137 vaddr
= get_zeroed_page(GFP_KERNEL
);
1140 free_page((unsigned long) map
[n
].ptr
);
1143 map
[n
].ptr
= (unsigned char *) vaddr
;
1144 map
[n
].pg
= virt_to_page(vaddr
);
1149 static void mon_free_buff(struct mon_pgmap
*map
, int npages
)
1153 for (n
= 0; n
< npages
; n
++)
1154 free_page((unsigned long) map
[n
].ptr
);
1157 int mon_bin_add(struct mon_bus
*mbus
, const struct usb_bus
*ubus
)
1160 unsigned minor
= ubus
? ubus
->busnum
: 0;
1162 if (minor
>= MON_BIN_MAX_MINOR
)
1165 dev
= device_create_drvdata(mon_bin_class
, ubus
? ubus
->controller
: NULL
,
1166 MKDEV(MAJOR(mon_bin_dev0
), minor
), NULL
,
1171 mbus
->classdev
= dev
;
1175 void mon_bin_del(struct mon_bus
*mbus
)
1177 device_destroy(mon_bin_class
, mbus
->classdev
->devt
);
1180 int __init
mon_bin_init(void)
1184 mon_bin_class
= class_create(THIS_MODULE
, "usbmon");
1185 if (IS_ERR(mon_bin_class
)) {
1186 rc
= PTR_ERR(mon_bin_class
);
1190 rc
= alloc_chrdev_region(&mon_bin_dev0
, 0, MON_BIN_MAX_MINOR
, "usbmon");
1194 cdev_init(&mon_bin_cdev
, &mon_fops_binary
);
1195 mon_bin_cdev
.owner
= THIS_MODULE
;
1197 rc
= cdev_add(&mon_bin_cdev
, mon_bin_dev0
, MON_BIN_MAX_MINOR
);
1204 unregister_chrdev_region(mon_bin_dev0
, MON_BIN_MAX_MINOR
);
1206 class_destroy(mon_bin_class
);
1211 void mon_bin_exit(void)
1213 cdev_del(&mon_bin_cdev
);
1214 unregister_chrdev_region(mon_bin_dev0
, MON_BIN_MAX_MINOR
);
1215 class_destroy(mon_bin_class
);