4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
31 * lustre/include/lprocfs_status.h
33 * Top level header file for LProc
35 * Author: Hariharan Thantry thantry@users.sourceforge.net
37 #ifndef _LPROCFS_STATUS_H
38 #define _LPROCFS_STATUS_H
41 #include <linux/proc_fs.h>
42 #include <linux/debugfs.h>
43 #include <linux/rwsem.h>
44 #include <linux/spinlock.h>
45 #include <linux/string_helpers.h>
46 #include <linux/seq_file.h>
48 #include <libcfs/libcfs.h>
49 #include <libcfs/linux/linux-fs.h>
50 #include <uapi/linux/lustre/lustre_idl.h>
53 * Liuux 5.6 introduces proc_ops with v5.5-8862-gd56c0d45f0e2
54 * Now that proc and debugfs use separate operation vector types
55 * separate containers are also needed.
59 const struct proc_ops *fops;
61 /** /proc file mode. */
65 /** Provide a debugfs container */
66 struct ldebugfs_vars {
68 const struct file_operations *fops;
70 /** debugfs file mode. */
74 static inline unsigned int pct(unsigned long a, unsigned long b)
76 return b ? a * 100 / b : 0;
79 #define PAGES_TO_MiB(pages) ((pages) >> (20 - PAGE_SHIFT))
80 #define MiB_TO_PAGES(mb) ((mb) << (20 - PAGE_SHIFT))
83 * Append a space separated list of current set flags to str.
85 #define flag2str(port, flag) \
87 if ((port)->port##_##flag) { \
88 seq_printf(m, "%s" #flag, first ? "" : ", "); \
93 void obd_connect_seq_flags2str(struct seq_file *m, __u64 flags, __u64 flags2,
95 void obd_connect_data_seqprint(struct seq_file *m,
96 struct obd_connect_data *ocd);
98 /* if we find more consumers this could be generalized */
99 #define OBD_HIST_MAX 32
100 struct obd_histogram {
102 unsigned long oh_buckets[OBD_HIST_MAX];
105 struct obd_hist_pcpu {
106 struct percpu_counter oh_pc_buckets[OBD_HIST_MAX];
110 /* An lprocfs counter can be configured using the enum bit masks below.
112 * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
113 * protects this counter from concurrent updates. If not specified,
114 * lprocfs an internal per-counter lock variable. External locks are
115 * not used to protect counter increments, but are used to protect
116 * counter readout and resets.
118 * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
119 * (i.e. counter can be incremented by more than "1"). When specified,
120 * the counter maintains min, max and sum in addition to a simple
121 * invocation count. This allows averages to be be computed.
122 * If not specified, the counter is an increment-by-1 counter.
123 * min, max, sum, etc. are not maintained.
125 * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
126 * squares (for multi-valued counter samples only). This allows
127 * external computation of standard deviation, but involves a 64-bit
128 * multiply per counter increment.
130 * LPROCFS_CNTR_HISTOGRAM indicates that the counter should track a
131 * exponential histogram.
134 enum lprocfs_counter_config {
135 LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
136 LPROCFS_CNTR_AVGMINMAX = 0x0002,
137 LPROCFS_CNTR_STDDEV = 0x0004,
138 LPROCFS_CNTR_HISTOGRAM = 0x0008,
140 /* counter unit type */
141 LPROCFS_TYPE_REQS = 0x0000, /* default if config = 0 */
142 LPROCFS_TYPE_BYTES = 0x0200,
143 LPROCFS_TYPE_PAGES = 0x0400,
144 LPROCFS_TYPE_LOCKS = 0x0500,
145 LPROCFS_TYPE_LOCKSPS = 0x0600,
146 LPROCFS_TYPE_SECS = 0x0700,
147 LPROCFS_TYPE_USECS = 0x0800,
148 LPROCFS_TYPE_MASK = 0x0f00,
150 LPROCFS_TYPE_LATENCY = LPROCFS_TYPE_USECS |
151 LPROCFS_CNTR_AVGMINMAX |
153 LPROCFS_TYPE_BYTES_FULL = LPROCFS_TYPE_BYTES |
154 LPROCFS_CNTR_AVGMINMAX |
156 LPROCFS_TYPE_BYTES_FULL_HISTOGRAM = LPROCFS_TYPE_BYTES_FULL |
157 LPROCFS_CNTR_HISTOGRAM,
159 #define LC_MIN_INIT ((~(__u64)0) >> 1)
161 struct lprocfs_counter_header {
162 enum lprocfs_counter_config lc_config;
163 const char *lc_name; /* must be static */
164 const char *lc_units; /* must be static */
165 struct obd_histogram *lc_hist;
168 struct lprocfs_counter {
174 * Every counter has lc_array_sum[0], while lc_array_sum[1] is only
175 * for irq context counter, i.e. stats with
176 * LPROCFS_STATS_FLAG_IRQ_SAFE flag, its counter need
179 __s64 lc_array_sum[1];
181 #define lc_sum lc_array_sum[0]
182 #define lc_sum_irq lc_array_sum[1]
184 struct lprocfs_percpu {
185 struct lprocfs_counter lp_cntr[0];
188 enum lprocfs_stats_lock_ops {
189 LPROCFS_GET_NUM_CPU = 0x0001, /* number allocated per-CPU stats */
190 LPROCFS_GET_SMP_ID = 0x0002, /* current stat to be updated */
193 enum lprocfs_stats_flags {
194 LPROCFS_STATS_FLAG_NONE = 0x0000, /* per cpu counter */
195 LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
196 * area and need locking */
197 LPROCFS_STATS_FLAG_IRQ_SAFE = 0x0002, /* alloc need irq safe */
200 enum lprocfs_fields_flags {
201 LPROCFS_FIELDS_FLAGS_CONFIG = 0x0001,
202 LPROCFS_FIELDS_FLAGS_SUM = 0x0002,
203 LPROCFS_FIELDS_FLAGS_MIN = 0x0003,
204 LPROCFS_FIELDS_FLAGS_MAX = 0x0004,
205 LPROCFS_FIELDS_FLAGS_AVG = 0x0005,
206 LPROCFS_FIELDS_FLAGS_SUMSQUARE = 0x0006,
207 LPROCFS_FIELDS_FLAGS_COUNT = 0x0007,
210 struct lprocfs_stats {
212 unsigned short ls_num;
213 /* 1 + the biggest cpu # whose ls_percpu slot has been allocated */
214 unsigned short ls_biggest_alloc_num;
215 enum lprocfs_stats_flags ls_flags;
217 /* Lock used when there are no percpu stats areas; For percpu stats,
218 * it is used to protect ls_biggest_alloc_num change */
221 /* has ls_num of counter headers */
222 struct lprocfs_counter_header *ls_cnt_header;
223 struct lprocfs_percpu *ls_percpu[0];
226 #define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
228 /* Pack all opcodes down into a single monotonically increasing index */
229 static inline int opcode_offset(__u32 opc) {
230 if (opc < OST_LAST_OPC) {
232 return (opc - OST_FIRST_OPC);
233 } else if (opc < MDS_LAST_OPC) {
235 return (opc - MDS_FIRST_OPC +
237 } else if (opc < LDLM_LAST_OPC) {
239 return (opc - LDLM_FIRST_OPC +
242 } else if (opc < MGS_LAST_OPC) {
244 return (opc - MGS_FIRST_OPC +
248 } else if (opc < OBD_LAST_OPC) {
250 return (opc - OBD_FIRST_OPC +
255 } else if (opc < LLOG_LAST_OPC) {
257 return (opc - LLOG_FIRST_OPC +
263 } else if (opc < QUOTA_LAST_OPC) {
265 return (opc - QUOTA_FIRST_OPC +
272 } else if (opc < SEQ_LAST_OPC) {
274 return (opc - SEQ_FIRST_OPC +
282 } else if (opc < SEC_LAST_OPC) {
284 return (opc - SEC_FIRST_OPC +
293 } else if (opc < FLD_LAST_OPC) {
295 return (opc - FLD_FIRST_OPC +
305 #ifdef HAVE_SERVER_SUPPORT
306 } else if (opc < OUT_UPDATE_LAST_OPC) {
308 return (opc - OUT_UPDATE_FIRST_OPC +
319 } else if (opc < LFSCK_LAST_OPC) {
321 return (opc - LFSCK_FIRST_OPC +
322 OPC_RANGE(OUT_UPDATE) +
333 #endif /* HAVE_SERVER_SUPPORT */
340 #define LUSTRE_MAX_OPCODES_CLIENT (OPC_RANGE(OST) + \
351 #ifdef HAVE_SERVER_SUPPORT
352 #define LUSTRE_MAX_OPCODES (LUSTRE_MAX_OPCODES_CLIENT + \
353 OPC_RANGE(OUT_UPDATE) + \
356 #define LUSTRE_MAX_OPCODES LUSTRE_MAX_OPCODES_CLIENT
359 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR) + \
363 PTLRPC_REQWAIT_CNTR = 0,
364 PTLRPC_REQQDEPTH_CNTR,
365 PTLRPC_REQACTIVE_CNTR,
367 PTLRPC_REQBUF_AVAIL_CNTR,
371 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
373 enum lprocfs_extra_opc {
374 LDLM_GLIMPSE_ENQUEUE = 0,
392 #ifdef HAVE_SERVER_SUPPORT
398 BRW_R_DISCONT_BLOCKS,
399 BRW_W_DISCONT_BLOCKS,
413 struct brw_stats_props {
414 const char *bsp_name;
415 const char *bsp_units;
421 struct obd_hist_pcpu bs_hist[BRW_RW_STATS_NUM];
422 struct brw_stats_props bs_props[BRW_RW_STATS_NUM / 2];
425 int lprocfs_init_brw_stats(struct brw_stats *brw_stats);
426 void lprocfs_fini_brw_stats(struct brw_stats *brw_stats);
428 void ldebugfs_register_osd_stats(struct dentry *parent,
429 struct brw_stats *brw_stats,
430 struct lprocfs_stats *stats);
431 #endif /* HAVE_SERVER_SUPPORT */
433 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
435 extern struct proc_dir_entry *proc_lustre_root;
436 extern struct dentry *debugfs_lustre_root;
437 extern struct kset *lustre_kset;
441 #define JOBSTATS_JOBID_VAR_MAX_LEN 20
442 #define JOBSTATS_DISABLE "disable"
443 #define JOBSTATS_PROCNAME_UID "procname_uid"
444 #define JOBSTATS_NODELOCAL "nodelocal"
445 #define JOBSTATS_SESSION "session"
447 typedef void (*cntr_init_callback)(struct lprocfs_stats *stats,
449 enum lprocfs_counter_config cntr_umask);
450 struct obd_job_stats {
451 struct cfs_hash *ojs_hash; /* hash of jobids */
452 struct list_head ojs_list; /* list of job_stat structs */
453 spinlock_t ojs_lock; /* protect ojs_list/js_list */
454 ktime_t ojs_cleanup_interval;/* 1/2 expiry seconds */
455 ktime_t ojs_cleanup_last;/* previous cleanup time */
456 cntr_init_callback ojs_cntr_init_fn;/* lprocfs_stats initializer */
457 unsigned short ojs_cntr_num; /* number of stats in struct */
458 bool ojs_cleaning; /* currently expiring stats */
461 #ifdef CONFIG_PROC_FS
463 int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
465 int lprocfs_stats_lock(struct lprocfs_stats *stats,
466 enum lprocfs_stats_lock_ops opc,
467 unsigned long *flags);
468 void lprocfs_stats_unlock(struct lprocfs_stats *stats,
469 enum lprocfs_stats_lock_ops opc,
470 unsigned long *flags);
472 static inline unsigned int
473 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
475 unsigned int percpusize;
477 percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
479 /* irq safe stats need lc_array_sum[1] */
480 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
481 percpusize += stats->ls_num * sizeof(__s64);
483 if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
484 percpusize = L1_CACHE_ALIGN(percpusize);
489 static inline struct lprocfs_counter *
490 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
493 struct lprocfs_counter *cntr;
495 cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
497 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
498 cntr = (void *)cntr + index * sizeof(__s64);
503 /* Two optimized LPROCFS counter increment functions are provided:
504 * lprocfs_counter_incr(cntr, value) - optimized for by-one counters
505 * lprocfs_counter_add(cntr) - use for multi-valued counters
506 * Counter data layout allows config flag, counter lock and the
507 * count itself to reside within a single cache line.
510 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
512 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
515 #define lprocfs_counter_incr(stats, idx) \
516 lprocfs_counter_add(stats, idx, 1)
517 #define lprocfs_counter_decr(stats, idx) \
518 lprocfs_counter_sub(stats, idx, 1)
520 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
521 struct lprocfs_counter_header *header,
522 enum lprocfs_stats_flags flags,
523 enum lprocfs_fields_flags field);
524 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
525 enum lprocfs_fields_flags field);
527 extern struct lprocfs_stats *
528 lprocfs_stats_alloc(unsigned int num, enum lprocfs_stats_flags flags);
529 extern void lprocfs_stats_clear(struct lprocfs_stats *stats);
530 extern void lprocfs_stats_free(struct lprocfs_stats **stats);
531 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
532 extern int lprocfs_alloc_obd_stats(struct obd_device *obd,
533 unsigned int num_stats);
534 extern int lprocfs_alloc_md_stats(struct obd_device *obd,
535 unsigned int num_private_stats);
536 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
537 enum lprocfs_counter_config config,
539 extern void lprocfs_counter_init_units(struct lprocfs_stats *stats, int index,
540 enum lprocfs_counter_config config,
541 const char *name, const char *units);
542 extern void lprocfs_free_obd_stats(struct obd_device *obd);
543 extern void lprocfs_free_md_stats(struct obd_device *obd);
546 extern int lprocfs_add_clear_entry(struct obd_device *obd,
547 struct proc_dir_entry *entry);
548 #ifdef HAVE_SERVER_SUPPORT
549 extern int lprocfs_exp_setup(struct obd_export *exp, struct lnet_nid *peer_nid);
550 extern int lprocfs_exp_cleanup(struct obd_export *exp);
551 struct dentry *ldebugfs_add_symlink(const char *name, const char *target,
552 const char *format, ...);
554 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
557 extern struct proc_dir_entry *
558 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
559 void *data, const struct proc_ops *ops);
560 extern struct proc_dir_entry *
561 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
562 const char *format, ...);
563 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
564 #ifdef HAVE_SERVER_SUPPORT
566 lprocfs_nid_stats_clear_seq_write(struct file *file, const char __user *buffer,
567 size_t count, loff_t *off);
568 extern int lprocfs_nid_stats_clear_seq_show(struct seq_file *file, void *data);
570 extern int lprocfs_stats_register(struct proc_dir_entry *root, const char *name,
571 struct lprocfs_stats *stats);
572 extern const struct file_operations ldebugfs_stats_seq_fops;
574 /* lprocfs_status.c */
575 extern void ldebugfs_add_vars(struct dentry *parent, struct ldebugfs_vars *var,
577 extern struct dentry *ldebugfs_register(const char *name,
578 struct dentry *parent,
579 struct ldebugfs_vars *list,
581 extern int lprocfs_add_vars(struct proc_dir_entry *root,
582 struct lprocfs_vars *var, void *data);
584 extern struct proc_dir_entry *
585 lprocfs_register(const char *name, struct proc_dir_entry *parent,
586 struct lprocfs_vars *list, void *data);
588 extern void lprocfs_remove(struct proc_dir_entry **root);
589 extern void lprocfs_remove_proc_entry(const char *name,
590 struct proc_dir_entry *parent);
591 extern int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only);
592 extern int lprocfs_obd_cleanup(struct obd_device *obd);
594 extern int lprocfs_seq_create(struct proc_dir_entry *parent, const char *name,
595 mode_t mode, const struct proc_ops *seq_fops,
597 extern int lprocfs_obd_seq_create(struct obd_device *obd, const char *name,
598 mode_t mode, const struct proc_ops *seq_fops,
600 extern void lprocfs_stats_header(struct seq_file *seq, ktime_t now,
601 ktime_t ts_init, int width, const char *colon,
602 bool show_units, const char *prefix);
604 /* Generic callbacks */
605 extern int lprocfs_uuid_seq_show(struct seq_file *m, void *data);
606 extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
607 ssize_t conn_uuid_show(struct kobject *kobj, struct attribute *attr, char *buf);
608 extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
609 extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
610 extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
611 #ifdef HAVE_SERVER_SUPPORT
612 ssize_t num_exports_show(struct kobject *kobj, struct attribute *attr,
614 ssize_t grant_check_threshold_show(struct kobject *kobj,
615 struct attribute *attr, char *buf);
616 ssize_t grant_check_threshold_store(struct kobject *kobj,
617 struct attribute *attr,
618 const char *buffer, size_t count);
619 ssize_t eviction_count_show(struct kobject *kobj, struct attribute *attr,
622 struct adaptive_timeout;
623 extern int lprocfs_at_hist_helper(struct seq_file *m,
624 struct adaptive_timeout *at);
625 extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
627 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
628 size_t count, loff_t *off);
629 #ifdef HAVE_SERVER_SUPPORT
631 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
632 size_t count, loff_t *off);
634 ssize_t ping_store(struct kobject *kobj, struct attribute *attr,
635 const char *buffer, size_t count);
636 ssize_t ping_show(struct kobject *kobj, struct attribute *attr,
640 ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
641 size_t count, loff_t *off);
642 static inline ssize_t
643 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
644 size_t count, loff_t *off)
646 return ldebugfs_import_seq_write(file, buffer, count, off);
649 extern int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data);
651 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
652 size_t count, loff_t *off);
654 int string_to_size(u64 *size, const char *buffer, size_t count);
655 int sysfs_memparse(const char *buffer, size_t count, u64 *val,
656 const char *defunit);
657 char *lprocfs_strnstr(const char *s1, const char *s2, size_t len);
658 char *lprocfs_find_named_value(const char *buffer, const char *name,
660 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
661 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
662 void lprocfs_oh_clear(struct obd_histogram *oh);
663 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
665 void lprocfs_oh_tally_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
666 void lprocfs_oh_tally_log2_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
667 int lprocfs_oh_alloc_pcpu(struct obd_hist_pcpu *oh);
668 void lprocfs_oh_clear_pcpu(struct obd_hist_pcpu *oh);
669 void lprocfs_oh_release_pcpu(struct obd_hist_pcpu *oh);
670 unsigned long lprocfs_oh_sum_pcpu(struct obd_hist_pcpu *oh);
671 unsigned long lprocfs_oh_counter_pcpu(struct obd_hist_pcpu *oh,
674 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
675 struct lprocfs_counter *cnt);
677 #ifdef HAVE_SERVER_SUPPORT
678 /* lprocfs_status.c: recovery status */
679 int lprocfs_recovery_status_seq_show(struct seq_file *m, void *data);
681 /* lprocfs: display the uuid of stale clients */
682 int lprocfs_recovery_stale_clients_seq_show(struct seq_file *m, void *data);
684 /* lprocfs_status.c: hash statistics */
685 int lprocfs_hash_seq_show(struct seq_file *m, void *data);
687 /* lprocfs_status.c: IR factor */
688 ssize_t ir_factor_show(struct kobject *kobj, struct attribute *attr,
690 ssize_t ir_factor_store(struct kobject *kobj, struct attribute *attr,
691 const char *buffer, size_t count);
694 /* lprocfs_status.c: dump pages on cksum error */
695 int lprocfs_checksum_dump_seq_show(struct seq_file *m, void *data);
697 lprocfs_checksum_dump_seq_write(struct file *file, const char __user *buffer,
698 size_t count, loff_t *off);
700 extern int lprocfs_single_release(struct inode *, struct file *);
701 extern int lprocfs_seq_release(struct inode *, struct file *);
703 /* You must use these macros when you want to refer to
704 * the import in a client obd_device for a lprocfs entry
705 * Note that it is not safe to 'goto', 'return' or 'break'
706 * out of the body of this statement. It *IS* safe to
707 * 'goto' the a label inside the statement, or to 'continue'
708 * to get out of the statement.
711 #define with_imp_locked_nested(__obd, __imp, __rc, __nest) \
712 for (down_read_nested(&(__obd)->u.cli.cl_sem, __nest), \
713 __imp = (__obd)->u.cli.cl_import, \
714 __rc = __imp ? 0 : -ENODEV; \
715 __imp ? 1 : (up_read(&(__obd)->u.cli.cl_sem), 0); \
718 #define with_imp_locked(__obd, __imp, __rc) \
719 with_imp_locked_nested(__obd, __imp, __rc, 0)
721 /* write the name##_seq_show function, call LDEBUGFS_SEQ_FOPS_RO for read-only
722 * debugfs entries; otherwise, you will define name##_seq_write function also
723 * for a read-write debugfs entry, and then call LDEBUGFS_SEQ_FOPS instead.
724 * Finally, call debugfs_create_file(filename, 0444, obd, data, &name#_fops);
726 #define __LDEBUGFS_SEQ_FOPS(name, custom_seq_write) \
727 static int name##_single_open(struct inode *inode, struct file *file) \
729 return single_open(file, name##_seq_show, inode->i_private); \
731 static const struct file_operations name##_fops = { \
732 .owner = THIS_MODULE, \
733 .open = name##_single_open, \
735 .write = custom_seq_write, \
736 .llseek = seq_lseek, \
737 .release = single_release, \
740 #define LDEBUGFS_SEQ_FOPS_RO(name) __LDEBUGFS_SEQ_FOPS(name, NULL)
741 #define LDEBUGFS_SEQ_FOPS(name) __LDEBUGFS_SEQ_FOPS(name, \
744 #define LDEBUGFS_SEQ_FOPS_RO_TYPE(name, type) \
745 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
749 return lprocfs_##type##_seq_show(m, m->private); \
751 LDEBUGFS_SEQ_FOPS_RO(name##_##type)
753 #define LDEBUGFS_SEQ_FOPS_RW_TYPE(name, type) \
754 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
758 return lprocfs_##type##_seq_show(m, m->private); \
760 static ssize_t name##_##type##_seq_write(struct file *file, \
761 const char __user *buffer, size_t count, \
764 struct seq_file *seq = file->private_data; \
768 return ldebugfs_##type##_seq_write(file, buffer, count, \
771 LDEBUGFS_SEQ_FOPS(name##_##type);
773 #define LDEBUGFS_FOPS_WR_ONLY(name, type) \
774 static ssize_t name##_##type##_write(struct file *file, \
775 const char __user *buffer, size_t count, \
778 return ldebugfs_##type##_seq_write(file, buffer, count, \
781 static int name##_##type##_open(struct inode *inode, \
784 return single_open(file, NULL, inode->i_private); \
786 static const struct file_operations name##_##type##_fops = { \
787 .open = name##_##type##_open, \
788 .write = name##_##type##_write, \
789 .release = single_release, \
792 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
793 * proc entries; otherwise, you will define name##_seq_write function also for
794 * a read-write proc entry, and then call LPROC_SEQ_FOPS instead. Finally,
795 * call ldebugfs_obd_seq_create(obd, filename, 0444, &name#_fops, data);
797 #define __LPROC_SEQ_FOPS(name, custom_seq_write) \
798 static int name##_single_open(struct inode *inode, struct file *file) \
800 return single_open(file, name##_seq_show, \
801 inode->i_private ? inode->i_private : \
804 static const struct proc_ops name##_fops = { \
805 PROC_OWNER(THIS_MODULE) \
806 .proc_open = name##_single_open, \
807 .proc_read = seq_read, \
808 .proc_write = custom_seq_write, \
809 .proc_lseek = seq_lseek, \
810 .proc_release = lprocfs_single_release, \
813 #define LPROC_SEQ_FOPS_RO(name) __LPROC_SEQ_FOPS(name, NULL)
814 #define LPROC_SEQ_FOPS(name) __LPROC_SEQ_FOPS(name, name##_seq_write)
816 #define LPROC_SEQ_FOPS_RO_TYPE(name, type) \
817 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
819 return lprocfs_##type##_seq_show(m, m->private); \
821 LPROC_SEQ_FOPS_RO(name##_##type)
823 #define LPROC_SEQ_FOPS_RW_TYPE(name, type) \
824 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
826 return lprocfs_##type##_seq_show(m, m->private); \
828 static ssize_t name##_##type##_seq_write(struct file *file, \
829 const char __user *buffer, size_t count, \
832 struct seq_file *seq = file->private_data; \
833 return lprocfs_##type##_seq_write(file, buffer, \
834 count, seq->private); \
836 LPROC_SEQ_FOPS(name##_##type);
838 #define LPROC_SEQ_FOPS_WR_ONLY(name, type) \
839 static ssize_t name##_##type##_write(struct file *file, \
840 const char __user *buffer, size_t count, \
843 return lprocfs_##type##_seq_write(file, buffer, count, off);\
845 static int name##_##type##_open(struct inode *inode, struct file *file)\
847 return single_open(file, NULL, \
848 inode->i_private ? inode->i_private : \
851 static const struct proc_ops name##_##type##_fops = { \
852 .proc_open = name##_##type##_open, \
853 .proc_write = name##_##type##_write, \
854 .proc_release = lprocfs_single_release, \
858 struct attribute attr;
859 ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
861 ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
862 const char *buf, size_t len);
865 #define LUSTRE_ATTR(name, mode, show, store) \
866 static struct lustre_attr lustre_attr_##name = __ATTR(name, mode, show, store)
868 #define LUSTRE_WO_ATTR(name) LUSTRE_ATTR(name, 0200, NULL, name##_store)
869 #define LUSTRE_RO_ATTR(name) LUSTRE_ATTR(name, 0444, name##_show, NULL)
870 #define LUSTRE_RW_ATTR(name) LUSTRE_ATTR(name, 0644, name##_show, name##_store)
872 ssize_t lustre_attr_show(struct kobject *kobj, struct attribute *attr,
874 ssize_t lustre_attr_store(struct kobject *kobj, struct attribute *attr,
875 const char *buf, size_t len);
877 extern const struct sysfs_ops lustre_sysfs_ops;
880 struct ptlrpc_request;
881 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
883 #ifdef HAVE_SERVER_SUPPORT
884 /* lprocfs_jobstats.c */
885 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
886 int event, long amount);
887 void lprocfs_job_stats_fini(struct obd_device *obd);
888 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
889 cntr_init_callback fn);
890 ssize_t job_cleanup_interval_show(struct kobject *kobj, struct attribute *attr,
892 ssize_t job_cleanup_interval_store(struct kobject *kobj,
893 struct attribute *attr,
894 const char *buffer, size_t count);
895 /* lproc_status_server.c */
896 ssize_t recovery_time_soft_show(struct kobject *kobj, struct attribute *attr,
898 ssize_t recovery_time_soft_store(struct kobject *kobj,
899 struct attribute *attr,
900 const char *buffer, size_t count);
901 ssize_t recovery_time_hard_show(struct kobject *kobj, struct attribute *attr,
903 ssize_t recovery_time_hard_store(struct kobject *kobj,
904 struct attribute *attr,
905 const char *buffer, size_t count);
906 ssize_t instance_show(struct kobject *kobj, struct attribute *attr,
910 int lprocfs_obd_max_pages_per_rpc_seq_show(struct seq_file *m, void *data);
911 ssize_t lprocfs_obd_max_pages_per_rpc_seq_write(struct file *file,
912 const char __user *buffer,
913 size_t count, loff_t *off);
914 ssize_t short_io_bytes_show(struct kobject *kobj, struct attribute *attr,
916 ssize_t short_io_bytes_store(struct kobject *kobj, struct attribute *attr,
917 const char *buffer, size_t count);
919 struct root_squash_info;
920 int lprocfs_wr_root_squash(const char __user *buffer, unsigned long count,
921 struct root_squash_info *squash, char *name);
922 int lprocfs_wr_nosquash_nids(const char __user *buffer, unsigned long count,
923 struct root_squash_info *squash, char *name);
925 #else /* !CONFIG_PROC_FS */
927 #define proc_lustre_root NULL
929 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
930 int index, long amount)
932 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats, int index)
934 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
935 int index, long amount)
937 static inline void lprocfs_counter_decr(struct lprocfs_stats *stats, int index)
939 static inline void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
940 enum lprocfs_counter_config config,
943 static inline void lprocfs_counter_init_units(struct lprocfs_stats *stats,
944 int index, enum lprocfs_counter_config config,
945 const char *name, const char *units)
948 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
949 enum lprocfs_fields_flags field)
952 /* NB: we return !NULL to satisfy error checker */
953 static inline struct lprocfs_stats *
954 lprocfs_stats_alloc(unsigned int num, enum lprocfs_stats_flags flags)
955 { return (struct lprocfs_stats *)1; }
956 static inline void lprocfs_stats_clear(struct lprocfs_stats *stats)
958 static inline void lprocfs_stats_free(struct lprocfs_stats **stats)
960 static inline int lprocfs_stats_register(struct proc_dir_entry *root,
962 struct lprocfs_stats *stats)
964 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
966 static inline int lprocfs_alloc_obd_stats(struct obd_device *obd,
967 unsigned int num_stats)
969 static inline int lprocfs_alloc_md_stats(struct obd_device *obd,
970 unsigned int num_private_stats)
972 static inline void lprocfs_free_obd_stats(struct obd_device *obd)
974 static inline void lprocfs_free_md_stats(struct obd_device *obd)
978 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
980 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
982 #ifdef HAVE_SERVER_SUPPORT
984 ssize_t lprocfs_nid_stats_seq_write(struct file *file,
985 const char __user *buffer,
986 size_t count, loff_t *off)
989 int lprocfs_nid_stats_clear_seq_show(struct seq_file *m, void *data)
991 static inline int lprocfs_exp_setup(struct obd_export *exp,
992 struct lnet_nid *peer_nid)
995 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
997 static inline struct proc_dir_entry *
998 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
999 void *data, const struct file_operations *fops)
1001 static inline struct proc_dir_entry *
1002 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
1003 const char *format, ...)
1005 static inline int lprocfs_add_vars(struct proc_dir_entry *root,
1006 struct lprocfs_vars *var, void *data)
1008 static inline struct proc_dir_entry *
1009 lprocfs_register(const char *name, struct proc_dir_entry *parent,
1010 struct lprocfs_vars *list, void *data)
1012 static inline void lprocfs_remove(struct proc_dir_entry **root)
1014 static inline void lprocfs_remove_proc_entry(const char *name,
1015 struct proc_dir_entry *parent)
1017 static inline int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only)
1019 static inline int lprocfs_obd_cleanup(struct obd_device *obd)
1021 static inline int lprocfs_uuid_seq_show(struct seq_file *m, void *data)
1023 static inline int lprocfs_server_seq_show(struct seq_file *m, void *data)
1025 static inline int lprocfs_import_seq_show(struct seq_file *m, void *data)
1027 static inline int lprocfs_state_seq_show(struct seq_file *m, void *data)
1029 static inline int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data)
1031 #ifdef HAVE_SERVER_SUPPORT
1032 static inline int lprocfs_num_exports_seq_show(struct seq_file *m, void *data)
1035 struct adaptive_timeout;
1036 static inline int lprocfs_at_hist_helper(struct seq_file *m,
1037 struct adaptive_timeout *at)
1039 static inline int lprocfs_timeouts_seq_show(struct seq_file *m, void *data)
1041 static inline ssize_t
1042 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
1043 size_t count, loff_t *off)
1045 #ifdef HAVE_SERVER_SUPPORT
1046 static inline ssize_t
1047 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
1048 size_t count, loff_t *off)
1051 static inline ssize_t
1052 lprocfs_ping_seq_write(struct file *file, const char __user *buffer,
1053 size_t count, loff_t *off)
1055 static inline ssize_t
1056 ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
1057 size_t count, loff_t *off)
1059 static inline ssize_t
1060 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
1061 size_t count, loff_t *off)
1064 lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data)
1066 static inline ssize_t
1067 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
1068 size_t count, loff_t *off)
1071 /* Statfs helpers */
1073 int lprocfs_blksize_seq_show(struct seq_file *m, void *data)
1076 int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data)
1079 int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data)
1082 int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data)
1085 int lprocfs_filestotal_seq_show(struct seq_file *m, void *data)
1088 int lprocfs_filesfree_seq_show(struct seq_file *m, void *data)
1091 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value)
1094 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value)
1097 void lprocfs_oh_clear(struct obd_histogram *oh)
1100 unsigned long lprocfs_oh_sum(struct obd_histogram *oh)
1103 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
1104 struct lprocfs_counter *cnt)
1107 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
1108 enum lprocfs_fields_flags field)
1109 { return (__u64)0; }
1111 #define LPROC_SEQ_FOPS_RO(name)
1112 #define LPROC_SEQ_FOPS(name)
1113 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)
1114 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)
1115 #define LPROC_SEQ_FOPS_WR_ONLY(name, type)
1117 /* lprocfs_jobstats.c */
1119 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid, int event,
1123 void lprocfs_job_stats_fini(struct obd_device *obd)
1126 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
1127 cntr_init_callback fn)
1131 /* lproc_ptlrpc.c */
1132 #define target_print_req NULL
1134 #endif /* CONFIG_PROC_FS */
1136 #endif /* LPROCFS_STATUS_H */