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, /* need locking(no percpu area) */
196 LPROCFS_STATS_FLAG_IRQ_SAFE = 0x0002, /* alloc need irq safe */
199 enum lprocfs_fields_flags {
200 LPROCFS_FIELDS_FLAGS_CONFIG = 0x0001,
201 LPROCFS_FIELDS_FLAGS_SUM = 0x0002,
202 LPROCFS_FIELDS_FLAGS_MIN = 0x0003,
203 LPROCFS_FIELDS_FLAGS_MAX = 0x0004,
204 LPROCFS_FIELDS_FLAGS_AVG = 0x0005,
205 LPROCFS_FIELDS_FLAGS_SUMSQUARE = 0x0006,
206 LPROCFS_FIELDS_FLAGS_COUNT = 0x0007,
209 struct lprocfs_stats {
211 unsigned short ls_num;
212 /* 1 + the biggest cpu # whose ls_percpu slot has been allocated */
213 unsigned short ls_biggest_alloc_num;
214 enum lprocfs_stats_flags ls_flags;
216 /* Lock used when there are no percpu stats areas; For percpu stats,
217 * 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)
231 if (opc < OST_LAST_OPC) {
233 return (opc - OST_FIRST_OPC);
234 } else if (opc < MDS_LAST_OPC) {
236 return (opc - MDS_FIRST_OPC +
238 } else if (opc < LDLM_LAST_OPC) {
240 return (opc - LDLM_FIRST_OPC +
243 } else if (opc < MGS_LAST_OPC) {
245 return (opc - MGS_FIRST_OPC +
249 } else if (opc < OBD_LAST_OPC) {
251 return (opc - OBD_FIRST_OPC +
256 } else if (opc < LLOG_LAST_OPC) {
258 return (opc - LLOG_FIRST_OPC +
264 } else if (opc < QUOTA_LAST_OPC) {
266 return (opc - QUOTA_FIRST_OPC +
273 } else if (opc < SEQ_LAST_OPC) {
275 return (opc - SEQ_FIRST_OPC +
283 } else if (opc < SEC_LAST_OPC) {
285 return (opc - SEC_FIRST_OPC +
294 } else if (opc < FLD_LAST_OPC) {
296 return (opc - FLD_FIRST_OPC +
306 #ifdef HAVE_SERVER_SUPPORT
307 } else if (opc < OUT_UPDATE_LAST_OPC) {
309 return (opc - OUT_UPDATE_FIRST_OPC +
320 } else if (opc < LFSCK_LAST_OPC) {
322 return (opc - LFSCK_FIRST_OPC +
323 OPC_RANGE(OUT_UPDATE) +
334 #endif /* HAVE_SERVER_SUPPORT */
341 #define LUSTRE_MAX_OPCODES_CLIENT (OPC_RANGE(OST) + \
352 #ifdef HAVE_SERVER_SUPPORT
353 #define LUSTRE_MAX_OPCODES (LUSTRE_MAX_OPCODES_CLIENT + \
354 OPC_RANGE(OUT_UPDATE) + \
357 #define LUSTRE_MAX_OPCODES LUSTRE_MAX_OPCODES_CLIENT
360 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR) + \
364 PTLRPC_REQWAIT_CNTR = 0,
365 PTLRPC_REQQDEPTH_CNTR,
366 PTLRPC_REQACTIVE_CNTR,
368 PTLRPC_REQBUF_AVAIL_CNTR,
372 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
374 enum lprocfs_extra_opc {
375 LDLM_GLIMPSE_ENQUEUE = 0,
393 #ifdef HAVE_SERVER_SUPPORT
399 BRW_R_DISCONT_BLOCKS,
400 BRW_W_DISCONT_BLOCKS,
414 struct brw_stats_props {
415 const char *bsp_name;
416 const char *bsp_units;
422 struct obd_hist_pcpu bs_hist[BRW_RW_STATS_NUM];
423 struct brw_stats_props bs_props[BRW_RW_STATS_NUM / 2];
426 int lprocfs_init_brw_stats(struct brw_stats *brw_stats);
427 void lprocfs_fini_brw_stats(struct brw_stats *brw_stats);
429 void ldebugfs_register_osd_stats(struct dentry *parent,
430 struct brw_stats *brw_stats,
431 struct lprocfs_stats *stats);
432 #endif /* HAVE_SERVER_SUPPORT */
434 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
436 extern struct proc_dir_entry *proc_lustre_root;
437 extern struct dentry *debugfs_lustre_root;
438 extern struct kset *lustre_kset;
442 #define JOBSTATS_JOBID_VAR_MAX_LEN 20
443 #define JOBSTATS_DISABLE "disable"
444 #define JOBSTATS_PROCNAME_UID "procname_uid"
445 #define JOBSTATS_NODELOCAL "nodelocal"
446 #define JOBSTATS_SESSION "session"
448 typedef void (*cntr_init_callback)(struct lprocfs_stats *stats,
450 enum lprocfs_counter_config cntr_umask);
451 struct obd_job_stats {
452 struct cfs_hash *ojs_hash; /* hash of jobids */
453 struct list_head ojs_list; /* list of job_stat structs */
454 spinlock_t ojs_lock; /* protect ojs_list/js_list */
455 ktime_t ojs_cleanup_interval;/* 1/2 expiry seconds */
456 ktime_t ojs_cleanup_last;/* previous cleanup time */
457 cntr_init_callback ojs_cntr_init_fn;/* lprocfs_stats initializer */
458 unsigned short ojs_cntr_num; /* number of stats in struct */
459 bool ojs_cleaning; /* currently expiring stats */
462 #ifdef CONFIG_PROC_FS
464 int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
466 int lprocfs_stats_lock(struct lprocfs_stats *stats,
467 enum lprocfs_stats_lock_ops opc,
468 unsigned long *flags);
469 void lprocfs_stats_unlock(struct lprocfs_stats *stats,
470 enum lprocfs_stats_lock_ops opc,
471 unsigned long *flags);
473 static inline unsigned int
474 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
476 unsigned int percpusize;
478 percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
480 /* irq safe stats need lc_array_sum[1] */
481 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
482 percpusize += stats->ls_num * sizeof(__s64);
484 if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
485 percpusize = L1_CACHE_ALIGN(percpusize);
490 static inline struct lprocfs_counter *
491 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
494 struct lprocfs_counter *cntr;
496 cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
498 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
499 cntr = (void *)cntr + index * sizeof(__s64);
504 /* Two optimized LPROCFS counter increment functions are provided:
505 * lprocfs_counter_incr(cntr, value) - optimized for by-one counters
506 * lprocfs_counter_add(cntr) - use for multi-valued counters
507 * Counter data layout allows config flag, counter lock and the
508 * count itself to reside within a single cache line.
511 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
513 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
516 #define lprocfs_counter_incr(stats, idx) \
517 lprocfs_counter_add(stats, idx, 1)
518 #define lprocfs_counter_decr(stats, idx) \
519 lprocfs_counter_sub(stats, idx, 1)
521 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
522 struct lprocfs_counter_header *header,
523 enum lprocfs_stats_flags flags,
524 enum lprocfs_fields_flags field);
525 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
526 enum lprocfs_fields_flags field);
528 extern struct lprocfs_stats *
529 lprocfs_stats_alloc(unsigned int num, enum lprocfs_stats_flags flags);
530 extern void lprocfs_stats_clear(struct lprocfs_stats *stats);
531 extern void lprocfs_stats_free(struct lprocfs_stats **stats);
532 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
533 extern int lprocfs_alloc_obd_stats(struct obd_device *obd,
534 unsigned int num_stats);
535 extern int lprocfs_alloc_md_stats(struct obd_device *obd,
536 unsigned int num_private_stats);
537 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
538 enum lprocfs_counter_config config,
540 extern void lprocfs_counter_init_units(struct lprocfs_stats *stats, int index,
541 enum lprocfs_counter_config config,
542 const char *name, const char *units);
543 extern void lprocfs_free_obd_stats(struct obd_device *obd);
544 extern void lprocfs_free_md_stats(struct obd_device *obd);
547 extern int lprocfs_add_clear_entry(struct obd_device *obd,
548 struct proc_dir_entry *entry);
549 #ifdef HAVE_SERVER_SUPPORT
550 extern int lprocfs_exp_setup(struct obd_export *exp, struct lnet_nid *peer_nid);
551 extern int lprocfs_exp_cleanup(struct obd_export *exp);
552 struct dentry *ldebugfs_add_symlink(const char *name, const char *target,
553 const char *format, ...);
555 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
558 extern struct proc_dir_entry *
559 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
560 void *data, const struct proc_ops *ops);
561 extern struct proc_dir_entry *
562 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
563 const char *format, ...);
564 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
565 #ifdef HAVE_SERVER_SUPPORT
567 lprocfs_nid_stats_clear_seq_write(struct file *file, const char __user *buffer,
568 size_t count, loff_t *off);
569 extern int lprocfs_nid_stats_clear_seq_show(struct seq_file *file, void *data);
571 extern int lprocfs_stats_register(struct proc_dir_entry *root, const char *name,
572 struct lprocfs_stats *stats);
573 extern const struct file_operations ldebugfs_stats_seq_fops;
575 /* lprocfs_status.c */
576 extern void ldebugfs_add_vars(struct dentry *parent, struct ldebugfs_vars *var,
578 extern struct dentry *ldebugfs_register(const char *name,
579 struct dentry *parent,
580 struct ldebugfs_vars *list,
582 extern int lprocfs_add_vars(struct proc_dir_entry *root,
583 struct lprocfs_vars *var, void *data);
585 extern struct proc_dir_entry *
586 lprocfs_register(const char *name, struct proc_dir_entry *parent,
587 struct lprocfs_vars *list, void *data);
589 extern void lprocfs_remove(struct proc_dir_entry **root);
590 extern void lprocfs_remove_proc_entry(const char *name,
591 struct proc_dir_entry *parent);
592 extern int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only);
593 extern int lprocfs_obd_cleanup(struct obd_device *obd);
595 extern int lprocfs_seq_create(struct proc_dir_entry *parent, const char *name,
596 mode_t mode, const struct proc_ops *seq_fops,
598 extern int lprocfs_obd_seq_create(struct obd_device *obd, const char *name,
599 mode_t mode, const struct proc_ops *seq_fops,
601 extern void lprocfs_stats_header(struct seq_file *seq, ktime_t now,
602 ktime_t ts_init, int width, const char *colon,
603 bool show_units, const char *prefix);
604 extern unsigned int obd_enable_stats_header;
606 /* Generic callbacks */
607 extern int lprocfs_uuid_seq_show(struct seq_file *m, void *data);
608 extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
609 ssize_t conn_uuid_show(struct kobject *kobj, struct attribute *attr, char *buf);
610 extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
611 extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
612 extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
613 #ifdef HAVE_SERVER_SUPPORT
614 ssize_t num_exports_show(struct kobject *kobj, struct attribute *attr,
616 ssize_t grant_check_threshold_show(struct kobject *kobj,
617 struct attribute *attr, char *buf);
618 ssize_t grant_check_threshold_store(struct kobject *kobj,
619 struct attribute *attr,
620 const char *buffer, size_t count);
621 ssize_t eviction_count_show(struct kobject *kobj, struct attribute *attr,
624 struct adaptive_timeout;
625 extern int lprocfs_at_hist_helper(struct seq_file *m,
626 struct adaptive_timeout *at);
627 extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
629 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
630 size_t count, loff_t *off);
631 #ifdef HAVE_SERVER_SUPPORT
633 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
634 size_t count, loff_t *off);
636 ssize_t ping_store(struct kobject *kobj, struct attribute *attr,
637 const char *buffer, size_t count);
638 ssize_t ping_show(struct kobject *kobj, struct attribute *attr,
642 ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
643 size_t count, loff_t *off);
644 static inline ssize_t
645 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
646 size_t count, loff_t *off)
648 return ldebugfs_import_seq_write(file, buffer, count, off);
651 extern int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data);
653 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
654 size_t count, loff_t *off);
656 int string_to_size(u64 *size, const char *buffer, size_t count);
657 int sysfs_memparse(const char *buffer, size_t count, u64 *val,
658 const char *defunit);
659 char *lprocfs_strnstr(const char *s1, const char *s2, size_t len);
660 char *lprocfs_find_named_value(const char *buffer, const char *name,
662 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
663 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
664 void lprocfs_oh_clear(struct obd_histogram *oh);
665 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
667 void lprocfs_oh_tally_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
668 void lprocfs_oh_tally_log2_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
669 int lprocfs_oh_alloc_pcpu(struct obd_hist_pcpu *oh);
670 void lprocfs_oh_clear_pcpu(struct obd_hist_pcpu *oh);
671 void lprocfs_oh_release_pcpu(struct obd_hist_pcpu *oh);
672 unsigned long lprocfs_oh_sum_pcpu(struct obd_hist_pcpu *oh);
673 unsigned long lprocfs_oh_counter_pcpu(struct obd_hist_pcpu *oh,
676 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
677 struct lprocfs_counter *cnt);
679 #ifdef HAVE_SERVER_SUPPORT
680 /* lprocfs_status.c: recovery status */
681 int lprocfs_recovery_status_seq_show(struct seq_file *m, void *data);
683 /* lprocfs: display the uuid of stale clients */
684 int lprocfs_recovery_stale_clients_seq_show(struct seq_file *m, void *data);
686 /* lprocfs_status.c: hash statistics */
687 int lprocfs_hash_seq_show(struct seq_file *m, void *data);
689 /* lprocfs_status.c: IR factor */
690 ssize_t ir_factor_show(struct kobject *kobj, struct attribute *attr,
692 ssize_t ir_factor_store(struct kobject *kobj, struct attribute *attr,
693 const char *buffer, size_t count);
696 /* lprocfs_status.c: dump pages on cksum error */
697 int lprocfs_checksum_dump_seq_show(struct seq_file *m, void *data);
699 lprocfs_checksum_dump_seq_write(struct file *file, const char __user *buffer,
700 size_t count, loff_t *off);
702 extern int lprocfs_single_release(struct inode *i, struct file *f);
703 extern int lprocfs_seq_release(struct inode *i, struct file *f);
705 /* You must use these macros when you want to refer to
706 * the import in a client obd_device for a lprocfs entry
707 * Note that it is not safe to 'goto', 'return' or 'break'
708 * out of the body of this statement. It *IS* safe to
709 * 'goto' the a label inside the statement, or to 'continue'
710 * to get out of the statement.
713 #define with_imp_locked_nested(__obd, __imp, __rc, __nest) \
714 for (down_read_nested(&(__obd)->u.cli.cl_sem, __nest), \
715 __imp = (__obd)->u.cli.cl_import, \
716 __rc = __imp ? 0 : -ENODEV; \
717 __imp ? 1 : (up_read(&(__obd)->u.cli.cl_sem), 0); \
720 #define with_imp_locked(__obd, __imp, __rc) \
721 with_imp_locked_nested(__obd, __imp, __rc, 0)
723 /* write the name##_seq_show function, call LDEBUGFS_SEQ_FOPS_RO for read-only
724 * debugfs entries; otherwise, you will define name##_seq_write function also
725 * for a read-write debugfs entry, and then call LDEBUGFS_SEQ_FOPS instead.
726 * Finally, call debugfs_create_file(filename, 0444, obd, data, &name#_fops);
728 #define __LDEBUGFS_SEQ_FOPS(name, custom_seq_write) \
729 static int name##_single_open(struct inode *inode, struct file *file) \
731 return single_open(file, name##_seq_show, inode->i_private); \
733 static const struct file_operations name##_fops = { \
734 .owner = THIS_MODULE, \
735 .open = name##_single_open, \
737 .write = custom_seq_write, \
738 .llseek = seq_lseek, \
739 .release = single_release, \
742 #define LDEBUGFS_SEQ_FOPS_RO(name) __LDEBUGFS_SEQ_FOPS(name, NULL)
743 #define LDEBUGFS_SEQ_FOPS(name) __LDEBUGFS_SEQ_FOPS(name, \
746 #define LDEBUGFS_SEQ_FOPS_RO_TYPE(name, type) \
747 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
751 return lprocfs_##type##_seq_show(m, m->private); \
753 LDEBUGFS_SEQ_FOPS_RO(name##_##type)
755 #define LDEBUGFS_SEQ_FOPS_RW_TYPE(name, type) \
756 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
760 return lprocfs_##type##_seq_show(m, m->private); \
762 static ssize_t name##_##type##_seq_write(struct file *file, \
763 const char __user *buffer, size_t count, \
766 struct seq_file *seq = file->private_data; \
770 return ldebugfs_##type##_seq_write(file, buffer, count, \
773 LDEBUGFS_SEQ_FOPS(name##_##type);
775 #define LDEBUGFS_FOPS_WR_ONLY(name, type) \
776 static ssize_t name##_##type##_write(struct file *file, \
777 const char __user *buffer, size_t count, \
780 return ldebugfs_##type##_seq_write(file, buffer, count, \
783 static int name##_##type##_open(struct inode *inode, \
786 return single_open(file, NULL, inode->i_private); \
788 static const struct file_operations name##_##type##_fops = { \
789 .open = name##_##type##_open, \
790 .write = name##_##type##_write, \
791 .release = single_release, \
794 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
795 * proc entries; otherwise, you will define name##_seq_write function also for
796 * a read-write proc entry, and then call LPROC_SEQ_FOPS instead. Finally,
797 * call ldebugfs_obd_seq_create(obd, filename, 0444, &name#_fops, data);
799 #define __LPROC_SEQ_FOPS(name, custom_seq_write) \
800 static int name##_single_open(struct inode *inode, struct file *file) \
802 return single_open(file, name##_seq_show, \
803 inode->i_private ? inode->i_private : \
806 static const struct proc_ops name##_fops = { \
807 PROC_OWNER(THIS_MODULE) \
808 .proc_open = name##_single_open, \
809 .proc_read = seq_read, \
810 .proc_write = custom_seq_write, \
811 .proc_lseek = seq_lseek, \
812 .proc_release = lprocfs_single_release, \
815 #define LPROC_SEQ_FOPS_RO(name) __LPROC_SEQ_FOPS(name, NULL)
816 #define LPROC_SEQ_FOPS(name) __LPROC_SEQ_FOPS(name, name##_seq_write)
818 #define LPROC_SEQ_FOPS_RO_TYPE(name, type) \
819 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
821 return lprocfs_##type##_seq_show(m, m->private); \
823 LPROC_SEQ_FOPS_RO(name##_##type)
825 #define LPROC_SEQ_FOPS_RW_TYPE(name, type) \
826 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
828 return lprocfs_##type##_seq_show(m, m->private); \
830 static ssize_t name##_##type##_seq_write(struct file *file, \
831 const char __user *buffer, size_t count, \
834 struct seq_file *seq = file->private_data; \
835 return lprocfs_##type##_seq_write(file, buffer, \
836 count, seq->private); \
838 LPROC_SEQ_FOPS(name##_##type);
840 #define LPROC_SEQ_FOPS_WR_ONLY(name, type) \
841 static ssize_t name##_##type##_write(struct file *file, \
842 const char __user *buffer, size_t count, \
845 return lprocfs_##type##_seq_write(file, buffer, count, off);\
847 static int name##_##type##_open(struct inode *inode, struct file *file)\
849 return single_open(file, NULL, \
850 inode->i_private ? inode->i_private : \
853 static const struct proc_ops name##_##type##_fops = { \
854 .proc_open = name##_##type##_open, \
855 .proc_write = name##_##type##_write, \
856 .proc_release = lprocfs_single_release, \
860 struct attribute attr;
861 ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
863 ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
864 const char *buf, size_t len);
867 #define LUSTRE_ATTR(name, mode, show, store) \
868 static struct lustre_attr lustre_attr_##name = __ATTR(name, mode, show, store)
870 #define LUSTRE_WO_ATTR(name) LUSTRE_ATTR(name, 0200, NULL, name##_store)
871 #define LUSTRE_RO_ATTR(name) LUSTRE_ATTR(name, 0444, name##_show, NULL)
872 #define LUSTRE_RW_ATTR(name) LUSTRE_ATTR(name, 0644, name##_show, name##_store)
874 ssize_t lustre_attr_show(struct kobject *kobj, struct attribute *attr,
876 ssize_t lustre_attr_store(struct kobject *kobj, struct attribute *attr,
877 const char *buf, size_t len);
879 extern const struct sysfs_ops lustre_sysfs_ops;
881 #define LUSTRE_OBD_UINT_PARAM_ATTR(name)\
882 static ssize_t name##_show(struct kobject *kobj, struct attribute *attr,\
886 struct obd_device *obd = \
887 container_of(kobj, struct obd_device, obd_kset.kobj); \
888 rc = snprintf(buf, PAGE_SIZE, "%u\n", obd->obd_##name); \
891 static ssize_t name##_store(struct kobject *kobj, struct attribute *attr,\
892 const char *buffer, size_t count) \
896 struct obd_device *obd = \
897 container_of(kobj, struct obd_device, obd_kset.kobj); \
898 rc = kstrtouint(buffer, 10, &val); \
901 obd->obd_##name = val; \
907 struct ptlrpc_request;
908 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
910 #ifdef HAVE_SERVER_SUPPORT
911 /* lprocfs_jobstats.c */
912 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
913 int event, long amount);
914 void lprocfs_job_stats_fini(struct obd_device *obd);
915 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
916 cntr_init_callback fn);
917 ssize_t job_cleanup_interval_show(struct kobject *kobj, struct attribute *attr,
919 ssize_t job_cleanup_interval_store(struct kobject *kobj,
920 struct attribute *attr,
921 const char *buffer, size_t count);
922 /* lproc_status_server.c */
923 ssize_t recovery_time_soft_show(struct kobject *kobj, struct attribute *attr,
925 ssize_t recovery_time_soft_store(struct kobject *kobj,
926 struct attribute *attr,
927 const char *buffer, size_t count);
928 ssize_t recovery_time_hard_show(struct kobject *kobj, struct attribute *attr,
930 ssize_t recovery_time_hard_store(struct kobject *kobj,
931 struct attribute *attr,
932 const char *buffer, size_t count);
933 ssize_t instance_show(struct kobject *kobj, struct attribute *attr,
937 int lprocfs_obd_max_pages_per_rpc_seq_show(struct seq_file *m, void *data);
938 ssize_t lprocfs_obd_max_pages_per_rpc_seq_write(struct file *file,
939 const char __user *buffer,
940 size_t count, loff_t *off);
941 ssize_t short_io_bytes_show(struct kobject *kobj, struct attribute *attr,
943 ssize_t short_io_bytes_store(struct kobject *kobj, struct attribute *attr,
944 const char *buffer, size_t count);
946 struct root_squash_info;
947 int lprocfs_wr_root_squash(const char __user *buffer, unsigned long count,
948 struct root_squash_info *squash, char *name);
949 int lprocfs_wr_nosquash_nids(const char __user *buffer, unsigned long count,
950 struct root_squash_info *squash, char *name);
952 #else /* !CONFIG_PROC_FS */
954 #define proc_lustre_root NULL
956 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
957 int index, long amount)
961 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats, int index)
965 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
966 int index, long amount)
970 static inline void lprocfs_counter_decr(struct lprocfs_stats *stats, int index)
974 static inline void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
975 enum lprocfs_counter_config config,
980 static inline void lprocfs_counter_init_units(struct lprocfs_stats *stats,
981 int index, enum lprocfs_counter_config config,
982 const char *name, const char *units)
986 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
987 enum lprocfs_fields_flags field)
992 /* NB: we return !NULL to satisfy error checker */
993 static inline struct lprocfs_stats *
994 lprocfs_stats_alloc(unsigned int num, enum lprocfs_stats_flags flags)
996 return (struct lprocfs_stats *)1;
999 static inline void lprocfs_stats_clear(struct lprocfs_stats *stats)
1003 static inline void lprocfs_stats_free(struct lprocfs_stats **stats)
1007 static inline int lprocfs_stats_register(struct proc_dir_entry *root,
1009 struct lprocfs_stats *stats)
1014 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
1018 static inline int lprocfs_alloc_obd_stats(struct obd_device *obd,
1019 unsigned int num_stats)
1024 static inline int lprocfs_alloc_md_stats(struct obd_device *obd,
1025 unsigned int num_private_stats)
1030 static inline void lprocfs_free_obd_stats(struct obd_device *obd)
1034 static inline void lprocfs_free_md_stats(struct obd_device *obd)
1039 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
1044 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
1048 #ifdef HAVE_SERVER_SUPPORT
1050 ssize_t lprocfs_nid_stats_seq_write(struct file *file,
1051 const char __user *buffer,
1052 size_t count, loff_t *off)
1057 static inline int lprocfs_nid_stats_clear_seq_show(struct seq_file *m,
1063 static inline int lprocfs_exp_setup(struct obd_export *exp,
1064 struct lnet_nid *peer_nid)
1069 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
1074 static inline struct proc_dir_entry *
1075 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
1076 void *data, const struct file_operations *fops)
1081 static inline struct proc_dir_entry *
1082 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
1083 const char *format, ...)
1088 static inline int lprocfs_add_vars(struct proc_dir_entry *root,
1089 struct lprocfs_vars *var, void *data)
1094 static inline struct proc_dir_entry *
1095 lprocfs_register(const char *name, struct proc_dir_entry *parent,
1096 struct lprocfs_vars *list, void *data)
1101 static inline void lprocfs_remove(struct proc_dir_entry **root)
1105 static inline void lprocfs_remove_proc_entry(const char *name,
1106 struct proc_dir_entry *parent)
1110 static inline int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only)
1115 static inline int lprocfs_obd_cleanup(struct obd_device *obd)
1120 static inline int lprocfs_uuid_seq_show(struct seq_file *m, void *data)
1125 static inline int lprocfs_server_seq_show(struct seq_file *m, void *data)
1130 static inline int lprocfs_import_seq_show(struct seq_file *m, void *data)
1135 static inline int lprocfs_state_seq_show(struct seq_file *m, void *data)
1140 static inline int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data)
1144 #ifdef HAVE_SERVER_SUPPORT
1145 static inline int lprocfs_num_exports_seq_show(struct seq_file *m, void *data)
1150 struct adaptive_timeout;
1151 static inline int lprocfs_at_hist_helper(struct seq_file *m,
1152 struct adaptive_timeout *at)
1157 static inline int lprocfs_timeouts_seq_show(struct seq_file *m, void *data)
1162 static inline ssize_t
1163 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
1164 size_t count, loff_t *off)
1168 #ifdef HAVE_SERVER_SUPPORT
1169 static inline ssize_t
1170 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
1171 size_t count, loff_t *off)
1177 static inline ssize_t
1178 lprocfs_ping_seq_write(struct file *file, const char __user *buffer,
1179 size_t count, loff_t *off)
1184 static inline ssize_t
1185 ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
1186 size_t count, loff_t *off)
1191 static inline ssize_t
1192 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
1193 size_t count, loff_t *off)
1199 lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data)
1204 static inline ssize_t
1205 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
1206 size_t count, loff_t *off)
1211 /* Statfs helpers */
1213 int lprocfs_blksize_seq_show(struct seq_file *m, void *data)
1219 int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data)
1225 int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data)
1231 int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data)
1237 int lprocfs_filestotal_seq_show(struct seq_file *m, void *data)
1243 int lprocfs_filesfree_seq_show(struct seq_file *m, void *data)
1249 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value)
1254 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value)
1259 void lprocfs_oh_clear(struct obd_histogram *oh)
1264 unsigned long lprocfs_oh_sum(struct obd_histogram *oh)
1270 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
1271 struct lprocfs_counter *cnt)
1276 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
1277 enum lprocfs_fields_flags field)
1282 #define LPROC_SEQ_FOPS_RO(name)
1283 #define LPROC_SEQ_FOPS(name)
1284 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)
1285 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)
1286 #define LPROC_SEQ_FOPS_WR_ONLY(name, type)
1288 /* lprocfs_jobstats.c */
1290 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid, int event,
1297 void lprocfs_job_stats_fini(struct obd_device *obd)
1302 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
1303 cntr_init_callback fn)
1309 /* lproc_ptlrpc.c */
1310 #define target_print_req NULL
1312 #endif /* CONFIG_PROC_FS */
1314 #endif /* LPROCFS_STATUS_H */