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 * @rq: block IO operation request
69 * The block operation request @rq is being placed back into queue
70 * @q. For some reason the request was not completed and needs to be
71 * put back in the queue.
73 TRACE_EVENT(block_rq_requeue,
75 TP_PROTO(struct request *rq),
81 __field( sector_t, sector )
82 __field( unsigned int, nr_sector )
83 __array( char, rwbs, RWBS_LEN )
84 __dynamic_array( char, cmd, 1 )
88 __entry->dev = rq->q->disk ? disk_devt(rq->q->disk) : 0;
89 __entry->sector = blk_rq_trace_sector(rq);
90 __entry->nr_sector = blk_rq_trace_nr_sectors(rq);
92 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags);
93 __get_str(cmd)[0] = '\0';
96 TP_printk("%d,%d %s (%s) %llu + %u [%d]",
97 MAJOR(__entry->dev), MINOR(__entry->dev),
98 __entry->rwbs, __get_str(cmd),
99 (unsigned long long)__entry->sector,
100 __entry->nr_sector, 0)
103 DECLARE_EVENT_CLASS(block_rq_completion,
105 TP_PROTO(struct request *rq, blk_status_t error, unsigned int nr_bytes),
107 TP_ARGS(rq, error, nr_bytes),
110 __field( dev_t, dev )
111 __field( sector_t, sector )
112 __field( unsigned int, nr_sector )
113 __field( int , error )
114 __array( char, rwbs, RWBS_LEN )
115 __dynamic_array( char, cmd, 1 )
119 __entry->dev = rq->q->disk ? disk_devt(rq->q->disk) : 0;
120 __entry->sector = blk_rq_pos(rq);
121 __entry->nr_sector = nr_bytes >> 9;
122 __entry->error = blk_status_to_errno(error);
124 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags);
125 __get_str(cmd)[0] = '\0';
128 TP_printk("%d,%d %s (%s) %llu + %u [%d]",
129 MAJOR(__entry->dev), MINOR(__entry->dev),
130 __entry->rwbs, __get_str(cmd),
131 (unsigned long long)__entry->sector,
132 __entry->nr_sector, __entry->error)
136 * block_rq_complete - block IO operation completed by device driver
137 * @rq: block operations request
138 * @error: status code
139 * @nr_bytes: number of completed bytes
141 * The block_rq_complete tracepoint event indicates that some portion
142 * of operation request has been completed by the device driver. If
143 * the @rq->bio is %NULL, then there is absolutely no additional work to
144 * do for the request. If @rq->bio is non-NULL then there is
145 * additional work required to complete the request.
147 DEFINE_EVENT(block_rq_completion, block_rq_complete,
149 TP_PROTO(struct request *rq, blk_status_t error, unsigned int nr_bytes),
151 TP_ARGS(rq, error, nr_bytes)
155 * block_rq_error - block IO operation error reported by device driver
156 * @rq: block operations request
157 * @error: status code
158 * @nr_bytes: number of completed bytes
160 * The block_rq_error tracepoint event indicates that some portion
161 * of operation request has failed as reported by the device driver.
163 DEFINE_EVENT(block_rq_completion, block_rq_error,
165 TP_PROTO(struct request *rq, blk_status_t error, unsigned int nr_bytes),
167 TP_ARGS(rq, error, nr_bytes)
170 DECLARE_EVENT_CLASS(block_rq,
172 TP_PROTO(struct request *rq),
177 __field( dev_t, dev )
178 __field( sector_t, sector )
179 __field( unsigned int, nr_sector )
180 __field( unsigned int, bytes )
181 __array( char, rwbs, RWBS_LEN )
182 __array( char, comm, TASK_COMM_LEN )
183 __dynamic_array( char, cmd, 1 )
187 __entry->dev = rq->q->disk ? disk_devt(rq->q->disk) : 0;
188 __entry->sector = blk_rq_trace_sector(rq);
189 __entry->nr_sector = blk_rq_trace_nr_sectors(rq);
190 __entry->bytes = blk_rq_bytes(rq);
192 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags);
193 __get_str(cmd)[0] = '\0';
194 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
197 TP_printk("%d,%d %s %u (%s) %llu + %u [%s]",
198 MAJOR(__entry->dev), MINOR(__entry->dev),
199 __entry->rwbs, __entry->bytes, __get_str(cmd),
200 (unsigned long long)__entry->sector,
201 __entry->nr_sector, __entry->comm)
205 * block_rq_insert - insert block operation request into queue
206 * @rq: block IO operation request
208 * Called immediately before block operation request @rq is inserted
209 * into queue @q. The fields in the operation request @rq struct can
210 * be examined to determine which device and sectors the pending
211 * operation would access.
213 DEFINE_EVENT(block_rq, block_rq_insert,
215 TP_PROTO(struct request *rq),
221 * block_rq_issue - issue pending block IO request operation to device driver
222 * @rq: block IO operation request
224 * Called when block operation request @rq from queue @q is sent to a
225 * device driver for processing.
227 DEFINE_EVENT(block_rq, block_rq_issue,
229 TP_PROTO(struct request *rq),
235 * block_rq_merge - merge request with another one in the elevator
236 * @rq: block IO operation request
238 * Called when block operation request @rq from queue @q is merged to another
239 * request queued in the elevator.
241 DEFINE_EVENT(block_rq, block_rq_merge,
243 TP_PROTO(struct request *rq),
249 * block_bio_complete - completed all work on the block operation
250 * @q: queue holding the block operation
251 * @bio: block operation completed
253 * This tracepoint indicates there is no further work to do on this
254 * block IO operation @bio.
256 TRACE_EVENT(block_bio_complete,
258 TP_PROTO(struct request_queue *q, struct bio *bio),
263 __field( dev_t, dev )
264 __field( sector_t, sector )
265 __field( unsigned, nr_sector )
266 __field( int, error )
267 __array( char, rwbs, RWBS_LEN)
271 __entry->dev = bio_dev(bio);
272 __entry->sector = bio->bi_iter.bi_sector;
273 __entry->nr_sector = bio_sectors(bio);
274 __entry->error = blk_status_to_errno(bio->bi_status);
275 blk_fill_rwbs(__entry->rwbs, bio->bi_opf);
278 TP_printk("%d,%d %s %llu + %u [%d]",
279 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
280 (unsigned long long)__entry->sector,
281 __entry->nr_sector, __entry->error)
284 DECLARE_EVENT_CLASS(block_bio,
286 TP_PROTO(struct bio *bio),
291 __field( dev_t, dev )
292 __field( sector_t, sector )
293 __field( unsigned int, nr_sector )
294 __array( char, rwbs, RWBS_LEN )
295 __array( char, comm, TASK_COMM_LEN )
299 __entry->dev = bio_dev(bio);
300 __entry->sector = bio->bi_iter.bi_sector;
301 __entry->nr_sector = bio_sectors(bio);
302 blk_fill_rwbs(__entry->rwbs, bio->bi_opf);
303 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
306 TP_printk("%d,%d %s %llu + %u [%s]",
307 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
308 (unsigned long long)__entry->sector,
309 __entry->nr_sector, __entry->comm)
313 * block_bio_bounce - used bounce buffer when processing block operation
314 * @bio: block operation
316 * A bounce buffer was used to handle the block operation @bio in @q.
317 * This occurs when hardware limitations prevent a direct transfer of
318 * data between the @bio data memory area and the IO device. Use of a
319 * bounce buffer requires extra copying of data and decreases
322 DEFINE_EVENT(block_bio, block_bio_bounce,
323 TP_PROTO(struct bio *bio),
328 * block_bio_backmerge - merging block operation to the end of an existing operation
329 * @bio: new block operation to merge
331 * Merging block request @bio to the end of an existing block request.
333 DEFINE_EVENT(block_bio, block_bio_backmerge,
334 TP_PROTO(struct bio *bio),
339 * block_bio_frontmerge - merging block operation to the beginning of an existing operation
340 * @bio: new block operation to merge
342 * Merging block IO operation @bio to the beginning of an existing block request.
344 DEFINE_EVENT(block_bio, block_bio_frontmerge,
345 TP_PROTO(struct bio *bio),
350 * block_bio_queue - putting new block IO operation in queue
351 * @bio: new block operation
353 * About to place the block IO operation @bio into queue @q.
355 DEFINE_EVENT(block_bio, block_bio_queue,
356 TP_PROTO(struct bio *bio),
361 * block_getrq - get a free request entry in queue for block IO operations
362 * @bio: pending block IO operation (can be %NULL)
364 * A request struct has been allocated to handle the block IO operation @bio.
366 DEFINE_EVENT(block_bio, block_getrq,
367 TP_PROTO(struct bio *bio),
372 * block_plug - keep operations requests in request queue
373 * @q: request queue to plug
375 * Plug the request queue @q. Do not allow block operation requests
376 * to be sent to the device driver. Instead, accumulate requests in
377 * the queue to improve throughput performance of the block device.
379 TRACE_EVENT(block_plug,
381 TP_PROTO(struct request_queue *q),
386 __array( char, comm, TASK_COMM_LEN )
390 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
393 TP_printk("[%s]", __entry->comm)
396 DECLARE_EVENT_CLASS(block_unplug,
398 TP_PROTO(struct request_queue *q, unsigned int depth, bool explicit),
400 TP_ARGS(q, depth, explicit),
403 __field( int, nr_rq )
404 __array( char, comm, TASK_COMM_LEN )
408 __entry->nr_rq = depth;
409 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
412 TP_printk("[%s] %d", __entry->comm, __entry->nr_rq)
416 * block_unplug - release of operations requests in request queue
417 * @q: request queue to unplug
418 * @depth: number of requests just added to the queue
419 * @explicit: whether this was an explicit unplug, or one from schedule()
421 * Unplug request queue @q because device driver is scheduled to work
422 * on elements in the request queue.
424 DEFINE_EVENT(block_unplug, block_unplug,
426 TP_PROTO(struct request_queue *q, unsigned int depth, bool explicit),
428 TP_ARGS(q, depth, explicit)
432 * block_split - split a single bio struct into two bio structs
433 * @bio: block operation being split
434 * @new_sector: The starting sector for the new bio
436 * The bio request @bio needs to be split into two bio requests. The newly
437 * created @bio request starts at @new_sector. This split may be required due to
438 * hardware limitations such as operation crossing device boundaries in a RAID
441 TRACE_EVENT(block_split,
443 TP_PROTO(struct bio *bio, unsigned int new_sector),
445 TP_ARGS(bio, new_sector),
448 __field( dev_t, dev )
449 __field( sector_t, sector )
450 __field( sector_t, new_sector )
451 __array( char, rwbs, RWBS_LEN )
452 __array( char, comm, TASK_COMM_LEN )
456 __entry->dev = bio_dev(bio);
457 __entry->sector = bio->bi_iter.bi_sector;
458 __entry->new_sector = new_sector;
459 blk_fill_rwbs(__entry->rwbs, bio->bi_opf);
460 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
463 TP_printk("%d,%d %s %llu / %llu [%s]",
464 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
465 (unsigned long long)__entry->sector,
466 (unsigned long long)__entry->new_sector,
471 * block_bio_remap - map request for a logical device to the raw device
472 * @bio: revised operation
473 * @dev: original device for the operation
474 * @from: original sector for the operation
476 * An operation for a logical device has been mapped to the
479 TRACE_EVENT(block_bio_remap,
481 TP_PROTO(struct bio *bio, dev_t dev, sector_t from),
483 TP_ARGS(bio, dev, from),
486 __field( dev_t, dev )
487 __field( sector_t, sector )
488 __field( unsigned int, nr_sector )
489 __field( dev_t, old_dev )
490 __field( sector_t, old_sector )
491 __array( char, rwbs, RWBS_LEN)
495 __entry->dev = bio_dev(bio);
496 __entry->sector = bio->bi_iter.bi_sector;
497 __entry->nr_sector = bio_sectors(bio);
498 __entry->old_dev = dev;
499 __entry->old_sector = from;
500 blk_fill_rwbs(__entry->rwbs, bio->bi_opf);
503 TP_printk("%d,%d %s %llu + %u <- (%d,%d) %llu",
504 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
505 (unsigned long long)__entry->sector,
507 MAJOR(__entry->old_dev), MINOR(__entry->old_dev),
508 (unsigned long long)__entry->old_sector)
512 * block_rq_remap - map request for a block operation request
513 * @rq: block IO operation request
514 * @dev: device for the operation
515 * @from: original sector for the operation
517 * The block operation request @rq in @q has been remapped. The block
518 * operation request @rq holds the current information and @from hold
519 * the original sector.
521 TRACE_EVENT(block_rq_remap,
523 TP_PROTO(struct request *rq, dev_t dev, sector_t from),
525 TP_ARGS(rq, dev, from),
528 __field( dev_t, dev )
529 __field( sector_t, sector )
530 __field( unsigned int, nr_sector )
531 __field( dev_t, old_dev )
532 __field( sector_t, old_sector )
533 __field( unsigned int, nr_bios )
534 __array( char, rwbs, RWBS_LEN)
538 __entry->dev = disk_devt(rq->q->disk);
539 __entry->sector = blk_rq_pos(rq);
540 __entry->nr_sector = blk_rq_sectors(rq);
541 __entry->old_dev = dev;
542 __entry->old_sector = from;
543 __entry->nr_bios = blk_rq_count_bios(rq);
544 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags);
547 TP_printk("%d,%d %s %llu + %u <- (%d,%d) %llu %u",
548 MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
549 (unsigned long long)__entry->sector,
551 MAJOR(__entry->old_dev), MINOR(__entry->old_dev),
552 (unsigned long long)__entry->old_sector, __entry->nr_bios)
555 #endif /* _TRACE_BLOCK_H */
557 /* This part must be outside protection */
558 #include <trace/define_trace.h>