1 /* SPDX-License-Identifier: GPL-2.0 */
3 #define TRACE_SYSTEM block
5 #if !defined(_TRACE_BLOCK_H) || defined(TRACE_HEADER_MULTI_READ)
8 #include <linux/blktrace_api.h>
9 #include <linux/blkdev.h>
10 #include <linux/buffer_head.h>
11 #include <linux/tracepoint.h>
15 DECLARE_EVENT_CLASS(block_buffer,
17 TP_PROTO(struct buffer_head *bh),
23 __field( sector_t, sector )
24 __field( size_t, size )
28 __entry->dev = bh->b_bdev->bd_dev;
29 __entry->sector = bh->b_blocknr;
30 __entry->size = bh->b_size;
33 TP_printk("%d,%d sector=%llu size=%zu",
34 MAJOR(__entry->dev), MINOR(__entry->dev),
35 (unsigned long long)__entry->sector, __entry->size
40 * block_touch_buffer - mark a buffer accessed
41 * @bh: buffer_head being touched
43 * Called from touch_buffer().
45 DEFINE_EVENT(block_buffer, block_touch_buffer,
47 TP_PROTO(struct buffer_head *bh),
53 * block_dirty_buffer - mark a buffer dirty
54 * @bh: buffer_head being dirtied
56 * Called from mark_buffer_dirty().
58 DEFINE_EVENT(block_buffer, block_dirty_buffer,
60 TP_PROTO(struct buffer_head *bh),
66 * block_rq_requeue - place block IO request back on a queue
67 * @q: queue holding operation
68 * @rq: block IO operation request
70 * The block operation request @rq is being placed back into queue
71 * @q. For some reason the request was not completed and needs to be
72 * put back in the queue.
74 TRACE_EVENT(block_rq_requeue,
76 TP_PROTO(struct request_queue *q, struct request *rq),
82 __field( sector_t, sector )
83 __field( unsigned int, nr_sector )
84 __array( char, rwbs, RWBS_LEN )
85 __dynamic_array( char, cmd, 1 )
89 __entry->dev = rq->rq_disk ? disk_devt(rq->rq_disk) : 0;
90 __entry->sector = blk_rq_trace_sector(rq);
91 __entry->nr_sector = blk_rq_trace_nr_sectors(rq);
93 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags, blk_rq_bytes(rq));
94 __get_str(cmd)[0] = '\0';
97 TP_printk("%d,%d %s (%s) %llu + %u [%d]",
98 MAJOR(__entry->dev), MINOR(__entry->dev),
99 __entry->rwbs, __get_str(cmd),
100 (unsigned long long)__entry->sector,
101 __entry->nr_sector, 0)
105 * block_rq_complete - block IO operation completed by device driver
106 * @rq: block operations request
107 * @error: status code
108 * @nr_bytes: number of completed bytes
110 * The block_rq_complete tracepoint event indicates that some portion
111 * of operation request has been completed by the device driver. If
112 * the @rq->bio is %NULL, then there is absolutely no additional work to
113 * do for the request. If @rq->bio is non-NULL then there is
114 * additional work required to complete the request.
116 TRACE_EVENT(block_rq_complete,
118 TP_PROTO(struct request *rq, int error, unsigned int nr_bytes),
120 TP_ARGS(rq, error, nr_bytes),
123 __field( dev_t, dev )
124 __field( sector_t, sector )
125 __field( unsigned int, nr_sector )
126 __field( int, error )
127 __array( char, rwbs, RWBS_LEN )
128 __dynamic_array( char, cmd, 1 )
132 __entry->dev = rq->rq_disk ? disk_devt(rq->rq_disk) : 0;
133 __entry->sector = blk_rq_pos(rq);
134 __entry->nr_sector = nr_bytes >> 9;
135 __entry->error = error;
137 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags, nr_bytes);
138 __get_str(cmd)[0] = '\0';
141 TP_printk("%d,%d %s (%s) %llu + %u [%d]",
142 MAJOR(__entry->dev), MINOR(__entry->dev),
143 __entry->rwbs, __get_str(cmd),
144 (unsigned long long)__entry->sector,
145 __entry->nr_sector, __entry->error)
148 DECLARE_EVENT_CLASS(block_rq,
150 TP_PROTO(struct request_queue *q, struct request *rq),
155 __field( dev_t, dev )
156 __field( sector_t, sector )
157 __field( unsigned int, nr_sector )
158 __field( unsigned int, bytes )
159 __array( char, rwbs, RWBS_LEN )
160 __array( char, comm, TASK_COMM_LEN )
161 __dynamic_array( char, cmd, 1 )
165 __entry->dev = rq->rq_disk ? disk_devt(rq->rq_disk) : 0;
166 __entry->sector = blk_rq_trace_sector(rq);
167 __entry->nr_sector = blk_rq_trace_nr_sectors(rq);
168 __entry->bytes = blk_rq_bytes(rq);
170 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags, blk_rq_bytes(rq));
171 __get_str(cmd)[0] = '\0';
172 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
175 TP_printk("%d,%d %s %u (%s) %llu + %u [%s]",
176 MAJOR(__entry->dev), MINOR(__entry->dev),
177 __entry->rwbs, __entry->bytes, __get_str(cmd),
178 (unsigned long long)__entry->sector,
179 __entry->nr_sector, __entry->comm)
183 * block_rq_insert - insert block operation request into queue
185 * @rq: block IO operation request
187 * Called immediately before block operation request @rq is inserted
188 * into queue @q. The fields in the operation request @rq struct can
189 * be examined to determine which device and sectors the pending
190 * operation would access.
192 DEFINE_EVENT(block_rq, block_rq_insert,
194 TP_PROTO(struct request_queue *q, struct request *rq),
200 * block_rq_issue - issue pending block IO request operation to device driver
201 * @q: queue holding operation
202 * @rq: block IO operation operation request
204 * Called when block operation request @rq from queue @q is sent to a
205 * device driver for processing.
207 DEFINE_EVENT(block_rq, block_rq_issue,
209 TP_PROTO(struct request_queue *q, struct request *rq),
215 * block_rq_merge - merge request with another one in the elevator
216 * @q: queue holding operation
217 * @rq: block IO operation operation request
219 * Called when block operation request @rq from queue @q is merged to another
220 * request queued in the elevator.
222 DEFINE_EVENT(block_rq, block_rq_merge,
224 TP_PROTO(struct request_queue *q, struct request *rq),
230 * block_bio_bounce - used bounce buffer when processing block operation
231 * @q: queue holding the block operation
232 * @bio: block operation
234 * A bounce buffer was used to handle the block operation @bio in @q.
235 * This occurs when hardware limitations prevent a direct transfer of
236 * data between the @bio data memory area and the IO device. Use of a
237 * bounce buffer requires extra copying of data and decreases
240 TRACE_EVENT(block_bio_bounce,
242 TP_PROTO(struct request_queue *q, struct bio *bio),
247 __field( dev_t, dev )
248 __field( sector_t, sector )
249 __field( unsigned int, nr_sector )
250 __array( char, rwbs, RWBS_LEN )
251 __array( char, comm, TASK_COMM_LEN )
255 __entry->dev = bio_dev(bio);
256 __entry->sector = bio->bi_iter.bi_sector;
257 __entry->nr_sector = bio_sectors(bio);
258 blk_fill_rwbs(__entry->rwbs, bio->bi_opf, bio->bi_iter.bi_size);
259 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
262 TP_printk("%d,%d %s %llu + %u [%s]",
263 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
264 (unsigned long long)__entry->sector,
265 __entry->nr_sector, __entry->comm)
269 * block_bio_complete - completed all work on the block operation
270 * @q: queue holding the block operation
271 * @bio: block operation completed
273 * This tracepoint indicates there is no further work to do on this
274 * block IO operation @bio.
276 TRACE_EVENT(block_bio_complete,
278 TP_PROTO(struct request_queue *q, struct bio *bio),
283 __field( dev_t, dev )
284 __field( sector_t, sector )
285 __field( unsigned, nr_sector )
286 __field( int, error )
287 __array( char, rwbs, RWBS_LEN)
291 __entry->dev = bio_dev(bio);
292 __entry->sector = bio->bi_iter.bi_sector;
293 __entry->nr_sector = bio_sectors(bio);
294 __entry->error = blk_status_to_errno(bio->bi_status);
295 blk_fill_rwbs(__entry->rwbs, bio->bi_opf, bio->bi_iter.bi_size);
298 TP_printk("%d,%d %s %llu + %u [%d]",
299 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
300 (unsigned long long)__entry->sector,
301 __entry->nr_sector, __entry->error)
304 DECLARE_EVENT_CLASS(block_bio_merge,
306 TP_PROTO(struct request_queue *q, struct request *rq, struct bio *bio),
311 __field( dev_t, dev )
312 __field( sector_t, sector )
313 __field( unsigned int, nr_sector )
314 __array( char, rwbs, RWBS_LEN )
315 __array( char, comm, TASK_COMM_LEN )
319 __entry->dev = bio_dev(bio);
320 __entry->sector = bio->bi_iter.bi_sector;
321 __entry->nr_sector = bio_sectors(bio);
322 blk_fill_rwbs(__entry->rwbs, bio->bi_opf, bio->bi_iter.bi_size);
323 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
326 TP_printk("%d,%d %s %llu + %u [%s]",
327 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
328 (unsigned long long)__entry->sector,
329 __entry->nr_sector, __entry->comm)
333 * block_bio_backmerge - merging block operation to the end of an existing operation
334 * @q: queue holding operation
335 * @rq: request bio is being merged into
336 * @bio: new block operation to merge
338 * Merging block request @bio to the end of an existing block request
341 DEFINE_EVENT(block_bio_merge, block_bio_backmerge,
343 TP_PROTO(struct request_queue *q, struct request *rq, struct bio *bio),
349 * block_bio_frontmerge - merging block operation to the beginning of an existing operation
350 * @q: queue holding operation
351 * @rq: request bio is being merged into
352 * @bio: new block operation to merge
354 * Merging block IO operation @bio to the beginning of an existing block
355 * operation in queue @q.
357 DEFINE_EVENT(block_bio_merge, block_bio_frontmerge,
359 TP_PROTO(struct request_queue *q, struct request *rq, struct bio *bio),
365 * block_bio_queue - putting new block IO operation in queue
366 * @q: queue holding operation
367 * @bio: new block operation
369 * About to place the block IO operation @bio into queue @q.
371 TRACE_EVENT(block_bio_queue,
373 TP_PROTO(struct request_queue *q, struct bio *bio),
378 __field( dev_t, dev )
379 __field( sector_t, sector )
380 __field( unsigned int, nr_sector )
381 __array( char, rwbs, RWBS_LEN )
382 __array( char, comm, TASK_COMM_LEN )
386 __entry->dev = bio_dev(bio);
387 __entry->sector = bio->bi_iter.bi_sector;
388 __entry->nr_sector = bio_sectors(bio);
389 blk_fill_rwbs(__entry->rwbs, bio->bi_opf, bio->bi_iter.bi_size);
390 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
393 TP_printk("%d,%d %s %llu + %u [%s]",
394 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
395 (unsigned long long)__entry->sector,
396 __entry->nr_sector, __entry->comm)
399 DECLARE_EVENT_CLASS(block_get_rq,
401 TP_PROTO(struct request_queue *q, struct bio *bio, int rw),
406 __field( dev_t, dev )
407 __field( sector_t, sector )
408 __field( unsigned int, nr_sector )
409 __array( char, rwbs, RWBS_LEN )
410 __array( char, comm, TASK_COMM_LEN )
414 __entry->dev = bio ? bio_dev(bio) : 0;
415 __entry->sector = bio ? bio->bi_iter.bi_sector : 0;
416 __entry->nr_sector = bio ? bio_sectors(bio) : 0;
417 blk_fill_rwbs(__entry->rwbs,
418 bio ? bio->bi_opf : 0, __entry->nr_sector);
419 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
422 TP_printk("%d,%d %s %llu + %u [%s]",
423 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
424 (unsigned long long)__entry->sector,
425 __entry->nr_sector, __entry->comm)
429 * block_getrq - get a free request entry in queue for block IO operations
430 * @q: queue for operations
431 * @bio: pending block IO operation (can be %NULL)
432 * @rw: low bit indicates a read (%0) or a write (%1)
434 * A request struct for queue @q has been allocated to handle the
435 * block IO operation @bio.
437 DEFINE_EVENT(block_get_rq, block_getrq,
439 TP_PROTO(struct request_queue *q, struct bio *bio, int rw),
445 * block_sleeprq - waiting to get a free request entry in queue for block IO operation
446 * @q: queue for operation
447 * @bio: pending block IO operation (can be %NULL)
448 * @rw: low bit indicates a read (%0) or a write (%1)
450 * In the case where a request struct cannot be provided for queue @q
451 * the process needs to wait for an request struct to become
452 * available. This tracepoint event is generated each time the
453 * process goes to sleep waiting for request struct become available.
455 DEFINE_EVENT(block_get_rq, block_sleeprq,
457 TP_PROTO(struct request_queue *q, struct bio *bio, int rw),
463 * block_plug - keep operations requests in request queue
464 * @q: request queue to plug
466 * Plug the request queue @q. Do not allow block operation requests
467 * to be sent to the device driver. Instead, accumulate requests in
468 * the queue to improve throughput performance of the block device.
470 TRACE_EVENT(block_plug,
472 TP_PROTO(struct request_queue *q),
477 __array( char, comm, TASK_COMM_LEN )
481 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
484 TP_printk("[%s]", __entry->comm)
487 DECLARE_EVENT_CLASS(block_unplug,
489 TP_PROTO(struct request_queue *q, unsigned int depth, bool explicit),
491 TP_ARGS(q, depth, explicit),
494 __field( int, nr_rq )
495 __array( char, comm, TASK_COMM_LEN )
499 __entry->nr_rq = depth;
500 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
503 TP_printk("[%s] %d", __entry->comm, __entry->nr_rq)
507 * block_unplug - release of operations requests in request queue
508 * @q: request queue to unplug
509 * @depth: number of requests just added to the queue
510 * @explicit: whether this was an explicit unplug, or one from schedule()
512 * Unplug request queue @q because device driver is scheduled to work
513 * on elements in the request queue.
515 DEFINE_EVENT(block_unplug, block_unplug,
517 TP_PROTO(struct request_queue *q, unsigned int depth, bool explicit),
519 TP_ARGS(q, depth, explicit)
523 * block_split - split a single bio struct into two bio structs
524 * @q: queue containing the bio
525 * @bio: block operation being split
526 * @new_sector: The starting sector for the new bio
528 * The bio request @bio in request queue @q needs to be split into two
529 * bio requests. The newly created @bio request starts at
530 * @new_sector. This split may be required due to hardware limitation
531 * such as operation crossing device boundaries in a RAID system.
533 TRACE_EVENT(block_split,
535 TP_PROTO(struct request_queue *q, struct bio *bio,
536 unsigned int new_sector),
538 TP_ARGS(q, bio, new_sector),
541 __field( dev_t, dev )
542 __field( sector_t, sector )
543 __field( sector_t, new_sector )
544 __array( char, rwbs, RWBS_LEN )
545 __array( char, comm, TASK_COMM_LEN )
549 __entry->dev = bio_dev(bio);
550 __entry->sector = bio->bi_iter.bi_sector;
551 __entry->new_sector = new_sector;
552 blk_fill_rwbs(__entry->rwbs, bio->bi_opf, bio->bi_iter.bi_size);
553 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
556 TP_printk("%d,%d %s %llu / %llu [%s]",
557 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
558 (unsigned long long)__entry->sector,
559 (unsigned long long)__entry->new_sector,
564 * block_bio_remap - map request for a logical device to the raw device
565 * @q: queue holding the operation
566 * @bio: revised operation
567 * @dev: device for the operation
568 * @from: original sector for the operation
570 * An operation for a logical device has been mapped to the
573 TRACE_EVENT(block_bio_remap,
575 TP_PROTO(struct request_queue *q, struct bio *bio, dev_t dev,
578 TP_ARGS(q, bio, dev, from),
581 __field( dev_t, dev )
582 __field( sector_t, sector )
583 __field( unsigned int, nr_sector )
584 __field( dev_t, old_dev )
585 __field( sector_t, old_sector )
586 __array( char, rwbs, RWBS_LEN)
590 __entry->dev = bio_dev(bio);
591 __entry->sector = bio->bi_iter.bi_sector;
592 __entry->nr_sector = bio_sectors(bio);
593 __entry->old_dev = dev;
594 __entry->old_sector = from;
595 blk_fill_rwbs(__entry->rwbs, bio->bi_opf, bio->bi_iter.bi_size);
598 TP_printk("%d,%d %s %llu + %u <- (%d,%d) %llu",
599 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
600 (unsigned long long)__entry->sector,
602 MAJOR(__entry->old_dev), MINOR(__entry->old_dev),
603 (unsigned long long)__entry->old_sector)
607 * block_rq_remap - map request for a block operation request
608 * @q: queue holding the operation
609 * @rq: block IO operation request
610 * @dev: device for the operation
611 * @from: original sector for the operation
613 * The block operation request @rq in @q has been remapped. The block
614 * operation request @rq holds the current information and @from hold
615 * the original sector.
617 TRACE_EVENT(block_rq_remap,
619 TP_PROTO(struct request_queue *q, struct request *rq, dev_t dev,
622 TP_ARGS(q, rq, dev, from),
625 __field( dev_t, dev )
626 __field( sector_t, sector )
627 __field( unsigned int, nr_sector )
628 __field( dev_t, old_dev )
629 __field( sector_t, old_sector )
630 __field( unsigned int, nr_bios )
631 __array( char, rwbs, RWBS_LEN)
635 __entry->dev = disk_devt(rq->rq_disk);
636 __entry->sector = blk_rq_pos(rq);
637 __entry->nr_sector = blk_rq_sectors(rq);
638 __entry->old_dev = dev;
639 __entry->old_sector = from;
640 __entry->nr_bios = blk_rq_count_bios(rq);
641 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags, blk_rq_bytes(rq));
644 TP_printk("%d,%d %s %llu + %u <- (%d,%d) %llu %u",
645 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
646 (unsigned long long)__entry->sector,
648 MAJOR(__entry->old_dev), MINOR(__entry->old_dev),
649 (unsigned long long)__entry->old_sector, __entry->nr_bios)
652 #endif /* _TRACE_BLOCK_H */
654 /* This part must be outside protection */
655 #include <trace/define_trace.h>