Viewing: lprocfs_status.h
/* SPDX-License-Identifier: GPL-2.0 */
/*
* Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
* Use is subject to license terms.
*
* Copyright (c) 2011, 2017, Intel Corporation.
*/
/*
* This file is part of Lustre, http://www.lustre.org/
*
* Top level header file for LProc
*
* Author: Hariharan Thantry thantry@users.sourceforge.net
*/
#ifndef _LPROCFS_STATUS_H
#define _LPROCFS_STATUS_H
#include <linux/fs.h>
#include <linux/debugfs.h>
#include <linux/kref.h>
#include <lustre_compat/linux/proc_fs.h>
#include <linux/rwsem.h>
#include <linux/spinlock.h>
#include <linux/string_helpers.h>
#include <linux/seq_file.h>
#include <lustre_compat/linux/sysfs.h>
#include <uapi/linux/lustre/lustre_idl.h>
/*
* Liuux 5.6 introduces proc_ops with v5.5-8862-gd56c0d45f0e2
* Now that proc and debugfs use separate operation vector types
* separate containers are also needed.
*/
struct lprocfs_vars {
const char *name;
const struct proc_ops *fops;
void *data;
/** /proc file mode. */
mode_t proc_mode;
};
/** Provide a debugfs container */
struct ldebugfs_vars {
const char *name;
const struct file_operations *fops;
void *data;
/** debugfs file mode. */
mode_t proc_mode;
};
static inline unsigned int pct(unsigned long a, unsigned long b)
{
return b ? a * 100 / b : 0;
}
#define PAGES_TO_MiB(pages) ((pages) >> (20 - PAGE_SHIFT))
#define MiB_TO_PAGES(mb) ((mb) << (20 - PAGE_SHIFT))
/**
* Append a space separated list of current set flags to str.
*/
#define flag2str(port, flag) \
do { \
if (test_bit(flag, (port)->port##_flags)) { \
seq_printf(m, "%s" #flag, first ? "" : ", "); \
first = false; \
} \
} while (0)
void obd_connect_seq_flags2str(struct seq_file *m, __u64 flags, __u64 flags2,
const char *sep);
void obd_connect_data_seqprint(struct seq_file *m,
struct obd_connect_data *ocd);
/* if we find more consumers this could be generalized */
#define OBD_HIST_MAX 32
struct obd_histogram {
spinlock_t oh_lock;
unsigned long oh_buckets[OBD_HIST_MAX];
};
struct obd_hist_pcpu {
struct percpu_counter oh_pc_buckets[OBD_HIST_MAX];
bool oh_initialized;
};
/* An lprocfs counter can be configured using the enum bit masks below.
*
* LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
* protects this counter from concurrent updates. If not specified,
* lprocfs an internal per-counter lock variable. External locks are
* not used to protect counter increments, but are used to protect
* counter readout and resets.
*
* LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
* (i.e. counter can be incremented by more than "1"). When specified,
* the counter maintains min, max and sum in addition to a simple
* invocation count. This allows averages to be be computed.
* If not specified, the counter is an increment-by-1 counter.
* min, max, sum, etc. are not maintained.
*
* LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
* squares (for multi-valued counter samples only). This allows
* external computation of standard deviation, but involves a 64-bit
* multiply per counter increment.
*
* LPROCFS_CNTR_HISTOGRAM indicates that the counter should track a
* exponential histogram.
*/
enum lprocfs_counter_config {
LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
LPROCFS_CNTR_AVGMINMAX = 0x0002,
LPROCFS_CNTR_STDDEV = 0x0004,
LPROCFS_CNTR_HISTOGRAM = 0x0008,
/* counter unit type */
LPROCFS_TYPE_REQS = 0x0000, /* default if config = 0 */
LPROCFS_TYPE_BYTES = 0x0200,
LPROCFS_TYPE_PAGES = 0x0400,
LPROCFS_TYPE_LOCKS = 0x0500,
LPROCFS_TYPE_LOCKSPS = 0x0600,
LPROCFS_TYPE_SECS = 0x0700,
LPROCFS_TYPE_USECS = 0x0800,
LPROCFS_TYPE_MASK = 0x0f00,
LPROCFS_TYPE_LATENCY = LPROCFS_TYPE_USECS |
LPROCFS_CNTR_AVGMINMAX |
LPROCFS_CNTR_STDDEV,
LPROCFS_TYPE_BYTES_FULL = LPROCFS_TYPE_BYTES |
LPROCFS_CNTR_AVGMINMAX |
LPROCFS_CNTR_STDDEV,
LPROCFS_TYPE_BYTES_FULL_HISTOGRAM = LPROCFS_TYPE_BYTES_FULL |
LPROCFS_CNTR_HISTOGRAM,
};
#define LC_MIN_INIT ((~(__u64)0) >> 1)
struct lprocfs_counter_header {
enum lprocfs_counter_config lc_config;
const char *lc_name; /* must be static */
const char *lc_units; /* must be static */
struct obd_histogram *lc_hist;
};
struct lprocfs_counter {
__s64 lc_count;
__s64 lc_min;
__s64 lc_max;
__s64 lc_sum;
__s64 lc_sumsquare;
};
struct lprocfs_percpu {
DECLARE_FLEX_ARRAY(struct lprocfs_counter, lp_cntr);
};
enum lprocfs_stats_lock_ops {
LPROCFS_GET_NUM_CPU = 0x0001, /* number allocated per-CPU stats */
LPROCFS_GET_SMP_ID = 0x0002, /* current stat to be updated */
};
enum lprocfs_stats_flags {
LPROCFS_STATS_FLAG_NONE = 0x0000, /* per cpu counter */
LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* need locking(no percpu area) */
};
enum lprocfs_fields_flags {
LPROCFS_FIELDS_FLAGS_CONFIG = 0x0001,
LPROCFS_FIELDS_FLAGS_SUM = 0x0002,
LPROCFS_FIELDS_FLAGS_MIN = 0x0003,
LPROCFS_FIELDS_FLAGS_MAX = 0x0004,
LPROCFS_FIELDS_FLAGS_AVG = 0x0005,
LPROCFS_FIELDS_FLAGS_SUMSQUARE = 0x0006,
LPROCFS_FIELDS_FLAGS_COUNT = 0x0007,
};
struct lprocfs_stats {
/* source for the stats */
char ls_source[MAX_OBD_NAME * 4];
/* index in Xarray */
unsigned int ls_index;
/* # of counters */
unsigned short ls_num;
/* track reference */
struct kref ls_refcount;
/* 1 + the biggest cpu # whose ls_percpu slot has been allocated */
unsigned short ls_biggest_alloc_num;
enum lprocfs_stats_flags ls_flags;
ktime_t ls_init;
/* Lock used when there are no percpu stats areas; For percpu stats,
* it is used to protect ls_biggest_alloc_num change
*/
spinlock_t ls_lock;
/* has ls_num of counter headers */
struct lprocfs_counter_header *ls_cnt_header;
struct lprocfs_percpu *ls_percpu[];
};
#define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
/* Pack all opcodes down into a single monotonically increasing index */
static inline int opcode_offset(__u32 opc)
{
if (opc < OST_LAST_OPC) {
/* OST opcode */
return (opc - OST_FIRST_OPC);
} else if (opc < MDS_LAST_OPC) {
/* MDS opcode */
return (opc - MDS_FIRST_OPC +
OPC_RANGE(OST));
} else if (opc < LDLM_LAST_OPC) {
/* LDLM Opcode */
return (opc - LDLM_FIRST_OPC +
OPC_RANGE(MDS) +
OPC_RANGE(OST));
} else if (opc < MGS_LAST_OPC) {
/* MGS Opcode */
return (opc - MGS_FIRST_OPC +
OPC_RANGE(LDLM) +
OPC_RANGE(MDS) +
OPC_RANGE(OST));
} else if (opc < OBD_LAST_OPC) {
/* OBD Ping */
return (opc - OBD_FIRST_OPC +
OPC_RANGE(MGS) +
OPC_RANGE(LDLM) +
OPC_RANGE(MDS) +
OPC_RANGE(OST));
} else if (opc < LLOG_LAST_OPC) {
/* LLOG Opcode */
return (opc - LLOG_FIRST_OPC +
OPC_RANGE(OBD) +
OPC_RANGE(MGS) +
OPC_RANGE(LDLM) +
OPC_RANGE(MDS) +
OPC_RANGE(OST));
} else if (opc < QUOTA_LAST_OPC) {
/* LQUOTA Opcode */
return (opc - QUOTA_FIRST_OPC +
OPC_RANGE(LLOG) +
OPC_RANGE(OBD) +
OPC_RANGE(MGS) +
OPC_RANGE(LDLM) +
OPC_RANGE(MDS) +
OPC_RANGE(OST));
} else if (opc < SEQ_LAST_OPC) {
/* SEQ opcode */
return (opc - SEQ_FIRST_OPC +
OPC_RANGE(QUOTA) +
OPC_RANGE(LLOG) +
OPC_RANGE(OBD) +
OPC_RANGE(MGS) +
OPC_RANGE(LDLM) +
OPC_RANGE(MDS) +
OPC_RANGE(OST));
} else if (opc < SEC_LAST_OPC) {
/* SEC opcode */
return (opc - SEC_FIRST_OPC +
OPC_RANGE(SEQ) +
OPC_RANGE(QUOTA) +
OPC_RANGE(LLOG) +
OPC_RANGE(OBD) +
OPC_RANGE(MGS) +
OPC_RANGE(LDLM) +
OPC_RANGE(MDS) +
OPC_RANGE(OST));
} else if (opc < FLD_LAST_OPC) {
/* FLD opcode */
return (opc - FLD_FIRST_OPC +
OPC_RANGE(SEC) +
OPC_RANGE(SEQ) +
OPC_RANGE(QUOTA) +
OPC_RANGE(LLOG) +
OPC_RANGE(OBD) +
OPC_RANGE(MGS) +
OPC_RANGE(LDLM) +
OPC_RANGE(MDS) +
OPC_RANGE(OST));
#ifdef CONFIG_LUSTRE_FS_SERVER
} else if (opc < OUT_UPDATE_LAST_OPC) {
/* update opcode */
return (opc - OUT_UPDATE_FIRST_OPC +
OPC_RANGE(FLD) +
OPC_RANGE(SEC) +
OPC_RANGE(SEQ) +
OPC_RANGE(QUOTA) +
OPC_RANGE(LLOG) +
OPC_RANGE(OBD) +
OPC_RANGE(MGS) +
OPC_RANGE(LDLM) +
OPC_RANGE(MDS) +
OPC_RANGE(OST));
} else if (opc < LFSCK_LAST_OPC) {
/* LFSCK opcode */
return (opc - LFSCK_FIRST_OPC +
OPC_RANGE(OUT_UPDATE) +
OPC_RANGE(FLD) +
OPC_RANGE(SEC) +
OPC_RANGE(SEQ) +
OPC_RANGE(QUOTA) +
OPC_RANGE(LLOG) +
OPC_RANGE(OBD) +
OPC_RANGE(MGS) +
OPC_RANGE(LDLM) +
OPC_RANGE(MDS) +
OPC_RANGE(OST));
#endif /* CONFIG_LUSTRE_FS_SERVER */
} else {
/* Unknown Opcode */
return -1;
}
}
#define LUSTRE_MAX_OPCODES_CLIENT (OPC_RANGE(OST) + \
OPC_RANGE(MDS) + \
OPC_RANGE(LDLM) + \
OPC_RANGE(MGS) + \
OPC_RANGE(OBD) + \
OPC_RANGE(LLOG) + \
OPC_RANGE(SEC) + \
OPC_RANGE(SEQ) + \
OPC_RANGE(SEC) + \
OPC_RANGE(FLD))
#ifdef CONFIG_LUSTRE_FS_SERVER
#define LUSTRE_MAX_OPCODES (LUSTRE_MAX_OPCODES_CLIENT + \
OPC_RANGE(OUT_UPDATE) + \
OPC_RANGE(LFSCK))
#else
#define LUSTRE_MAX_OPCODES LUSTRE_MAX_OPCODES_CLIENT
#endif
#define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR) + \
OPC_RANGE(EXTRA))
enum {
PTLRPC_REQWAIT_CNTR = 0,
PTLRPC_REQQDEPTH_CNTR,
PTLRPC_REQACTIVE_CNTR,
PTLRPC_TIMEOUT,
PTLRPC_REQBUF_AVAIL_CNTR,
PTLRPC_LAST_CNTR
};
#define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
enum lprocfs_extra_opc {
LDLM_GLIMPSE_ENQUEUE = 0,
LDLM_PLAIN_ENQUEUE,
LDLM_EXTENT_ENQUEUE,
LDLM_FLOCK_ENQUEUE,
LDLM_IBITS_ENQUEUE,
MDS_REINT_SETATTR,
MDS_REINT_CREATE,
MDS_REINT_LINK,
MDS_REINT_UNLINK,
MDS_REINT_RENAME,
MDS_REINT_OPEN,
MDS_REINT_SETXATTR,
MDS_REINT_RESYNC,
BRW_READ_BYTES,
BRW_WRITE_BYTES,
EXTRA_LAST_OPC
};
#ifdef CONFIG_LUSTRE_FS_SERVER
enum brw_rw_stats {
BRW_R_PAGES = 0,
BRW_W_PAGES,
BRW_R_DISCONT_PAGES,
BRW_W_DISCONT_PAGES,
BRW_R_DISCONT_BLOCKS,
BRW_W_DISCONT_BLOCKS,
BRW_R_DIO_FRAGS,
BRW_W_DIO_FRAGS,
BRW_R_RPC_HIST,
BRW_W_RPC_HIST,
BRW_R_IO_TIME,
BRW_W_IO_TIME,
BRW_R_DISK_IOSIZE,
BRW_W_DISK_IOSIZE,
BRW_MAP_TIME,
BRW_ALLOC_TIME,
BRW_RW_STATS_NUM,
};
struct brw_stats_props {
const char *bsp_name;
const char *bsp_units;
bool bsp_scale;
};
/* hard to get PTLRPC_MAX_BRW_BITS here, verified in lprocfs_init_brw_stats() */
#define IO_LATENCY_BUCKETS (26 - 12 + 1) /* (PTLRPC_MAX_BRW_BITS - PAGE_SHIFT) */
struct brw_stats {
ktime_t bs_init;
struct obd_hist_pcpu bs_hist[BRW_RW_STATS_NUM];
struct brw_stats_props bs_props[BRW_RW_STATS_NUM / 2];
bool bs_inflight_io_log2;
/* latency_by_size index log2(pages), stores "binary usec" (ns >> 10) */
ktime_t bs_io_latency_init;
struct obd_hist_pcpu bs_read_io_latency_by_size[IO_LATENCY_BUCKETS];
struct obd_hist_pcpu bs_write_io_latency_by_size[IO_LATENCY_BUCKETS];
u32 bs_max_pages_per_rpc;
spinlock_t bs_loi_list_lock;
char *bs_devname;
};
int lprocfs_init_brw_stats(struct brw_stats *brw_stats);
void lprocfs_fini_brw_stats(struct brw_stats *brw_stats);
void ldebugfs_register_brw_stats(struct dentry *parent,
struct brw_stats *brw_stats);
void ldebugfs_register_io_latency_stats(struct dentry *parent,
struct brw_stats *brw_stats);
#endif /* CONFIG_LUSTRE_FS_SERVER */
#define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
/* class_obd.c */
extern struct proc_dir_entry *proc_lustre_root;
extern struct dentry *debugfs_lustre_root;
extern struct kset *lustre_kset;
struct obd_device;
#define JOBSTATS_JOBID_VAR_MAX_LEN 20
#define JOBSTATS_DISABLE "disable"
#define JOBSTATS_PROCNAME_UID "procname_uid"
#define JOBSTATS_NODELOCAL "nodelocal"
#define JOBSTATS_SESSION "session"
enum ojb_info_flags {
OJS_CLEANING, /* job cleaning is in operation */
OJS_HEADER, /* seq_show() header */
OJS_ACTIVE_JOBS, /* set while ojs_jobs > 0 */
OJS_FINI, /* set at _fini */
};
typedef void (*cntr_init_callback)(struct lprocfs_stats *stats,
unsigned int offset,
enum lprocfs_counter_config cntr_umask);
struct obd_job_stats {
struct rb_root ojs_idtree; /* root sorted on js_jobid */
struct rb_root ojs_postree; /* unique id (temporal) root */
atomic64_t ojs_next_pos; /* generate next unique id */
struct rw_semaphore ojs_rwsem; /* rbtree locking */
struct list_head ojs_lru; /* least recently used */
struct llist_head ojs_deleted; /* zero-ref to be purged */
unsigned long ojs_flags; /* see: ojb_info_flags */
atomic_t ojs_readers; /* active readers */
spinlock_t ojs_lock; /* protect ojs_lru/js_lru */
ktime_t ojs_cleanup_interval;/* 1/2 expiry seconds */
ktime_t ojs_cleanup_last;/* previous cleanup time */
cntr_init_callback ojs_cntr_init_fn;/* lprocfs_stats initializer */
unsigned short ojs_cntr_num; /* number of stats in struct */
atomic64_t ojs_jobs; /* number of jobs */
};
#ifdef CONFIG_PROC_FS
int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
unsigned int cpuid);
int lprocfs_stats_lock(struct lprocfs_stats *stats,
enum lprocfs_stats_lock_ops opc,
unsigned long *flags);
void lprocfs_stats_unlock(struct lprocfs_stats *stats,
enum lprocfs_stats_lock_ops opc,
unsigned long *flags);
static inline unsigned int
lprocfs_stats_counter_size(struct lprocfs_stats *stats)
{
unsigned int percpusize;
percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
percpusize = L1_CACHE_ALIGN(percpusize);
return percpusize;
}
static inline struct lprocfs_counter *
lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
int index)
{
struct lprocfs_counter *cntr;
cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
return cntr;
}
/* Two optimized LPROCFS counter increment functions are provided:
* lprocfs_counter_incr(cntr, value) - optimized for by-one counters
* lprocfs_counter_add(cntr) - use for multi-valued counters
* Counter data layout allows config flag, counter lock and the
* count itself to reside within a single cache line.
*/
extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
long amount);
extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
long amount);
#define lprocfs_counter_incr(stats, idx) \
lprocfs_counter_add(stats, idx, 1)
#define lprocfs_counter_decr(stats, idx) \
lprocfs_counter_sub(stats, idx, 1)
extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
struct lprocfs_counter_header *header,
enum lprocfs_stats_flags flags,
enum lprocfs_fields_flags field);
u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
enum lprocfs_fields_flags field);
extern struct lprocfs_stats *
lprocfs_stats_alloc(unsigned int num, enum lprocfs_stats_flags flags);
extern void lprocfs_stats_clear(struct lprocfs_stats *stats);
extern void lprocfs_stats_free(struct lprocfs_stats **stats);
extern struct lprocfs_stats *lprocfs_stats_dup(struct lprocfs_stats *stats);
extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
struct lprocfs_stats *ldebugfs_stats_alloc(int num, char *name,
struct dentry *entry,
enum lprocfs_stats_flags flags);
extern int ldebugfs_alloc_obd_stats(struct obd_device *obd,
unsigned int num_stats);
extern int lprocfs_alloc_md_stats(struct obd_device *obd,
unsigned int num_private_stats);
#define binary_usec_to_dec(b) (((b) / 1000) * 1024 + ((b) % 1000) * 1024 / 1000)
void obd_io_latency_stats_clear(struct obd_histogram *read_io_latency_by_size,
struct obd_histogram *write_io_latency_by_size,
int num_buckets, ktime_t *stats_init);
extern int obd_io_latency_stats_seq_show(struct seq_file *seq,
struct obd_histogram *read_io_latency_by_size,
struct obd_histogram *write_io_latency_by_size,
int num_buckets, ktime_t stats_init,
spinlock_t *list_lock);
extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
enum lprocfs_counter_config config,
const char *name);
extern void lprocfs_counter_init_units(struct lprocfs_stats *stats, int index,
enum lprocfs_counter_config config,
const char *name, const char *units);
extern void ldebugfs_free_obd_stats(struct obd_device *obd);
extern void lprocfs_free_md_stats(struct obd_device *obd);
struct obd_export;
struct nid_stat;
extern int lprocfs_add_clear_entry(struct obd_device *obd,
struct proc_dir_entry *entry);
#ifdef CONFIG_LUSTRE_FS_SERVER
extern int lprocfs_exp_setup(struct obd_export *exp, struct lnet_nid *peer_nid);
extern int lprocfs_exp_cleanup(struct obd_export *exp);
#else
static inline int lprocfs_exp_cleanup(struct obd_export *exp)
{ return 0; }
#endif
extern struct proc_dir_entry *
lprocfs_add_simple(struct proc_dir_entry *root, char *name,
void *data, const struct proc_ops *ops);
extern struct proc_dir_entry *
lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
const char *format, ...);
struct dentry *ldebugfs_add_symlink(const char *name, const char *target,
const char *format, ...);
extern void lprocfs_free_per_client_stats(struct obd_device *obd);
#ifdef CONFIG_LUSTRE_FS_SERVER
extern ssize_t
ldebugfs_nid_stats_clear_seq_write(struct file *file, const char __user *buffer,
size_t count, loff_t *off);
extern int lprocfs_nid_stats_clear_seq_show(struct seq_file *file, void *data);
#endif
extern int lprocfs_stats_register(struct proc_dir_entry *root, const char *name,
struct lprocfs_stats *stats);
extern const struct file_operations ldebugfs_stats_seq_fops;
/* lprocfs_status.c */
extern void ldebugfs_add_vars(struct dentry *parent, struct ldebugfs_vars *var,
void *data);
extern struct dentry *ldebugfs_register(const char *name,
struct dentry *parent,
struct ldebugfs_vars *list,
void *data);
extern int lprocfs_add_vars(struct proc_dir_entry *root,
struct lprocfs_vars *var, void *data);
extern struct proc_dir_entry *
lprocfs_register(const char *name, struct proc_dir_entry *parent,
struct lprocfs_vars *list, void *data);
extern void lprocfs_remove(struct proc_dir_entry **root);
extern void lprocfs_remove_proc_entry(const char *name,
struct proc_dir_entry *parent);
extern int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only);
extern int lprocfs_obd_cleanup(struct obd_device *obd);
extern int lprocfs_seq_create(struct proc_dir_entry *parent, const char *name,
mode_t mode, const struct proc_ops *seq_fops,
void *data);
extern int lprocfs_obd_seq_create(struct obd_device *obd, const char *name,
mode_t mode, const struct proc_ops *seq_fops,
void *data);
extern void lprocfs_stats_header(struct seq_file *seq, ktime_t now,
ktime_t ts_init, int width, const char *colon,
bool show_units, const char *prefix);
extern unsigned int obd_enable_stats_header;
/* Generic callbacks */
extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
ssize_t conn_uuid_show(struct kobject *kobj, struct attribute *attr, char *buf);
extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
#ifdef CONFIG_LUSTRE_FS_SERVER
ssize_t num_exports_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t grant_check_threshold_show(struct kobject *kobj,
struct attribute *attr, char *buf);
ssize_t grant_check_threshold_store(struct kobject *kobj,
struct attribute *attr,
const char *buffer, size_t count);
ssize_t eviction_count_show(struct kobject *kobj, struct attribute *attr,
char *buf);
#endif
struct adaptive_timeout;
extern int lprocfs_at_hist_helper(struct seq_file *m,
struct adaptive_timeout *at);
extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
extern ssize_t
lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
size_t count, loff_t *off);
#ifdef CONFIG_LUSTRE_FS_SERVER
ssize_t evict_client_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count);
#endif
ssize_t ping_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count);
ssize_t ping_show(struct kobject *kobj, struct attribute *attr,
char *buffer);
extern ssize_t
ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
size_t count, loff_t *off);
static inline ssize_t
lprocfs_import_seq_write(struct file *file, const char __user *buffer,
size_t count, loff_t *off)
{
return ldebugfs_import_seq_write(file, buffer, count, off);
}
ssize_t pinger_recov_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t pinger_recov_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count);
int string_to_size(u64 *size, const char *buffer, size_t count);
int sysfs_memparse_total(const char *buffer, size_t count, u64 *val,
u64 total, const char *defunit);
int sysfs_memparse(const char *buffer, size_t count, u64 *val,
const char *defunit);
char *lprocfs_find_named_value(const char *buffer, const char *name,
size_t *count);
void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
void lprocfs_oh_clear(struct obd_histogram *oh);
unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
void lprocfs_oh_tally_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
void lprocfs_oh_tally_log2_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
int lprocfs_oh_alloc_pcpu(struct obd_hist_pcpu *oh);
void lprocfs_oh_clear_pcpu(struct obd_hist_pcpu *oh);
void lprocfs_oh_release_pcpu(struct obd_hist_pcpu *oh);
unsigned long lprocfs_oh_sum_pcpu(struct obd_hist_pcpu *oh);
unsigned long lprocfs_oh_counter_pcpu(struct obd_hist_pcpu *oh,
unsigned int value);
void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
struct lprocfs_counter *cnt);
/* lprocfs_status.c: dump pages on cksum error */
ssize_t checksum_type_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t checksum_type_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count);
#ifdef CONFIG_LUSTRE_FS_SERVER
ssize_t dt_checksum_type_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t dt_checksum_dump_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t dt_checksum_dump_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count);
#ifdef CONFIG_PROC_FS
int lprocfs_checksum_dump_seq_show(struct seq_file *m, void *data);
#endif
ssize_t
lprocfs_checksum_dump_seq_write(struct file *file, const char __user *buffer,
size_t count, loff_t *off);
/* lprocfs_status.c: recovery status */
int lprocfs_recovery_status_seq_show(struct seq_file *m, void *data);
/* lprocfs: display the uuid of stale clients */
int lprocfs_recovery_stale_clients_seq_show(struct seq_file *m, void *data);
/* lprocfs_status.c: hash statistics */
int lprocfs_hash_seq_show(struct seq_file *m, void *data);
/* lprocfs_status.c: IR factor */
ssize_t ir_factor_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t ir_factor_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count);
#endif
/* You must use these macros when you want to refer to
* the import in a client obd_device for a lprocfs entry
* Note that it is not safe to 'goto', 'return' or 'break'
* out of the body of this statement. It *IS* safe to
* 'goto' the a label inside the statement, or to 'continue'
* to get out of the statement.
*/
/*
* The macro uses a for loop that executes a block of code maximum once.
* It allows for local variable declarations.
*
* Initialization: Lock Acquisition and Import Retrieval:
* --------------
* for (down_read_nested(&(__obd)->u.cli.cl_sem, __nest),
* __imp = (__obd)->u.cli.cl_import,
* __rc = __imp ? 0 : -ENODEV;
* It acquires a read lock,
* retrieves the import pointer and stores it in __imp,
* sets the return code __rc
* to 0 (success) if __imp is not NULL, or
* to _ENODEV (failure) if __imp is NULL
*
* Condition: Conditional Lock Release:
* ---------
* __imp ? 1 : (up_read(&(__obd)->u.cli.cl_sem), 0);
*
* If __imp is not NULL, it evaluates to 1, and nothing happens.
* This means the lock is kept as long as a valid import was obtained.
* If __imp is NULL, then it releases the read lock and evaluates to 0.
*
* Update: Nulling the Import Pointer
* ------
* __imp = NULL)
*
* sets __imp to NULL. This will break out of the for loop, releasing the
* semaphore in the condition.
*/
#define with_imp_locked_nested(__obd, __imp, __rc, __nest) \
for (down_read_nested(&(__obd)->u.cli.cl_sem, __nest), \
__imp = (__obd)->u.cli.cl_import, \
__rc = __imp ? 0 : -ENODEV; \
__imp ? 1 : (up_read(&(__obd)->u.cli.cl_sem), 0); \
__imp = NULL)
#define with_imp_locked(__obd, __imp, __rc) \
with_imp_locked_nested(__obd, __imp, __rc, 0)
/* write the name##_seq_show function, call LDEBUGFS_SEQ_FOPS_RO for read-only
* debugfs entries; otherwise, you will define name##_seq_write function also
* for a read-write debugfs entry, and then call LDEBUGFS_SEQ_FOPS instead.
* Finally, call debugfs_create_file(filename, 0444, obd, data, &name#_fops);
*/
#define __LDEBUGFS_SEQ_FOPS(name, custom_seq_write) \
static int name##_single_open(struct inode *inode, struct file *file) \
{ \
return single_open(file, name##_seq_show, inode->i_private); \
} \
static const struct file_operations name##_fops = { \
.owner = THIS_MODULE, \
.open = name##_single_open, \
.read = seq_read, \
.write = custom_seq_write, \
.llseek = seq_lseek, \
.release = single_release, \
}
#define LDEBUGFS_SEQ_FOPS_RO(name) __LDEBUGFS_SEQ_FOPS(name, NULL)
#define LDEBUGFS_SEQ_FOPS(name) __LDEBUGFS_SEQ_FOPS(name, \
name##_seq_write)
#define LDEBUGFS_SEQ_FOPS_RO_TYPE(name, type) \
static int name##_##type##_seq_show(struct seq_file *m, void *v)\
{ \
if (!m->private) \
return -ENODEV; \
return lprocfs_##type##_seq_show(m, m->private); \
} \
LDEBUGFS_SEQ_FOPS_RO(name##_##type)
#define LDEBUGFS_SEQ_FOPS_RW_TYPE(name, type) \
static int name##_##type##_seq_show(struct seq_file *m, void *v)\
{ \
if (!m->private) \
return -ENODEV; \
return lprocfs_##type##_seq_show(m, m->private); \
} \
static ssize_t name##_##type##_seq_write(struct file *file, \
const char __user *buffer, size_t count, \
loff_t *off) \
{ \
struct seq_file *seq = file->private_data; \
\
if (!seq->private) \
return -ENODEV; \
return ldebugfs_##type##_seq_write(file, buffer, count, \
seq->private); \
} \
LDEBUGFS_SEQ_FOPS(name##_##type);
#define LDEBUGFS_FOPS_WR_ONLY(name, type) \
static ssize_t name##_##type##_write(struct file *file, \
const char __user *buffer, size_t count, \
loff_t *off) \
{ \
return ldebugfs_##type##_seq_write(file, buffer, count, \
off); \
} \
static int name##_##type##_open(struct inode *inode, \
struct file *file) \
{ \
return single_open(file, NULL, inode->i_private); \
} \
static const struct file_operations name##_##type##_fops = { \
.open = name##_##type##_open, \
.write = name##_##type##_write, \
.release = single_release, \
};
/* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
* proc entries; otherwise, you will define name##_seq_write function also for
* a read-write proc entry, and then call LPROC_SEQ_FOPS instead. Finally,
* call ldebugfs_obd_seq_create(obd, filename, 0444, &name#_fops, data);
*/
#define __LPROC_SEQ_FOPS(name, custom_seq_write) \
static int name##_single_open(struct inode *inode, struct file *file) \
{ \
return single_open(file, name##_seq_show, \
inode->i_private ? inode->i_private : \
pde_data(inode)); \
} \
static const struct proc_ops name##_fops = { \
PROC_OWNER(THIS_MODULE) \
.proc_open = name##_single_open, \
.proc_read = seq_read, \
.proc_write = custom_seq_write, \
.proc_lseek = seq_lseek, \
.proc_release = single_release, \
}
#define LPROC_SEQ_FOPS_RO(name) __LPROC_SEQ_FOPS(name, NULL)
#define LPROC_SEQ_FOPS(name) __LPROC_SEQ_FOPS(name, name##_seq_write)
#define LPROC_SEQ_FOPS_RO_TYPE(name, type) \
static int name##_##type##_seq_show(struct seq_file *m, void *v)\
{ \
return lprocfs_##type##_seq_show(m, m->private); \
} \
LPROC_SEQ_FOPS_RO(name##_##type)
#define LPROC_SEQ_FOPS_RW_TYPE(name, type) \
static int name##_##type##_seq_show(struct seq_file *m, void *v)\
{ \
return lprocfs_##type##_seq_show(m, m->private); \
} \
static ssize_t name##_##type##_seq_write(struct file *file, \
const char __user *buffer, size_t count, \
loff_t *off) \
{ \
struct seq_file *seq = file->private_data; \
return lprocfs_##type##_seq_write(file, buffer, \
count, seq->private); \
} \
LPROC_SEQ_FOPS(name##_##type);
#define LPROC_SEQ_FOPS_WR_ONLY(name, type) \
static ssize_t name##_##type##_write(struct file *file, \
const char __user *buffer, size_t count, \
loff_t *off) \
{ \
return lprocfs_##type##_seq_write(file, buffer, count, off);\
} \
static int name##_##type##_open(struct inode *inode, struct file *file)\
{ \
return single_open(file, NULL, \
inode->i_private ? inode->i_private : \
pde_data(inode)); \
} \
static const struct proc_ops name##_##type##_fops = { \
.proc_open = name##_##type##_open, \
.proc_write = name##_##type##_write, \
.proc_release = single_release, \
};
struct lustre_attr {
struct attribute attr;
ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
const char *buf, size_t len);
};
#define LUSTRE_ATTR(name, mode, show, store) \
static struct lustre_attr lustre_attr_##name = __ATTR(name, mode, show, store)
#define LUSTRE_WO_ATTR(name) LUSTRE_ATTR(name, 0200, NULL, name##_store)
#define LUSTRE_RO_ATTR(name) LUSTRE_ATTR(name, 0444, name##_show, NULL)
#define LUSTRE_RW_ATTR(name) LUSTRE_ATTR(name, 0644, name##_show, name##_store)
ssize_t lustre_attr_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t lustre_attr_store(struct kobject *kobj, struct attribute *attr,
const char *buf, size_t len);
extern const struct sysfs_ops lustre_sysfs_ops;
#define LUSTRE_OBD_UINT_PARAM_ATTR(name)\
static ssize_t name##_show(struct kobject *kobj, struct attribute *attr,\
char *buf) \
{ \
int rc; \
struct obd_device *obd = \
container_of(kobj, struct obd_device, obd_kset.kobj); \
rc = snprintf(buf, PAGE_SIZE, "%u\n", obd->obd_##name); \
return rc; \
} \
static ssize_t name##_store(struct kobject *kobj, struct attribute *attr,\
const char *buffer, size_t count) \
{ \
int rc; \
unsigned int val; \
struct obd_device *obd = \
container_of(kobj, struct obd_device, obd_kset.kobj); \
rc = kstrtouint(buffer, 10, &val); \
if (rc) \
return rc; \
obd->obd_##name = val; \
return count; \
} \
LUSTRE_RW_ATTR(name)
/* lproc_ptlrpc.c */
struct ptlrpc_request;
extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
#ifdef CONFIG_LUSTRE_FS_SERVER
/* lprocfs_jobstats.c */
int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
int event, long amount);
void lprocfs_job_stats_fini(struct obd_device *obd);
int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
cntr_init_callback fn);
ssize_t job_cleanup_interval_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t job_cleanup_interval_store(struct kobject *kobj,
struct attribute *attr,
const char *buffer, size_t count);
/* lproc_status_server.c */
ssize_t recovery_time_soft_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t recovery_time_soft_store(struct kobject *kobj,
struct attribute *attr,
const char *buffer, size_t count);
ssize_t recovery_time_hard_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t recovery_time_hard_store(struct kobject *kobj,
struct attribute *attr,
const char *buffer, size_t count);
ssize_t instance_show(struct kobject *kobj, struct attribute *attr,
char *buf);
#endif
/* lproc_status.c */
ssize_t max_pages_per_rpc_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t max_pages_per_rpc_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count);
ssize_t max_mb_per_rpc_read_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t max_mb_per_rpc_read_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count);
ssize_t max_mb_per_rpc_write_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t max_mb_per_rpc_write_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count);
ssize_t short_io_bytes_show(struct kobject *kobj, struct attribute *attr,
char *buf);
ssize_t short_io_bytes_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count);
struct root_squash_info;
int lprocfs_wr_root_squash(const char __user *buffer, unsigned long count,
struct root_squash_info *squash, char *name);
int lprocfs_wr_nosquash_nids(const char __user *buffer, unsigned long count,
struct root_squash_info *squash, char *name);
ssize_t lprocfs_statfs_state(char *buf, size_t buflen, __u32 state);
#else /* !CONFIG_PROC_FS */
#define proc_lustre_root NULL
static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
int index, long amount)
{
}
static inline void lprocfs_counter_incr(struct lprocfs_stats *stats, int index)
{
}
static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
int index, long amount)
{
}
static inline void lprocfs_counter_decr(struct lprocfs_stats *stats, int index)
{
}
static inline void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
enum lprocfs_counter_config config,
const char *name)
{
}
static inline void lprocfs_counter_init_units(struct lprocfs_stats *stats,
int index, enum lprocfs_counter_config config,
const char *name, const char *units)
{
}
static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
enum lprocfs_fields_flags field)
{
return 0;
}
/* NB: we return !NULL to satisfy error checker */
static inline struct lprocfs_stats *
lprocfs_stats_alloc(unsigned int num, enum lprocfs_stats_flags flags)
{
return (struct lprocfs_stats *)1;
}
static inline void lprocfs_stats_clear(struct lprocfs_stats *stats)
{
}
static inline void lprocfs_stats_free(struct lprocfs_stats **stats)
{
}
static inline int lprocfs_stats_register(struct proc_dir_entry *root,
const char *name,
struct lprocfs_stats *stats)
{
return 0;
}
static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
{
}
static inline int lprocfs_alloc_md_stats(struct obd_device *obd,
unsigned int num_private_stats)
{
return 0;
}
static inline void lprocfs_free_md_stats(struct obd_device *obd)
{
}
struct obd_export;
static inline int lprocfs_add_clear_entry(struct obd_export *exp)
{
return 0;
}
static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
{
}
#ifdef CONFIG_LUSTRE_FS_SERVER
static inline int lprocfs_exp_setup(struct obd_export *exp,
struct lnet_nid *peer_nid)
{
return 0;
}
#endif
static inline int lprocfs_exp_cleanup(struct obd_export *exp)
{
return 0;
}
static inline struct proc_dir_entry *
lprocfs_add_simple(struct proc_dir_entry *root, char *name,
void *data, const struct file_operations *fops)
{
return 0;
}
static inline struct proc_dir_entry *
lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
const char *format, ...)
{
return NULL;
}
static inline int lprocfs_add_vars(struct proc_dir_entry *root,
struct lprocfs_vars *var, void *data)
{
return 0;
}
static inline struct proc_dir_entry *
lprocfs_register(const char *name, struct proc_dir_entry *parent,
struct lprocfs_vars *list, void *data)
{
return NULL;
}
static inline void lprocfs_remove(struct proc_dir_entry **root)
{
}
static inline void lprocfs_remove_proc_entry(const char *name,
struct proc_dir_entry *parent)
{
}
static inline int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only)
{
return 0;
}
static inline int lprocfs_obd_cleanup(struct obd_device *obd)
{
return 0;
}
static inline int lprocfs_server_seq_show(struct seq_file *m, void *data)
{
return 0;
}
static inline int lprocfs_import_seq_show(struct seq_file *m, void *data)
{
return 0;
}
static inline int lprocfs_state_seq_show(struct seq_file *m, void *data)
{
return 0;
}
static inline int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data)
{
return 0;
}
#ifdef CONFIG_LUSTRE_FS_SERVER
static inline int lprocfs_num_exports_seq_show(struct seq_file *m, void *data)
{
return 0;
}
#endif
struct adaptive_timeout;
static inline int lprocfs_at_hist_helper(struct seq_file *m,
struct adaptive_timeout *at)
{
return 0;
}
static inline int lprocfs_timeouts_seq_show(struct seq_file *m, void *data)
{
return 0;
}
static inline ssize_t
lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
size_t count, loff_t *off)
{
return 0;
}
static inline ssize_t
lprocfs_ping_seq_write(struct file *file, const char __user *buffer,
size_t count, loff_t *off)
{
return 0;
}
static inline ssize_t
ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
size_t count, loff_t *off)
{
return 0;
}
static inline ssize_t
lprocfs_import_seq_write(struct file *file, const char __user *buffer,
size_t count, loff_t *off)
{
return 0;
}
static inline
void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value)
{
}
static inline
void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value)
{
}
static inline
void lprocfs_oh_clear(struct obd_histogram *oh)
{
}
static inline
unsigned long lprocfs_oh_sum(struct obd_histogram *oh)
{
return 0;
}
static inline
void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
struct lprocfs_counter *cnt)
{
}
static inline
u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
enum lprocfs_fields_flags field)
{
return (__u64)0;
}
#define LPROC_SEQ_FOPS_RO(name)
#define LPROC_SEQ_FOPS(name)
#define LPROC_SEQ_FOPS_RO_TYPE(name, type)
#define LPROC_SEQ_FOPS_RW_TYPE(name, type)
#define LPROC_SEQ_FOPS_WR_ONLY(name, type)
/* lprocfs_jobstats.c */
static inline
int lprocfs_job_stats_log(struct obd_device *obd, char *jobid, int event,
long amount)
{
return 0;
}
static inline
void lprocfs_job_stats_fini(struct obd_device *obd)
{
}
static inline
int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
cntr_init_callback fn)
{
return 0;
}
/* lproc_ptlrpc.c */
#define target_print_req NULL
#endif /* CONFIG_PROC_FS */
#endif /* LPROCFS_STATUS_H */
