include/trace/events/block.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #undef TRACE_SYSTEM
   3 #define TRACE_SYSTEM block
   4
   5 #if !defined(_TRACE_BLOCK_H) || defined(TRACE_HEADER_MULTI_READ)
   6 #define _TRACE_BLOCK_H
   7
   8 #include <linux/blktrace_api.h>
   9 #include <linux/blkdev.h>
  10 #include <linux/buffer_head.h>
  11 #include <linux/tracepoint.h>
  12
  13 #define RWBS_LEN        8
  14
  15 DECLARE_EVENT_CLASS(block_buffer,
  16
  17         TP_PROTO(struct buffer_head *bh),
  18
  19         TP_ARGS(bh),
  20
  21         TP_STRUCT__entry (
  22                 __field(  dev_t,        dev                     )
  23                 __field(  sector_t,     sector                  )
  24                 __field(  size_t,       size                    )
  25         ),
  26
  27         TP_fast_assign(
  28                 __entry->dev            = bh->b_bdev->bd_dev;
  29                 __entry->sector         = bh->b_blocknr;
  30                 __entry->size           = bh->b_size;
  31         ),
  32
  33         TP_printk("%d,%d sector=%llu size=%zu",
  34                 MAJOR(__entry->dev), MINOR(__entry->dev),
  35                 (unsigned long long)__entry->sector, __entry->size
  36         )
  37 );
  38
  39 /**
  40  * block_touch_buffer - mark a buffer accessed
  41  * @bh: buffer_head being touched
  42  *
  43  * Called from touch_buffer().
  44  */
  45 DEFINE_EVENT(block_buffer, block_touch_buffer,
  46
  47         TP_PROTO(struct buffer_head *bh),
  48
  49         TP_ARGS(bh)
  50 );
  51
  52 /**
  53  * block_dirty_buffer - mark a buffer dirty
  54  * @bh: buffer_head being dirtied
  55  *
  56  * Called from mark_buffer_dirty().
  57  */
  58 DEFINE_EVENT(block_buffer, block_dirty_buffer,
  59
  60         TP_PROTO(struct buffer_head *bh),
  61
  62         TP_ARGS(bh)
  63 );
  64
  65 /**
  66  * block_rq_requeue - place block IO request back on a queue
  67  * @q: queue holding operation
  68  * @rq: block IO operation request
  69  *
  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.
  73  */
  74 TRACE_EVENT(block_rq_requeue,
  75
  76         TP_PROTO(struct request_queue *q, struct request *rq),
  77
  78         TP_ARGS(q, rq),
  79
  80         TP_STRUCT__entry(
  81                 __field(  dev_t,        dev                     )
  82                 __field(  sector_t,     sector                  )
  83                 __field(  unsigned int, nr_sector               )
  84                 __array(  char,         rwbs,   RWBS_LEN        )
  85                 __dynamic_array( char,  cmd,    1               )
  86         ),
  87
  88         TP_fast_assign(
  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);
  92
  93                 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags, blk_rq_bytes(rq));
  94                 __get_str(cmd)[0] = '\0';
  95         ),
  96
  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)
 102 );
 103
 104 /**
 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
 109  *
 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.
 115  */
 116 TRACE_EVENT(block_rq_complete,
 117
 118         TP_PROTO(struct request *rq, int error, unsigned int nr_bytes),
 119
 120         TP_ARGS(rq, error, nr_bytes),
 121
 122         TP_STRUCT__entry(
 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               )
 129         ),
 130
 131         TP_fast_assign(
 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;
 136
 137                 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags, nr_bytes);
 138                 __get_str(cmd)[0] = '\0';
 139         ),
 140
 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)
 146 );
 147
 148 DECLARE_EVENT_CLASS(block_rq,
 149
 150         TP_PROTO(struct request_queue *q, struct request *rq),
 151
 152         TP_ARGS(q, rq),
 153
 154         TP_STRUCT__entry(
 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               )
 162         ),
 163
 164         TP_fast_assign(
 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);
 169
 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);
 173         ),
 174
 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)
 180 );
 181
 182 /**
 183  * block_rq_insert - insert block operation request into queue
 184  * @q: target queue
 185  * @rq: block IO operation request
 186  *
 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.
 191  */
 192 DEFINE_EVENT(block_rq, block_rq_insert,
 193
 194         TP_PROTO(struct request_queue *q, struct request *rq),
 195
 196         TP_ARGS(q, rq)
 197 );
 198
 199 /**
 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
 203  *
 204  * Called when block operation request @rq from queue @q is sent to a
 205  * device driver for processing.
 206  */
 207 DEFINE_EVENT(block_rq, block_rq_issue,
 208
 209         TP_PROTO(struct request_queue *q, struct request *rq),
 210
 211         TP_ARGS(q, rq)
 212 );
 213
 214 /**
 215  * block_rq_merge - merge request with another one in the elevator
 216  * @q: queue holding operation
 217  * @rq: block IO operation operation request
 218  *
 219  * Called when block operation request @rq from queue @q is merged to another
 220  * request queued in the elevator.
 221  */
 222 DEFINE_EVENT(block_rq, block_rq_merge,
 223
 224         TP_PROTO(struct request_queue *q, struct request *rq),
 225
 226         TP_ARGS(q, rq)
 227 );
 228
 229 /**
 230  * block_bio_complete - completed all work on the block operation
 231  * @q: queue holding the block operation
 232  * @bio: block operation completed
 233  *
 234  * This tracepoint indicates there is no further work to do on this
 235  * block IO operation @bio.
 236  */
 237 TRACE_EVENT(block_bio_complete,
 238
 239         TP_PROTO(struct request_queue *q, struct bio *bio),
 240
 241         TP_ARGS(q, bio),
 242
 243         TP_STRUCT__entry(
 244                 __field( dev_t,         dev             )
 245                 __field( sector_t,      sector          )
 246                 __field( unsigned,      nr_sector       )
 247                 __field( int,           error           )
 248                 __array( char,          rwbs,   RWBS_LEN)
 249         ),
 250
 251         TP_fast_assign(
 252                 __entry->dev            = bio_dev(bio);
 253                 __entry->sector         = bio->bi_iter.bi_sector;
 254                 __entry->nr_sector      = bio_sectors(bio);
 255                 __entry->error          = blk_status_to_errno(bio->bi_status);
 256                 blk_fill_rwbs(__entry->rwbs, bio->bi_opf, bio->bi_iter.bi_size);
 257         ),
 258
 259         TP_printk("%d,%d %s %llu + %u [%d]",
 260                   MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
 261                   (unsigned long long)__entry->sector,
 262                   __entry->nr_sector, __entry->error)
 263 );
 264
 265 DECLARE_EVENT_CLASS(block_bio,
 266
 267         TP_PROTO(struct bio *bio),
 268
 269         TP_ARGS(bio),
 270
 271         TP_STRUCT__entry(
 272                 __field( dev_t,         dev                     )
 273                 __field( sector_t,      sector                  )
 274                 __field( unsigned int,  nr_sector               )
 275                 __array( char,          rwbs,   RWBS_LEN        )
 276                 __array( char,          comm,   TASK_COMM_LEN   )
 277         ),
 278
 279         TP_fast_assign(
 280                 __entry->dev            = bio_dev(bio);
 281                 __entry->sector         = bio->bi_iter.bi_sector;
 282                 __entry->nr_sector      = bio_sectors(bio);
 283                 blk_fill_rwbs(__entry->rwbs, bio->bi_opf, bio->bi_iter.bi_size);
 284                 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
 285         ),
 286
 287         TP_printk("%d,%d %s %llu + %u [%s]",
 288                   MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
 289                   (unsigned long long)__entry->sector,
 290                   __entry->nr_sector, __entry->comm)
 291 );
 292
 293 /**
 294  * block_bio_bounce - used bounce buffer when processing block operation
 295  * @bio: block operation
 296  *
 297  * A bounce buffer was used to handle the block operation @bio in @q.
 298  * This occurs when hardware limitations prevent a direct transfer of
 299  * data between the @bio data memory area and the IO device.  Use of a
 300  * bounce buffer requires extra copying of data and decreases
 301  * performance.
 302  */
 303 DEFINE_EVENT(block_bio, block_bio_bounce,
 304         TP_PROTO(struct bio *bio),
 305         TP_ARGS(bio)
 306 );
 307
 308 /**
 309  * block_bio_backmerge - merging block operation to the end of an existing operation
 310  * @bio: new block operation to merge
 311  *
 312  * Merging block request @bio to the end of an existing block request.
 313  */
 314 DEFINE_EVENT(block_bio, block_bio_backmerge,
 315         TP_PROTO(struct bio *bio),
 316         TP_ARGS(bio)
 317 );
 318
 319 /**
 320  * block_bio_frontmerge - merging block operation to the beginning of an existing operation
 321  * @bio: new block operation to merge
 322  *
 323  * Merging block IO operation @bio to the beginning of an existing block request.
 324  */
 325 DEFINE_EVENT(block_bio, block_bio_frontmerge,
 326         TP_PROTO(struct bio *bio),
 327         TP_ARGS(bio)
 328 );
 329
 330 /**
 331  * block_bio_queue - putting new block IO operation in queue
 332  * @bio: new block operation
 333  *
 334  * About to place the block IO operation @bio into queue @q.
 335  */
 336 DEFINE_EVENT(block_bio, block_bio_queue,
 337         TP_PROTO(struct bio *bio),
 338         TP_ARGS(bio)
 339 );
 340
 341 /**
 342  * block_getrq - get a free request entry in queue for block IO operations
 343  * @bio: pending block IO operation (can be %NULL)
 344  *
 345  * A request struct has been allocated to handle the block IO operation @bio.
 346  */
 347 DEFINE_EVENT(block_bio, block_getrq,
 348         TP_PROTO(struct bio *bio),
 349         TP_ARGS(bio)
 350 );
 351
 352 /**
 353  * block_plug - keep operations requests in request queue
 354  * @q: request queue to plug
 355  *
 356  * Plug the request queue @q.  Do not allow block operation requests
 357  * to be sent to the device driver. Instead, accumulate requests in
 358  * the queue to improve throughput performance of the block device.
 359  */
 360 TRACE_EVENT(block_plug,
 361
 362         TP_PROTO(struct request_queue *q),
 363
 364         TP_ARGS(q),
 365
 366         TP_STRUCT__entry(
 367                 __array( char,          comm,   TASK_COMM_LEN   )
 368         ),
 369
 370         TP_fast_assign(
 371                 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
 372         ),
 373
 374         TP_printk("[%s]", __entry->comm)
 375 );
 376
 377 DECLARE_EVENT_CLASS(block_unplug,
 378
 379         TP_PROTO(struct request_queue *q, unsigned int depth, bool explicit),
 380
 381         TP_ARGS(q, depth, explicit),
 382
 383         TP_STRUCT__entry(
 384                 __field( int,           nr_rq                   )
 385                 __array( char,          comm,   TASK_COMM_LEN   )
 386         ),
 387
 388         TP_fast_assign(
 389                 __entry->nr_rq = depth;
 390                 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
 391         ),
 392
 393         TP_printk("[%s] %d", __entry->comm, __entry->nr_rq)
 394 );
 395
 396 /**
 397  * block_unplug - release of operations requests in request queue
 398  * @q: request queue to unplug
 399  * @depth: number of requests just added to the queue
 400  * @explicit: whether this was an explicit unplug, or one from schedule()
 401  *
 402  * Unplug request queue @q because device driver is scheduled to work
 403  * on elements in the request queue.
 404  */
 405 DEFINE_EVENT(block_unplug, block_unplug,
 406
 407         TP_PROTO(struct request_queue *q, unsigned int depth, bool explicit),
 408
 409         TP_ARGS(q, depth, explicit)
 410 );
 411
 412 /**
 413  * block_split - split a single bio struct into two bio structs
 414  * @q: queue containing the bio
 415  * @bio: block operation being split
 416  * @new_sector: The starting sector for the new bio
 417  *
 418  * The bio request @bio in request queue @q needs to be split into two
 419  * bio requests. The newly created @bio request starts at
 420  * @new_sector. This split may be required due to hardware limitation
 421  * such as operation crossing device boundaries in a RAID system.
 422  */
 423 TRACE_EVENT(block_split,
 424
 425         TP_PROTO(struct request_queue *q, struct bio *bio,
 426                  unsigned int new_sector),
 427
 428         TP_ARGS(q, bio, new_sector),
 429
 430         TP_STRUCT__entry(
 431                 __field( dev_t,         dev                             )
 432                 __field( sector_t,      sector                          )
 433                 __field( sector_t,      new_sector                      )
 434                 __array( char,          rwbs,           RWBS_LEN        )
 435                 __array( char,          comm,           TASK_COMM_LEN   )
 436         ),
 437
 438         TP_fast_assign(
 439                 __entry->dev            = bio_dev(bio);
 440                 __entry->sector         = bio->bi_iter.bi_sector;
 441                 __entry->new_sector     = new_sector;
 442                 blk_fill_rwbs(__entry->rwbs, bio->bi_opf, bio->bi_iter.bi_size);
 443                 memcpy(__entry->comm, current->comm, TASK_COMM_LEN);
 444         ),
 445
 446         TP_printk("%d,%d %s %llu / %llu [%s]",
 447                   MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
 448                   (unsigned long long)__entry->sector,
 449                   (unsigned long long)__entry->new_sector,
 450                   __entry->comm)
 451 );
 452
 453 /**
 454  * block_bio_remap - map request for a logical device to the raw device
 455  * @q: queue holding the operation
 456  * @bio: revised operation
 457  * @dev: device for the operation
 458  * @from: original sector for the operation
 459  *
 460  * An operation for a logical device has been mapped to the
 461  * raw block device.
 462  */
 463 TRACE_EVENT(block_bio_remap,
 464
 465         TP_PROTO(struct request_queue *q, struct bio *bio, dev_t dev,
 466                  sector_t from),
 467
 468         TP_ARGS(q, bio, dev, from),
 469
 470         TP_STRUCT__entry(
 471                 __field( dev_t,         dev             )
 472                 __field( sector_t,      sector          )
 473                 __field( unsigned int,  nr_sector       )
 474                 __field( dev_t,         old_dev         )
 475                 __field( sector_t,      old_sector      )
 476                 __array( char,          rwbs,   RWBS_LEN)
 477         ),
 478
 479         TP_fast_assign(
 480                 __entry->dev            = bio_dev(bio);
 481                 __entry->sector         = bio->bi_iter.bi_sector;
 482                 __entry->nr_sector      = bio_sectors(bio);
 483                 __entry->old_dev        = dev;
 484                 __entry->old_sector     = from;
 485                 blk_fill_rwbs(__entry->rwbs, bio->bi_opf, bio->bi_iter.bi_size);
 486         ),
 487
 488         TP_printk("%d,%d %s %llu + %u <- (%d,%d) %llu",
 489                   MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
 490                   (unsigned long long)__entry->sector,
 491                   __entry->nr_sector,
 492                   MAJOR(__entry->old_dev), MINOR(__entry->old_dev),
 493                   (unsigned long long)__entry->old_sector)
 494 );
 495
 496 /**
 497  * block_rq_remap - map request for a block operation request
 498  * @q: queue holding the operation
 499  * @rq: block IO operation request
 500  * @dev: device for the operation
 501  * @from: original sector for the operation
 502  *
 503  * The block operation request @rq in @q has been remapped.  The block
 504  * operation request @rq holds the current information and @from hold
 505  * the original sector.
 506  */
 507 TRACE_EVENT(block_rq_remap,
 508
 509         TP_PROTO(struct request_queue *q, struct request *rq, dev_t dev,
 510                  sector_t from),
 511
 512         TP_ARGS(q, rq, dev, from),
 513
 514         TP_STRUCT__entry(
 515                 __field( dev_t,         dev             )
 516                 __field( sector_t,      sector          )
 517                 __field( unsigned int,  nr_sector       )
 518                 __field( dev_t,         old_dev         )
 519                 __field( sector_t,      old_sector      )
 520                 __field( unsigned int,  nr_bios         )
 521                 __array( char,          rwbs,   RWBS_LEN)
 522         ),
 523
 524         TP_fast_assign(
 525                 __entry->dev            = disk_devt(rq->rq_disk);
 526                 __entry->sector         = blk_rq_pos(rq);
 527                 __entry->nr_sector      = blk_rq_sectors(rq);
 528                 __entry->old_dev        = dev;
 529                 __entry->old_sector     = from;
 530                 __entry->nr_bios        = blk_rq_count_bios(rq);
 531                 blk_fill_rwbs(__entry->rwbs, rq->cmd_flags, blk_rq_bytes(rq));
 532         ),
 533
 534         TP_printk("%d,%d %s %llu + %u <- (%d,%d) %llu %u",
 535                   MAJOR(__entry->dev), MINOR(__entry->dev), __entry->rwbs,
 536                   (unsigned long long)__entry->sector,
 537                   __entry->nr_sector,
 538                   MAJOR(__entry->old_dev), MINOR(__entry->old_dev),
 539                   (unsigned long long)__entry->old_sector, __entry->nr_bios)
 540 );
 541
 542 #endif /* _TRACE_BLOCK_H */
 543
 544 /* This part must be outside protection */
 545 #include <trace/define_trace.h>
 546