root/fs/gfs2/trace_gfs2.h
/* SPDX-License-Identifier: GPL-2.0 */
#undef TRACE_SYSTEM
#define TRACE_SYSTEM gfs2

#if !defined(_TRACE_GFS2_H) || defined(TRACE_HEADER_MULTI_READ)
#define _TRACE_GFS2_H

#include <linux/tracepoint.h>

#include <linux/fs.h>
#include <linux/buffer_head.h>
#include <linux/dlmconstants.h>
#include <linux/gfs2_ondisk.h>
#include <linux/writeback.h>
#include <linux/ktime.h>
#include <linux/iomap.h>
#include "incore.h"
#include "glock.h"
#include "rgrp.h"

#define dlm_state_name(nn) { DLM_LOCK_##nn, #nn }
#define glock_trace_name(x) __print_symbolic(x,         \
                            dlm_state_name(IV),         \
                            dlm_state_name(NL),         \
                            dlm_state_name(CR),         \
                            dlm_state_name(CW),         \
                            dlm_state_name(PR),         \
                            dlm_state_name(PW),         \
                            dlm_state_name(EX))

#define block_state_name(x) __print_symbolic(x,                 \
                            { GFS2_BLKST_FREE, "free" },        \
                            { GFS2_BLKST_USED, "used" },        \
                            { GFS2_BLKST_DINODE, "dinode" },    \
                            { GFS2_BLKST_UNLINKED, "unlinked" })

#define TRACE_RS_DELETE  0
#define TRACE_RS_TREEDEL 1
#define TRACE_RS_INSERT  2
#define TRACE_RS_CLAIM   3

#define rs_func_name(x) __print_symbolic(x,     \
                                         { 0, "del " }, \
                                         { 1, "tdel" }, \
                                         { 2, "ins " }, \
                                         { 3, "clm " })

#define show_glock_flags(flags) __print_flags(flags, "",        \
        {(1UL << GLF_LOCK),                     "l" },          \
        {(1UL << GLF_DEMOTE),                   "D" },          \
        {(1UL << GLF_PENDING_DEMOTE),           "d" },          \
        {(1UL << GLF_DEMOTE_IN_PROGRESS),       "p" },          \
        {(1UL << GLF_DIRTY),                    "y" },          \
        {(1UL << GLF_LFLUSH),                   "f" },          \
        {(1UL << GLF_MAY_CANCEL),               "c" },          \
        {(1UL << GLF_HAVE_REPLY),               "r" },          \
        {(1UL << GLF_INITIAL),                  "a" },          \
        {(1UL << GLF_HAVE_FROZEN_REPLY),        "F" },          \
        {(1UL << GLF_LRU),                      "L" },          \
        {(1UL << GLF_OBJECT),                   "o" },          \
        {(1UL << GLF_BLOCKING),                 "b" },          \
        {(1UL << GLF_INSTANTIATE_NEEDED),       "n" },          \
        {(1UL << GLF_INSTANTIATE_IN_PROG),      "N" },          \
        {(1UL << GLF_TRY_TO_EVICT),             "e" },          \
        {(1UL << GLF_VERIFY_DELETE),            "E" },          \
        {(1UL << GLF_DEFER_DELETE),             "s" },          \
        {(1UL << GLF_CANCELING),                "C" })

#ifndef NUMPTY
#define NUMPTY
static inline u8 glock_trace_state(unsigned int state)
{
        switch(state) {
        case LM_ST_SHARED:
                return DLM_LOCK_PR;
        case LM_ST_DEFERRED:
                return DLM_LOCK_CW;
        case LM_ST_EXCLUSIVE:
                return DLM_LOCK_EX;
        }
        return DLM_LOCK_NL;
}
#endif

/* Section 1 - Locking
 *
 * Objectives:
 * Latency: Remote demote request to state change
 * Latency: Local lock request to state change
 * Latency: State change to lock grant
 * Correctness: Ordering of local lock state vs. I/O requests
 * Correctness: Responses to remote demote requests
 */

/* General glock state change (DLM lock request completes) */
TRACE_EVENT(gfs2_glock_state_change,

        TP_PROTO(const struct gfs2_glock *gl, unsigned int new_state),

        TP_ARGS(gl, new_state),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        u64,    glnum                   )
                __field(        u32,    gltype                  )
                __field(        u8,     cur_state               )
                __field(        u8,     new_state               )
                __field(        u8,     dmt_state               )
                __field(        u8,     tgt_state               )
                __field(        unsigned long,  flags           )
        ),

        TP_fast_assign(
                __entry->dev            = glock_sbd(gl)->sd_vfs->s_dev;
                __entry->glnum          = glock_number(gl);
                __entry->gltype         = glock_type(gl);
                __entry->cur_state      = glock_trace_state(gl->gl_state);
                __entry->new_state      = glock_trace_state(new_state);
                __entry->tgt_state      = glock_trace_state(gl->gl_target);
                __entry->dmt_state      = glock_trace_state(gl->gl_demote_state);
                __entry->flags          = gl->gl_flags | (gl->gl_object ? (1UL<<GLF_OBJECT) : 0);
        ),

        TP_printk("%u,%u glock %d:%lld state %s to %s tgt:%s dmt:%s flags:%s",
                  MAJOR(__entry->dev), MINOR(__entry->dev), __entry->gltype,
                 (unsigned long long)__entry->glnum,
                  glock_trace_name(__entry->cur_state),
                  glock_trace_name(__entry->new_state),
                  glock_trace_name(__entry->tgt_state),
                  glock_trace_name(__entry->dmt_state),
                  show_glock_flags(__entry->flags))
);

/* State change -> unlocked, glock is being deallocated */
TRACE_EVENT(gfs2_glock_put,

        TP_PROTO(const struct gfs2_glock *gl),

        TP_ARGS(gl),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        u64,    glnum                   )
                __field(        u32,    gltype                  )
                __field(        u8,     cur_state               )
                __field(        unsigned long,  flags           )
        ),

        TP_fast_assign(
                __entry->dev            = glock_sbd(gl)->sd_vfs->s_dev;
                __entry->gltype         = glock_type(gl);
                __entry->glnum          = glock_number(gl);
                __entry->cur_state      = glock_trace_state(gl->gl_state);
                __entry->flags          = gl->gl_flags  | (gl->gl_object ? (1UL<<GLF_OBJECT) : 0);
        ),

        TP_printk("%u,%u glock %d:%lld state %s => %s flags:%s",
                  MAJOR(__entry->dev), MINOR(__entry->dev),
                  __entry->gltype, (unsigned long long)__entry->glnum,
                  glock_trace_name(__entry->cur_state),
                  glock_trace_name(DLM_LOCK_IV),
                  show_glock_flags(__entry->flags))

);

/* Callback (local or remote) requesting lock demotion */
TRACE_EVENT(gfs2_demote_rq,

        TP_PROTO(const struct gfs2_glock *gl, bool remote),

        TP_ARGS(gl, remote),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        u64,    glnum                   )
                __field(        u32,    gltype                  )
                __field(        u8,     cur_state               )
                __field(        u8,     dmt_state               )
                __field(        unsigned long,  flags           )
                __field(        bool,   remote                  )
        ),

        TP_fast_assign(
                __entry->dev            = glock_sbd(gl)->sd_vfs->s_dev;
                __entry->gltype         = glock_type(gl);
                __entry->glnum          = glock_number(gl);
                __entry->cur_state      = glock_trace_state(gl->gl_state);
                __entry->dmt_state      = glock_trace_state(gl->gl_demote_state);
                __entry->flags          = gl->gl_flags  | (gl->gl_object ? (1UL<<GLF_OBJECT) : 0);
                __entry->remote         = remote;
        ),

        TP_printk("%u,%u glock %d:%lld demote %s to %s flags:%s %s",
                  MAJOR(__entry->dev), MINOR(__entry->dev), __entry->gltype,
                  (unsigned long long)__entry->glnum,
                  glock_trace_name(__entry->cur_state),
                  glock_trace_name(__entry->dmt_state),
                  show_glock_flags(__entry->flags),
                  __entry->remote ? "remote" : "local")

);

/* Promotion/grant of a glock */
TRACE_EVENT(gfs2_promote,

        TP_PROTO(const struct gfs2_holder *gh),

        TP_ARGS(gh),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        u64,    glnum                   )
                __field(        u32,    gltype                  )
                __field(        u8,     state                   )
        ),

        TP_fast_assign(
                __entry->dev    = glock_sbd(gh->gh_gl)->sd_vfs->s_dev;
                __entry->glnum  = glock_number(gh->gh_gl);
                __entry->gltype = glock_type(gh->gh_gl);
                __entry->state  = glock_trace_state(gh->gh_state);
        ),

        TP_printk("%u,%u glock %u:%llu promote %s",
                  MAJOR(__entry->dev), MINOR(__entry->dev), __entry->gltype,
                  (unsigned long long)__entry->glnum,
                  glock_trace_name(__entry->state))
);

/* Queue/dequeue a lock request */
TRACE_EVENT(gfs2_glock_queue,

        TP_PROTO(const struct gfs2_holder *gh, int queue),

        TP_ARGS(gh, queue),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        u64,    glnum                   )
                __field(        u32,    gltype                  )
                __field(        int,    queue                   )
                __field(        u8,     state                   )
        ),

        TP_fast_assign(
                __entry->dev    = glock_sbd(gh->gh_gl)->sd_vfs->s_dev;
                __entry->glnum  = glock_number(gh->gh_gl);
                __entry->gltype = glock_type(gh->gh_gl);
                __entry->queue  = queue;
                __entry->state  = glock_trace_state(gh->gh_state);
        ),

        TP_printk("%u,%u glock %u:%llu %squeue %s",
                  MAJOR(__entry->dev), MINOR(__entry->dev), __entry->gltype,
                  (unsigned long long)__entry->glnum,
                  __entry->queue ? "" : "de",
                  glock_trace_name(__entry->state))
);

/* DLM sends a reply to GFS2 */
TRACE_EVENT(gfs2_glock_lock_time,

        TP_PROTO(const struct gfs2_glock *gl, s64 tdiff),

        TP_ARGS(gl, tdiff),

        TP_STRUCT__entry(
                __field(        dev_t,  dev             )
                __field(        u64,    glnum           )
                __field(        u32,    gltype          )
                __field(        int,    status          )
                __field(        char,   flags           )
                __field(        s64,    tdiff           )
                __field(        u64,    srtt            )
                __field(        u64,    srttvar         )
                __field(        u64,    srttb           )
                __field(        u64,    srttvarb        )
                __field(        u64,    sirt            )
                __field(        u64,    sirtvar         )
                __field(        u64,    dcount          )
                __field(        u64,    qcount          )
        ),

        TP_fast_assign(
                __entry->dev            = glock_sbd(gl)->sd_vfs->s_dev;
                __entry->glnum          = glock_number(gl);
                __entry->gltype         = glock_type(gl);
                __entry->status         = gl->gl_lksb.sb_status;
                __entry->flags          = gl->gl_lksb.sb_flags;
                __entry->tdiff          = tdiff;
                __entry->srtt           = gl->gl_stats.stats[GFS2_LKS_SRTT];
                __entry->srttvar        = gl->gl_stats.stats[GFS2_LKS_SRTTVAR];
                __entry->srttb          = gl->gl_stats.stats[GFS2_LKS_SRTTB];
                __entry->srttvarb       = gl->gl_stats.stats[GFS2_LKS_SRTTVARB];
                __entry->sirt           = gl->gl_stats.stats[GFS2_LKS_SIRT];
                __entry->sirtvar        = gl->gl_stats.stats[GFS2_LKS_SIRTVAR];
                __entry->dcount         = gl->gl_stats.stats[GFS2_LKS_DCOUNT];
                __entry->qcount         = gl->gl_stats.stats[GFS2_LKS_QCOUNT];
        ),

        TP_printk("%u,%u glock %d:%lld status:%d flags:%02x tdiff:%lld srtt:%lld/%lld srttb:%lld/%lld sirt:%lld/%lld dcnt:%lld qcnt:%lld",
                  MAJOR(__entry->dev), MINOR(__entry->dev), __entry->gltype,
                  (unsigned long long)__entry->glnum,
                  __entry->status, __entry->flags,
                  (long long)__entry->tdiff,
                  (long long)__entry->srtt,
                  (long long)__entry->srttvar,
                  (long long)__entry->srttb,
                  (long long)__entry->srttvarb,
                  (long long)__entry->sirt,
                  (long long)__entry->sirtvar,
                  (long long)__entry->dcount,
                  (long long)__entry->qcount)
);

/* Section 2 - Log/journal
 *
 * Objectives:
 * Latency: Log flush time
 * Correctness: pin/unpin vs. disk I/O ordering
 * Performance: Log usage stats
 */

/* Pin/unpin a block in the log */
TRACE_EVENT(gfs2_pin,

        TP_PROTO(const struct gfs2_bufdata *bd, int pin),

        TP_ARGS(bd, pin),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        int,    pin                     )
                __field(        u32,    len                     )
                __field(        sector_t,       block           )
                __field(        u64,    ino                     )
        ),

        TP_fast_assign(
                __entry->dev            = glock_sbd(bd->bd_gl)->sd_vfs->s_dev;
                __entry->pin            = pin;
                __entry->len            = bd->bd_bh->b_size;
                __entry->block          = bd->bd_bh->b_blocknr;
                __entry->ino            = glock_number(bd->bd_gl);
        ),

        TP_printk("%u,%u log %s %llu/%lu inode %llu",
                  MAJOR(__entry->dev), MINOR(__entry->dev),
                  __entry->pin ? "pin" : "unpin",
                  (unsigned long long)__entry->block,
                  (unsigned long)__entry->len,
                  (unsigned long long)__entry->ino)
);

/* Flushing the log */
TRACE_EVENT(gfs2_log_flush,

        TP_PROTO(const struct gfs2_sbd *sdp, int start, u32 flags),

        TP_ARGS(sdp, start, flags),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        int,    start                   )
                __field(        u64,    log_seq                 )
                __field(        u32,    flags                   )
        ),

        TP_fast_assign(
                __entry->dev            = sdp->sd_vfs->s_dev;
                __entry->start          = start;
                __entry->log_seq        = sdp->sd_log_sequence;
                __entry->flags          = flags;
        ),

        TP_printk("%u,%u log flush %s %llu %llx",
                  MAJOR(__entry->dev), MINOR(__entry->dev),
                  __entry->start ? "start" : "end",
                  (unsigned long long)__entry->log_seq,
                  (unsigned long long)__entry->flags)
);

/* Reserving/releasing blocks in the log */
TRACE_EVENT(gfs2_log_blocks,

        TP_PROTO(const struct gfs2_sbd *sdp, int blocks),

        TP_ARGS(sdp, blocks),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        int,    blocks                  )
                __field(        int,    blks_free               )
        ),

        TP_fast_assign(
                __entry->dev            = sdp->sd_vfs->s_dev;
                __entry->blocks         = blocks;
                __entry->blks_free      = atomic_read(&sdp->sd_log_blks_free);
        ),

        TP_printk("%u,%u log reserve %d %d", MAJOR(__entry->dev),
                  MINOR(__entry->dev), __entry->blocks, __entry->blks_free)
);

/* Writing back the AIL */
TRACE_EVENT(gfs2_ail_flush,

        TP_PROTO(const struct gfs2_sbd *sdp, const struct writeback_control *wbc, int start),

        TP_ARGS(sdp, wbc, start),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        int, start                      )
                __field(        int, sync_mode                  )
                __field(        long, nr_to_write               )
        ),

        TP_fast_assign(
                __entry->dev            = sdp->sd_vfs->s_dev;
                __entry->start          = start;
                __entry->sync_mode      = wbc->sync_mode;
                __entry->nr_to_write    = wbc->nr_to_write;
        ),

        TP_printk("%u,%u ail flush %s %s %ld", MAJOR(__entry->dev),
                  MINOR(__entry->dev), __entry->start ? "start" : "end",
                  __entry->sync_mode == WB_SYNC_ALL ? "all" : "none",
                  __entry->nr_to_write)
);

/* Section 3 - bmap
 *
 * Objectives:
 * Latency: Bmap request time
 * Performance: Block allocator tracing
 * Correctness: Test of disard generation vs. blocks allocated
 */

/* Map an extent of blocks, possibly a new allocation */
TRACE_EVENT(gfs2_bmap,

        TP_PROTO(const struct gfs2_inode *ip, const struct buffer_head *bh,
                sector_t lblock, int create, int errno),

        TP_ARGS(ip, bh, lblock, create, errno),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        sector_t, lblock                )
                __field(        sector_t, pblock                )
                __field(        u64,    inum                    )
                __field(        unsigned long, state            )
                __field(        u32,    len                     )
                __field(        int,    create                  )
                __field(        int,    errno                   )
        ),

        TP_fast_assign(
                __entry->dev            = glock_sbd(ip->i_gl)->sd_vfs->s_dev;
                __entry->lblock         = lblock;
                __entry->pblock         = buffer_mapped(bh) ?  bh->b_blocknr : 0;
                __entry->inum           = ip->i_no_addr;
                __entry->state          = bh->b_state;
                __entry->len            = bh->b_size;
                __entry->create         = create;
                __entry->errno          = errno;
        ),

        TP_printk("%u,%u bmap %llu map %llu/%lu to %llu flags:%08lx %s %d",
                  MAJOR(__entry->dev), MINOR(__entry->dev),
                  (unsigned long long)__entry->inum,
                  (unsigned long long)__entry->lblock,
                  (unsigned long)__entry->len,
                  (unsigned long long)__entry->pblock,
                  __entry->state, __entry->create ? "create " : "nocreate",
                  __entry->errno)
);

TRACE_EVENT(gfs2_iomap_start,

        TP_PROTO(const struct gfs2_inode *ip, loff_t pos, ssize_t length,
                 u16 flags),

        TP_ARGS(ip, pos, length, flags),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        u64,    inum                    )
                __field(        loff_t, pos                     )
                __field(        ssize_t, length                 )
                __field(        u16,    flags                   )
        ),

        TP_fast_assign(
                __entry->dev            = glock_sbd(ip->i_gl)->sd_vfs->s_dev;
                __entry->inum           = ip->i_no_addr;
                __entry->pos            = pos;
                __entry->length         = length;
                __entry->flags          = flags;
        ),

        TP_printk("%u,%u bmap %llu iomap start %llu/%lu flags:%08x",
                  MAJOR(__entry->dev), MINOR(__entry->dev),
                  (unsigned long long)__entry->inum,
                  (unsigned long long)__entry->pos,
                  (unsigned long)__entry->length, (u16)__entry->flags)
);

TRACE_EVENT(gfs2_iomap_end,

        TP_PROTO(const struct gfs2_inode *ip, struct iomap *iomap, int ret),

        TP_ARGS(ip, iomap, ret),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        u64,    inum                    )
                __field(        loff_t, offset                  )
                __field(        ssize_t, length                 )
                __field(        sector_t, pblock                )
                __field(        u16,    flags                   )
                __field(        u16,    type                    )
                __field(        int,    ret                     )
        ),

        TP_fast_assign(
                __entry->dev            = glock_sbd(ip->i_gl)->sd_vfs->s_dev;
                __entry->inum           = ip->i_no_addr;
                __entry->offset         = iomap->offset;
                __entry->length         = iomap->length;
                __entry->pblock         = iomap->addr == IOMAP_NULL_ADDR ? 0 :
                                         (iomap->addr >> ip->i_inode.i_blkbits);
                __entry->flags          = iomap->flags;
                __entry->type           = iomap->type;
                __entry->ret            = ret;
        ),

        TP_printk("%u,%u bmap %llu iomap end %llu/%lu to %llu ty:%d flags:%08x rc:%d",
                  MAJOR(__entry->dev), MINOR(__entry->dev),
                  (unsigned long long)__entry->inum,
                  (unsigned long long)__entry->offset,
                  (unsigned long)__entry->length,
                  (long long)__entry->pblock,
                  (u16)__entry->type,
                  (u16)__entry->flags, __entry->ret)
);

/* Keep track of blocks as they are allocated/freed */
TRACE_EVENT(gfs2_block_alloc,

        TP_PROTO(const struct gfs2_inode *ip, struct gfs2_rgrpd *rgd,
                 u64 block, unsigned len, u8 block_state),

        TP_ARGS(ip, rgd, block, len, block_state),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        u64,    start                   )
                __field(        u64,    inum                    )
                __field(        u32,    len                     )
                __field(        u8,     block_state             )
                __field(        u64,    rd_addr                 )
                __field(        u32,    rd_free_clone           )
                __field(        u32,    rd_requested            )
                __field(        u32,    rd_reserved             )
        ),

        TP_fast_assign(
                __entry->dev            = glock_sbd(rgd->rd_gl)->sd_vfs->s_dev;
                __entry->start          = block;
                __entry->inum           = ip->i_no_addr;
                __entry->len            = len;
                __entry->block_state    = block_state;
                __entry->rd_addr        = rgd->rd_addr;
                __entry->rd_free_clone  = rgd->rd_free_clone;
                __entry->rd_requested   = rgd->rd_requested;
                __entry->rd_reserved    = rgd->rd_reserved;
        ),

        TP_printk("%u,%u bmap %llu alloc %llu/%lu %s rg:%llu rf:%u rq:%u rr:%u",
                  MAJOR(__entry->dev), MINOR(__entry->dev),
                  (unsigned long long)__entry->inum,
                  (unsigned long long)__entry->start,
                  (unsigned long)__entry->len,
                  block_state_name(__entry->block_state),
                  (unsigned long long)__entry->rd_addr,
                  __entry->rd_free_clone,
                  __entry->rd_requested,
                  __entry->rd_reserved)
);

/* Keep track of multi-block reservations as they are allocated/freed */
TRACE_EVENT(gfs2_rs,

        TP_PROTO(const struct gfs2_blkreserv *rs, u8 func),

        TP_ARGS(rs, func),

        TP_STRUCT__entry(
                __field(        dev_t,  dev                     )
                __field(        u64,    rd_addr                 )
                __field(        u32,    rd_free_clone           )
                __field(        u32,    rd_requested            )
                __field(        u32,    rd_reserved             )
                __field(        u64,    inum                    )
                __field(        u64,    start                   )
                __field(        u32,    requested               )
                __field(        u32,    reserved                )
                __field(        u8,     func                    )
        ),

        TP_fast_assign(
                __entry->dev            = rs->rs_rgd->rd_sbd->sd_vfs->s_dev;
                __entry->rd_addr        = rs->rs_rgd->rd_addr;
                __entry->rd_free_clone  = rs->rs_rgd->rd_free_clone;
                __entry->rd_requested   = rs->rs_rgd->rd_requested;
                __entry->rd_reserved    = rs->rs_rgd->rd_reserved;
                __entry->inum           = container_of(rs, struct gfs2_inode,
                                                       i_res)->i_no_addr;
                __entry->start          = rs->rs_start;
                __entry->requested      = rs->rs_requested;
                __entry->reserved       = rs->rs_reserved;
                __entry->func           = func;
        ),

        TP_printk("%u,%u bmap %llu resrv %llu rg:%llu rf:%u rq:%u rr:%u %s q:%u r:%u",
                  MAJOR(__entry->dev), MINOR(__entry->dev),
                  (unsigned long long)__entry->inum,
                  (unsigned long long)__entry->start,
                  (unsigned long long)__entry->rd_addr,
                  __entry->rd_free_clone,
                  __entry->rd_requested,
                  __entry->rd_reserved,
                  rs_func_name(__entry->func),
                  __entry->requested,
                  __entry->reserved)
);

#endif /* _TRACE_GFS2_H */

/* This part must be outside protection */
#undef TRACE_INCLUDE_PATH
#define TRACE_INCLUDE_PATH .
#define TRACE_INCLUDE_FILE trace_gfs2
#include <trace/define_trace.h>