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.
131 enum lprocfs_counter_config {
132 LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
133 LPROCFS_CNTR_AVGMINMAX = 0x0002,
134 LPROCFS_CNTR_STDDEV = 0x0004,
136 /* counter unit type */
137 LPROCFS_TYPE_REQS = 0x0000, /* default if config = 0 */
138 LPROCFS_TYPE_BYTES = 0x0200,
139 LPROCFS_TYPE_PAGES = 0x0400,
140 LPROCFS_TYPE_LOCKS = 0x0500,
141 LPROCFS_TYPE_LOCKSPS = 0x0600,
142 LPROCFS_TYPE_SECS = 0x0700,
143 LPROCFS_TYPE_USECS = 0x0800,
144 LPROCFS_TYPE_MASK = 0x0f00,
146 LPROCFS_TYPE_LATENCY = LPROCFS_TYPE_USECS |
147 LPROCFS_CNTR_AVGMINMAX |
149 LPROCFS_TYPE_BYTES_FULL = LPROCFS_TYPE_BYTES |
150 LPROCFS_CNTR_AVGMINMAX |
153 #define LC_MIN_INIT ((~(__u64)0) >> 1)
155 struct lprocfs_counter_header {
156 enum lprocfs_counter_config lc_config;
157 const char *lc_name; /* must be static */
158 const char *lc_units; /* must be static */
161 struct lprocfs_counter {
167 * Every counter has lc_array_sum[0], while lc_array_sum[1] is only
168 * for irq context counter, i.e. stats with
169 * LPROCFS_STATS_FLAG_IRQ_SAFE flag, its counter need
172 __s64 lc_array_sum[1];
174 #define lc_sum lc_array_sum[0]
175 #define lc_sum_irq lc_array_sum[1]
177 struct lprocfs_percpu {
178 struct lprocfs_counter lp_cntr[0];
181 enum lprocfs_stats_lock_ops {
182 LPROCFS_GET_NUM_CPU = 0x0001, /* number allocated per-CPU stats */
183 LPROCFS_GET_SMP_ID = 0x0002, /* current stat to be updated */
186 enum lprocfs_stats_flags {
187 LPROCFS_STATS_FLAG_NONE = 0x0000, /* per cpu counter */
188 LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
189 * area and need locking */
190 LPROCFS_STATS_FLAG_IRQ_SAFE = 0x0002, /* alloc need irq safe */
193 enum lprocfs_fields_flags {
194 LPROCFS_FIELDS_FLAGS_CONFIG = 0x0001,
195 LPROCFS_FIELDS_FLAGS_SUM = 0x0002,
196 LPROCFS_FIELDS_FLAGS_MIN = 0x0003,
197 LPROCFS_FIELDS_FLAGS_MAX = 0x0004,
198 LPROCFS_FIELDS_FLAGS_AVG = 0x0005,
199 LPROCFS_FIELDS_FLAGS_SUMSQUARE = 0x0006,
200 LPROCFS_FIELDS_FLAGS_COUNT = 0x0007,
203 struct lprocfs_stats {
205 unsigned short ls_num;
206 /* 1 + the biggest cpu # whose ls_percpu slot has been allocated */
207 unsigned short ls_biggest_alloc_num;
208 enum lprocfs_stats_flags ls_flags;
210 /* Lock used when there are no percpu stats areas; For percpu stats,
211 * it is used to protect ls_biggest_alloc_num change */
214 /* has ls_num of counter headers */
215 struct lprocfs_counter_header *ls_cnt_header;
216 struct lprocfs_percpu *ls_percpu[0];
219 #define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
221 /* Pack all opcodes down into a single monotonically increasing index */
222 static inline int opcode_offset(__u32 opc) {
223 if (opc < OST_LAST_OPC) {
225 return (opc - OST_FIRST_OPC);
226 } else if (opc < MDS_LAST_OPC) {
228 return (opc - MDS_FIRST_OPC +
230 } else if (opc < LDLM_LAST_OPC) {
232 return (opc - LDLM_FIRST_OPC +
235 } else if (opc < MGS_LAST_OPC) {
237 return (opc - MGS_FIRST_OPC +
241 } else if (opc < OBD_LAST_OPC) {
243 return (opc - OBD_FIRST_OPC +
248 } else if (opc < LLOG_LAST_OPC) {
250 return (opc - LLOG_FIRST_OPC +
256 } else if (opc < QUOTA_LAST_OPC) {
258 return (opc - QUOTA_FIRST_OPC +
265 } else if (opc < SEQ_LAST_OPC) {
267 return (opc - SEQ_FIRST_OPC +
275 } else if (opc < SEC_LAST_OPC) {
277 return (opc - SEC_FIRST_OPC +
286 } else if (opc < FLD_LAST_OPC) {
288 return (opc - FLD_FIRST_OPC +
298 #ifdef HAVE_SERVER_SUPPORT
299 } else if (opc < OUT_UPDATE_LAST_OPC) {
301 return (opc - OUT_UPDATE_FIRST_OPC +
312 } else if (opc < LFSCK_LAST_OPC) {
314 return (opc - LFSCK_FIRST_OPC +
315 OPC_RANGE(OUT_UPDATE) +
326 #endif /* HAVE_SERVER_SUPPORT */
333 #define LUSTRE_MAX_OPCODES_CLIENT (OPC_RANGE(OST) + \
344 #ifdef HAVE_SERVER_SUPPORT
345 #define LUSTRE_MAX_OPCODES (LUSTRE_MAX_OPCODES_CLIENT + \
346 OPC_RANGE(OUT_UPDATE) + \
349 #define LUSTRE_MAX_OPCODES LUSTRE_MAX_OPCODES_CLIENT
352 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR) + \
356 PTLRPC_REQWAIT_CNTR = 0,
357 PTLRPC_REQQDEPTH_CNTR,
358 PTLRPC_REQACTIVE_CNTR,
360 PTLRPC_REQBUF_AVAIL_CNTR,
364 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
366 enum lprocfs_extra_opc {
367 LDLM_GLIMPSE_ENQUEUE = 0,
385 #ifdef HAVE_SERVER_SUPPORT
391 BRW_R_DISCONT_BLOCKS,
392 BRW_W_DISCONT_BLOCKS,
406 struct brw_stats_props {
407 const char *bsp_name;
408 const char *bsp_units;
414 struct obd_hist_pcpu bs_hist[BRW_RW_STATS_NUM];
415 struct brw_stats_props bs_props[BRW_RW_STATS_NUM / 2];
418 int lprocfs_init_brw_stats(struct brw_stats *brw_stats);
419 void lprocfs_fini_brw_stats(struct brw_stats *brw_stats);
421 void ldebugfs_register_osd_stats(struct dentry *parent,
422 struct brw_stats *brw_stats,
423 struct lprocfs_stats *stats);
424 #endif /* HAVE_SERVER_SUPPORT */
426 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
428 extern struct proc_dir_entry *proc_lustre_root;
429 extern struct dentry *debugfs_lustre_root;
430 extern struct kset *lustre_kset;
434 #define JOBSTATS_JOBID_VAR_MAX_LEN 20
435 #define JOBSTATS_DISABLE "disable"
436 #define JOBSTATS_PROCNAME_UID "procname_uid"
437 #define JOBSTATS_NODELOCAL "nodelocal"
438 #define JOBSTATS_SESSION "session"
440 typedef void (*cntr_init_callback)(struct lprocfs_stats *stats,
441 unsigned int offset);
443 struct obd_job_stats {
444 struct cfs_hash *ojs_hash; /* hash of jobids */
445 struct list_head ojs_list; /* list of job_stat structs */
446 rwlock_t ojs_lock; /* protect ojs_list/js_list */
447 ktime_t ojs_cleanup_interval;/* 1/2 expiry seconds */
448 ktime_t ojs_cleanup_last;/* previous cleanup time */
449 cntr_init_callback ojs_cntr_init_fn;/* lprocfs_stats initializer */
450 unsigned short ojs_cntr_num; /* number of stats in struct */
451 bool ojs_cleaning; /* currently expiring stats */
454 #ifdef CONFIG_PROC_FS
456 int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
458 int lprocfs_stats_lock(struct lprocfs_stats *stats,
459 enum lprocfs_stats_lock_ops opc,
460 unsigned long *flags);
461 void lprocfs_stats_unlock(struct lprocfs_stats *stats,
462 enum lprocfs_stats_lock_ops opc,
463 unsigned long *flags);
465 static inline unsigned int
466 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
468 unsigned int percpusize;
470 percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
472 /* irq safe stats need lc_array_sum[1] */
473 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
474 percpusize += stats->ls_num * sizeof(__s64);
476 if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
477 percpusize = L1_CACHE_ALIGN(percpusize);
482 static inline struct lprocfs_counter *
483 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
486 struct lprocfs_counter *cntr;
488 cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
490 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
491 cntr = (void *)cntr + index * sizeof(__s64);
496 /* Two optimized LPROCFS counter increment functions are provided:
497 * lprocfs_counter_incr(cntr, value) - optimized for by-one counters
498 * lprocfs_counter_add(cntr) - use for multi-valued counters
499 * Counter data layout allows config flag, counter lock and the
500 * count itself to reside within a single cache line.
503 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
505 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
508 #define lprocfs_counter_incr(stats, idx) \
509 lprocfs_counter_add(stats, idx, 1)
510 #define lprocfs_counter_decr(stats, idx) \
511 lprocfs_counter_sub(stats, idx, 1)
513 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
514 struct lprocfs_counter_header *header,
515 enum lprocfs_stats_flags flags,
516 enum lprocfs_fields_flags field);
517 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
518 enum lprocfs_fields_flags field);
520 extern struct lprocfs_stats *
521 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags);
522 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
523 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
524 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
525 extern int lprocfs_alloc_obd_stats(struct obd_device *obd,
526 unsigned int num_stats);
527 extern int lprocfs_alloc_md_stats(struct obd_device *obd,
528 unsigned int num_private_stats);
529 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
530 enum lprocfs_counter_config config,
532 extern void lprocfs_counter_init_units(struct lprocfs_stats *stats, int index,
533 enum lprocfs_counter_config config,
534 const char *name, const char *units);
535 extern void lprocfs_free_obd_stats(struct obd_device *obd);
536 extern void lprocfs_free_md_stats(struct obd_device *obd);
539 extern int lprocfs_add_clear_entry(struct obd_device *obd,
540 struct proc_dir_entry *entry);
541 #ifdef HAVE_SERVER_SUPPORT
542 extern int lprocfs_exp_setup(struct obd_export *exp, struct lnet_nid *peer_nid);
543 extern int lprocfs_exp_cleanup(struct obd_export *exp);
544 struct dentry *ldebugfs_add_symlink(const char *name, const char *target,
545 const char *format, ...);
547 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
550 extern struct proc_dir_entry *
551 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
552 void *data, const struct proc_ops *ops);
553 extern struct proc_dir_entry *
554 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
555 const char *format, ...);
556 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
557 #ifdef HAVE_SERVER_SUPPORT
559 lprocfs_nid_stats_clear_seq_write(struct file *file, const char __user *buffer,
560 size_t count, loff_t *off);
561 extern int lprocfs_nid_stats_clear_seq_show(struct seq_file *file, void *data);
563 extern int lprocfs_register_stats(struct proc_dir_entry *root, const char *name,
564 struct lprocfs_stats *stats);
565 extern const struct file_operations ldebugfs_stats_seq_fops;
567 /* lprocfs_status.c */
568 extern void ldebugfs_add_vars(struct dentry *parent, struct ldebugfs_vars *var,
570 extern struct dentry *ldebugfs_register(const char *name,
571 struct dentry *parent,
572 struct ldebugfs_vars *list,
574 extern int lprocfs_add_vars(struct proc_dir_entry *root,
575 struct lprocfs_vars *var, void *data);
577 extern struct proc_dir_entry *
578 lprocfs_register(const char *name, struct proc_dir_entry *parent,
579 struct lprocfs_vars *list, void *data);
581 extern void lprocfs_remove(struct proc_dir_entry **root);
582 extern void lprocfs_remove_proc_entry(const char *name,
583 struct proc_dir_entry *parent);
584 extern int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only);
585 extern int lprocfs_obd_cleanup(struct obd_device *obd);
587 extern int lprocfs_seq_create(struct proc_dir_entry *parent, const char *name,
588 mode_t mode, const struct proc_ops *seq_fops,
590 extern int lprocfs_obd_seq_create(struct obd_device *obd, const char *name,
591 mode_t mode, const struct proc_ops *seq_fops,
593 extern void lprocfs_stats_header(struct seq_file *seq, ktime_t now,
594 ktime_t ts_init, int width, const char *colon,
597 /* Generic callbacks */
598 extern int lprocfs_uuid_seq_show(struct seq_file *m, void *data);
599 extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
600 ssize_t conn_uuid_show(struct kobject *kobj, struct attribute *attr, char *buf);
601 extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
602 extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
603 extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
604 #ifdef HAVE_SERVER_SUPPORT
605 ssize_t num_exports_show(struct kobject *kobj, struct attribute *attr,
607 ssize_t grant_check_threshold_show(struct kobject *kobj,
608 struct attribute *attr, char *buf);
609 ssize_t grant_check_threshold_store(struct kobject *kobj,
610 struct attribute *attr,
611 const char *buffer, size_t count);
613 struct adaptive_timeout;
614 extern int lprocfs_at_hist_helper(struct seq_file *m,
615 struct adaptive_timeout *at);
616 extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
618 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
619 size_t count, loff_t *off);
620 #ifdef HAVE_SERVER_SUPPORT
622 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
623 size_t count, loff_t *off);
625 ssize_t ping_store(struct kobject *kobj, struct attribute *attr,
626 const char *buffer, size_t count);
627 ssize_t ping_show(struct kobject *kobj, struct attribute *attr,
631 ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
632 size_t count, loff_t *off);
633 static inline ssize_t
634 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
635 size_t count, loff_t *off)
637 return ldebugfs_import_seq_write(file, buffer, count, off);
640 extern int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data);
642 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
643 size_t count, loff_t *off);
645 int string_to_size(u64 *size, const char *buffer, size_t count);
646 int sysfs_memparse(const char *buffer, size_t count, u64 *val,
647 const char *defunit);
648 char *lprocfs_strnstr(const char *s1, const char *s2, size_t len);
649 char *lprocfs_find_named_value(const char *buffer, const char *name,
651 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
652 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
653 void lprocfs_oh_clear(struct obd_histogram *oh);
654 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
656 void lprocfs_oh_tally_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
657 void lprocfs_oh_tally_log2_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
658 int lprocfs_oh_alloc_pcpu(struct obd_hist_pcpu *oh);
659 void lprocfs_oh_clear_pcpu(struct obd_hist_pcpu *oh);
660 void lprocfs_oh_release_pcpu(struct obd_hist_pcpu *oh);
661 unsigned long lprocfs_oh_sum_pcpu(struct obd_hist_pcpu *oh);
662 unsigned long lprocfs_oh_counter_pcpu(struct obd_hist_pcpu *oh,
665 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
666 struct lprocfs_counter *cnt);
668 #ifdef HAVE_SERVER_SUPPORT
669 /* lprocfs_status.c: recovery status */
670 int lprocfs_recovery_status_seq_show(struct seq_file *m, void *data);
672 /* lprocfs_status.c: hash statistics */
673 int lprocfs_hash_seq_show(struct seq_file *m, void *data);
675 /* lprocfs_status.c: IR factor */
676 ssize_t ir_factor_show(struct kobject *kobj, struct attribute *attr,
678 ssize_t ir_factor_store(struct kobject *kobj, struct attribute *attr,
679 const char *buffer, size_t count);
682 /* lprocfs_status.c: dump pages on cksum error */
683 int lprocfs_checksum_dump_seq_show(struct seq_file *m, void *data);
685 lprocfs_checksum_dump_seq_write(struct file *file, const char __user *buffer,
686 size_t count, loff_t *off);
688 extern int lprocfs_single_release(struct inode *, struct file *);
689 extern int lprocfs_seq_release(struct inode *, struct file *);
691 /* You must use these macros when you want to refer to
692 * the import in a client obd_device for a lprocfs entry
693 * Note that it is not safe to 'goto', 'return' or 'break'
694 * out of the body of this statement. It *IS* safe to
695 * 'goto' the a label inside the statement, or to 'continue'
696 * to get out of the statement.
699 #define with_imp_locked_nested(__obd, __imp, __rc, __nest) \
700 for (down_read_nested(&(__obd)->u.cli.cl_sem, __nest), \
701 __imp = (__obd)->u.cli.cl_import, \
702 __rc = __imp ? 0 : -ENODEV; \
703 __imp ? 1 : (up_read(&(__obd)->u.cli.cl_sem), 0); \
706 #define with_imp_locked(__obd, __imp, __rc) \
707 with_imp_locked_nested(__obd, __imp, __rc, 0)
709 /* write the name##_seq_show function, call LDEBUGFS_SEQ_FOPS_RO for read-only
710 * debugfs entries; otherwise, you will define name##_seq_write function also
711 * for a read-write debugfs entry, and then call LDEBUGFS_SEQ_FOPS instead.
712 * Finally, call debugfs_create_file(filename, 0444, obd, data, &name#_fops);
714 #define __LDEBUGFS_SEQ_FOPS(name, custom_seq_write) \
715 static int name##_single_open(struct inode *inode, struct file *file) \
717 return single_open(file, name##_seq_show, inode->i_private); \
719 static const struct file_operations name##_fops = { \
720 .owner = THIS_MODULE, \
721 .open = name##_single_open, \
723 .write = custom_seq_write, \
724 .llseek = seq_lseek, \
725 .release = single_release, \
728 #define LDEBUGFS_SEQ_FOPS_RO(name) __LDEBUGFS_SEQ_FOPS(name, NULL)
729 #define LDEBUGFS_SEQ_FOPS(name) __LDEBUGFS_SEQ_FOPS(name, \
732 #define LDEBUGFS_SEQ_FOPS_RO_TYPE(name, type) \
733 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
737 return lprocfs_##type##_seq_show(m, m->private); \
739 LDEBUGFS_SEQ_FOPS_RO(name##_##type)
741 #define LDEBUGFS_SEQ_FOPS_RW_TYPE(name, type) \
742 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
746 return lprocfs_##type##_seq_show(m, m->private); \
748 static ssize_t name##_##type##_seq_write(struct file *file, \
749 const char __user *buffer, size_t count, \
752 struct seq_file *seq = file->private_data; \
756 return ldebugfs_##type##_seq_write(file, buffer, count, \
759 LDEBUGFS_SEQ_FOPS(name##_##type);
761 #define LDEBUGFS_FOPS_WR_ONLY(name, type) \
762 static ssize_t name##_##type##_write(struct file *file, \
763 const char __user *buffer, size_t count, \
766 return ldebugfs_##type##_seq_write(file, buffer, count, \
769 static int name##_##type##_open(struct inode *inode, \
772 return single_open(file, NULL, inode->i_private); \
774 static const struct file_operations name##_##type##_fops = { \
775 .open = name##_##type##_open, \
776 .write = name##_##type##_write, \
777 .release = single_release, \
780 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
781 * proc entries; otherwise, you will define name##_seq_write function also for
782 * a read-write proc entry, and then call LPROC_SEQ_FOPS instead. Finally,
783 * call ldebugfs_obd_seq_create(obd, filename, 0444, &name#_fops, data);
785 #define __LPROC_SEQ_FOPS(name, custom_seq_write) \
786 static int name##_single_open(struct inode *inode, struct file *file) \
788 return single_open(file, name##_seq_show, \
789 inode->i_private ? inode->i_private : \
792 static const struct proc_ops name##_fops = { \
793 PROC_OWNER(THIS_MODULE) \
794 .proc_open = name##_single_open, \
795 .proc_read = seq_read, \
796 .proc_write = custom_seq_write, \
797 .proc_lseek = seq_lseek, \
798 .proc_release = lprocfs_single_release, \
801 #define LPROC_SEQ_FOPS_RO(name) __LPROC_SEQ_FOPS(name, NULL)
802 #define LPROC_SEQ_FOPS(name) __LPROC_SEQ_FOPS(name, name##_seq_write)
804 #define LPROC_SEQ_FOPS_RO_TYPE(name, type) \
805 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
807 return lprocfs_##type##_seq_show(m, m->private); \
809 LPROC_SEQ_FOPS_RO(name##_##type)
811 #define LPROC_SEQ_FOPS_RW_TYPE(name, type) \
812 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
814 return lprocfs_##type##_seq_show(m, m->private); \
816 static ssize_t name##_##type##_seq_write(struct file *file, \
817 const char __user *buffer, size_t count, \
820 struct seq_file *seq = file->private_data; \
821 return lprocfs_##type##_seq_write(file, buffer, \
822 count, seq->private); \
824 LPROC_SEQ_FOPS(name##_##type);
826 #define LPROC_SEQ_FOPS_WR_ONLY(name, type) \
827 static ssize_t name##_##type##_write(struct file *file, \
828 const char __user *buffer, size_t count, \
831 return lprocfs_##type##_seq_write(file, buffer, count, off);\
833 static int name##_##type##_open(struct inode *inode, struct file *file)\
835 return single_open(file, NULL, \
836 inode->i_private ? inode->i_private : \
839 static const struct proc_ops name##_##type##_fops = { \
840 .proc_open = name##_##type##_open, \
841 .proc_write = name##_##type##_write, \
842 .proc_release = lprocfs_single_release, \
846 struct attribute attr;
847 ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
849 ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
850 const char *buf, size_t len);
853 #define LUSTRE_ATTR(name, mode, show, store) \
854 static struct lustre_attr lustre_attr_##name = __ATTR(name, mode, show, store)
856 #define LUSTRE_WO_ATTR(name) LUSTRE_ATTR(name, 0200, NULL, name##_store)
857 #define LUSTRE_RO_ATTR(name) LUSTRE_ATTR(name, 0444, name##_show, NULL)
858 #define LUSTRE_RW_ATTR(name) LUSTRE_ATTR(name, 0644, name##_show, name##_store)
860 ssize_t lustre_attr_show(struct kobject *kobj, struct attribute *attr,
862 ssize_t lustre_attr_store(struct kobject *kobj, struct attribute *attr,
863 const char *buf, size_t len);
865 extern const struct sysfs_ops lustre_sysfs_ops;
868 struct ptlrpc_request;
869 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
871 #ifdef HAVE_SERVER_SUPPORT
872 /* lprocfs_jobstats.c */
873 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
874 int event, long amount);
875 void lprocfs_job_stats_fini(struct obd_device *obd);
876 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
877 cntr_init_callback fn);
878 ssize_t job_cleanup_interval_show(struct kobject *kobj, struct attribute *attr,
880 ssize_t job_cleanup_interval_store(struct kobject *kobj,
881 struct attribute *attr,
882 const char *buffer, size_t count);
883 /* lproc_status_server.c */
884 ssize_t recovery_time_soft_show(struct kobject *kobj, struct attribute *attr,
886 ssize_t recovery_time_soft_store(struct kobject *kobj,
887 struct attribute *attr,
888 const char *buffer, size_t count);
889 ssize_t recovery_time_hard_show(struct kobject *kobj, struct attribute *attr,
891 ssize_t recovery_time_hard_store(struct kobject *kobj,
892 struct attribute *attr,
893 const char *buffer, size_t count);
894 ssize_t instance_show(struct kobject *kobj, struct attribute *attr,
898 int lprocfs_obd_max_pages_per_rpc_seq_show(struct seq_file *m, void *data);
899 ssize_t lprocfs_obd_max_pages_per_rpc_seq_write(struct file *file,
900 const char __user *buffer,
901 size_t count, loff_t *off);
902 ssize_t short_io_bytes_show(struct kobject *kobj, struct attribute *attr,
904 ssize_t short_io_bytes_store(struct kobject *kobj, struct attribute *attr,
905 const char *buffer, size_t count);
907 struct root_squash_info;
908 int lprocfs_wr_root_squash(const char __user *buffer, unsigned long count,
909 struct root_squash_info *squash, char *name);
910 int lprocfs_wr_nosquash_nids(const char __user *buffer, unsigned long count,
911 struct root_squash_info *squash, char *name);
913 #else /* !CONFIG_PROC_FS */
915 #define proc_lustre_root NULL
917 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
918 int index, long amount)
920 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats, int index)
922 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
923 int index, long amount)
925 static inline void lprocfs_counter_decr(struct lprocfs_stats *stats, int index)
927 static inline void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
928 enum lprocfs_counter_config config,
931 static inline void lprocfs_counter_init_units(struct lprocfs_stats *stats,
932 int index, enum lprocfs_counter_config config,
933 const char *name, const char *units)
936 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
937 enum lprocfs_fields_flags field)
940 /* NB: we return !NULL to satisfy error checker */
941 static inline struct lprocfs_stats *
942 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags)
943 { return (struct lprocfs_stats *)1; }
944 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
946 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
948 static inline int lprocfs_register_stats(struct proc_dir_entry *root,
950 struct lprocfs_stats *stats)
952 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
954 static inline int lprocfs_alloc_obd_stats(struct obd_device *obd,
955 unsigned int num_stats)
957 static inline int lprocfs_alloc_md_stats(struct obd_device *obd,
958 unsigned int num_private_stats)
960 static inline void lprocfs_free_obd_stats(struct obd_device *obd)
962 static inline void lprocfs_free_md_stats(struct obd_device *obd)
966 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
968 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
970 #ifdef HAVE_SERVER_SUPPORT
972 ssize_t lprocfs_nid_stats_seq_write(struct file *file,
973 const char __user *buffer,
974 size_t count, loff_t *off)
977 int lprocfs_nid_stats_clear_seq_show(struct seq_file *m, void *data)
979 static inline int lprocfs_exp_setup(struct obd_export *exp,
980 struct lnet_nid *peer_nid)
983 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
985 static inline struct proc_dir_entry *
986 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
987 void *data, const struct file_operations *fops)
989 static inline struct proc_dir_entry *
990 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
991 const char *format, ...)
993 static inline int lprocfs_add_vars(struct proc_dir_entry *root,
994 struct lprocfs_vars *var, void *data)
996 static inline struct proc_dir_entry *
997 lprocfs_register(const char *name, struct proc_dir_entry *parent,
998 struct lprocfs_vars *list, void *data)
1000 static inline void lprocfs_remove(struct proc_dir_entry **root)
1002 static inline void lprocfs_remove_proc_entry(const char *name,
1003 struct proc_dir_entry *parent)
1005 static inline int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only)
1007 static inline int lprocfs_obd_cleanup(struct obd_device *obd)
1009 static inline int lprocfs_uuid_seq_show(struct seq_file *m, void *data)
1011 static inline int lprocfs_server_seq_show(struct seq_file *m, void *data)
1013 static inline int lprocfs_import_seq_show(struct seq_file *m, void *data)
1015 static inline int lprocfs_state_seq_show(struct seq_file *m, void *data)
1017 static inline int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data)
1019 #ifdef HAVE_SERVER_SUPPORT
1020 static inline int lprocfs_num_exports_seq_show(struct seq_file *m, void *data)
1023 struct adaptive_timeout;
1024 static inline int lprocfs_at_hist_helper(struct seq_file *m,
1025 struct adaptive_timeout *at)
1027 static inline int lprocfs_timeouts_seq_show(struct seq_file *m, void *data)
1029 static inline ssize_t
1030 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
1031 size_t count, loff_t *off)
1033 #ifdef HAVE_SERVER_SUPPORT
1034 static inline ssize_t
1035 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
1036 size_t count, loff_t *off)
1039 static inline ssize_t
1040 lprocfs_ping_seq_write(struct file *file, const char __user *buffer,
1041 size_t count, loff_t *off)
1043 static inline ssize_t
1044 ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
1045 size_t count, loff_t *off)
1047 static inline ssize_t
1048 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
1049 size_t count, loff_t *off)
1052 lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data)
1054 static inline ssize_t
1055 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
1056 size_t count, loff_t *off)
1059 /* Statfs helpers */
1061 int lprocfs_blksize_seq_show(struct seq_file *m, void *data)
1064 int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data)
1067 int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data)
1070 int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data)
1073 int lprocfs_filestotal_seq_show(struct seq_file *m, void *data)
1076 int lprocfs_filesfree_seq_show(struct seq_file *m, void *data)
1079 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value)
1082 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value)
1085 void lprocfs_oh_clear(struct obd_histogram *oh)
1088 unsigned long lprocfs_oh_sum(struct obd_histogram *oh)
1091 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
1092 struct lprocfs_counter *cnt)
1095 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
1096 enum lprocfs_fields_flags field)
1097 { return (__u64)0; }
1099 #define LPROC_SEQ_FOPS_RO(name)
1100 #define LPROC_SEQ_FOPS(name)
1101 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)
1102 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)
1103 #define LPROC_SEQ_FOPS_WR_ONLY(name, type)
1105 /* lprocfs_jobstats.c */
1107 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid, int event,
1111 void lprocfs_job_stats_fini(struct obd_device *obd)
1114 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
1115 cntr_init_callback fn)
1119 /* lproc_ptlrpc.c */
1120 #define target_print_req NULL
1122 #endif /* CONFIG_PROC_FS */
1124 #endif /* LPROCFS_STATUS_H */