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];
111 RENAME_SAMEDIR_SIZE = 0,
112 RENAME_CROSSDIR_SRC_SIZE,
113 RENAME_CROSSDIR_TGT_SIZE,
117 struct rename_stats {
119 struct obd_histogram rs_hist[RENAME_LAST];
122 /* An lprocfs counter can be configured using the enum bit masks below.
124 * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
125 * protects this counter from concurrent updates. If not specified,
126 * lprocfs an internal per-counter lock variable. External locks are
127 * not used to protect counter increments, but are used to protect
128 * counter readout and resets.
130 * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
131 * (i.e. counter can be incremented by more than "1"). When specified,
132 * the counter maintains min, max and sum in addition to a simple
133 * invocation count. This allows averages to be be computed.
134 * If not specified, the counter is an increment-by-1 counter.
135 * min, max, sum, etc. are not maintained.
137 * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
138 * squares (for multi-valued counter samples only). This allows
139 * external computation of standard deviation, but involves a 64-bit
140 * multiply per counter increment.
144 LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
145 LPROCFS_CNTR_AVGMINMAX = 0x0002,
146 LPROCFS_CNTR_STDDEV = 0x0004,
148 /* counter data type */
149 LPROCFS_TYPE_REQS = 0x0100,
150 LPROCFS_TYPE_BYTES = 0x0200,
151 LPROCFS_TYPE_PAGES = 0x0400,
152 LPROCFS_TYPE_USEC = 0x0800,
154 LPROCFS_TYPE_LATENCY = LPROCFS_TYPE_USEC |
155 LPROCFS_CNTR_AVGMINMAX |
157 LPROCFS_TYPE_BYTES_FULL = LPROCFS_TYPE_BYTES |
158 LPROCFS_CNTR_AVGMINMAX |
161 #define LC_MIN_INIT ((~(__u64)0) >> 1)
163 struct lprocfs_counter_header {
164 unsigned int lc_config;
165 const char *lc_name; /* must be static */
166 const char *lc_units; /* must be static */
169 struct lprocfs_counter {
175 * Every counter has lc_array_sum[0], while lc_array_sum[1] is only
176 * for irq context counter, i.e. stats with
177 * LPROCFS_STATS_FLAG_IRQ_SAFE flag, its counter need
180 __s64 lc_array_sum[1];
182 #define lc_sum lc_array_sum[0]
183 #define lc_sum_irq lc_array_sum[1]
185 struct lprocfs_percpu {
186 struct lprocfs_counter lp_cntr[0];
189 enum lprocfs_stats_lock_ops {
190 LPROCFS_GET_NUM_CPU = 0x0001, /* number allocated per-CPU stats */
191 LPROCFS_GET_SMP_ID = 0x0002, /* current stat to be updated */
194 enum lprocfs_stats_flags {
195 LPROCFS_STATS_FLAG_NONE = 0x0000, /* per cpu counter */
196 LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
197 * area and need locking */
198 LPROCFS_STATS_FLAG_IRQ_SAFE = 0x0002, /* alloc need irq safe */
201 enum lprocfs_fields_flags {
202 LPROCFS_FIELDS_FLAGS_CONFIG = 0x0001,
203 LPROCFS_FIELDS_FLAGS_SUM = 0x0002,
204 LPROCFS_FIELDS_FLAGS_MIN = 0x0003,
205 LPROCFS_FIELDS_FLAGS_MAX = 0x0004,
206 LPROCFS_FIELDS_FLAGS_AVG = 0x0005,
207 LPROCFS_FIELDS_FLAGS_SUMSQUARE = 0x0006,
208 LPROCFS_FIELDS_FLAGS_COUNT = 0x0007,
211 struct lprocfs_stats {
213 unsigned short ls_num;
214 /* 1 + the biggest cpu # whose ls_percpu slot has been allocated */
215 unsigned short ls_biggest_alloc_num;
216 enum lprocfs_stats_flags ls_flags;
218 /* Lock used when there are no percpu stats areas; For percpu stats,
219 * it is used to protect ls_biggest_alloc_num change */
222 /* has ls_num of counter headers */
223 struct lprocfs_counter_header *ls_cnt_header;
224 struct lprocfs_percpu *ls_percpu[0];
227 #define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
229 /* Pack all opcodes down into a single monotonically increasing index */
230 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,
412 struct brw_stats_props {
413 const char *bsp_name;
414 const char *bsp_units;
420 struct obd_hist_pcpu bs_hist[BRW_RW_STATS_NUM];
421 struct brw_stats_props bs_props[BRW_RW_STATS_NUM / 2];
424 int lprocfs_init_brw_stats(struct brw_stats *brw_stats);
425 void lprocfs_fini_brw_stats(struct brw_stats *brw_stats);
427 void ldebugfs_register_osd_stats(struct dentry *parent,
428 struct brw_stats *brw_stats,
429 struct lprocfs_stats *stats);
430 #endif /* HAVE_SERVER_SUPPORT */
432 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
434 extern struct proc_dir_entry *proc_lustre_root;
435 extern struct dentry *debugfs_lustre_root;
436 extern struct kset *lustre_kset;
440 #define JOBSTATS_JOBID_VAR_MAX_LEN 20
441 #define JOBSTATS_DISABLE "disable"
442 #define JOBSTATS_PROCNAME_UID "procname_uid"
443 #define JOBSTATS_NODELOCAL "nodelocal"
444 #define JOBSTATS_SESSION "session"
446 typedef void (*cntr_init_callback)(struct lprocfs_stats *stats,
447 unsigned int offset);
449 struct obd_job_stats {
450 struct cfs_hash *ojs_hash; /* hash of jobids */
451 struct list_head ojs_list; /* list of job_stat structs */
452 rwlock_t ojs_lock; /* protect ojs_list/js_list */
453 ktime_t ojs_cleanup_interval;/* 1/2 expiry seconds */
454 ktime_t ojs_cleanup_last;/* previous cleanup time */
455 cntr_init_callback ojs_cntr_init_fn;/* lprocfs_stats initializer */
456 unsigned short ojs_cntr_num; /* number of stats in struct */
457 bool ojs_cleaning; /* currently expiring stats */
460 #ifdef CONFIG_PROC_FS
462 int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
464 int lprocfs_stats_lock(struct lprocfs_stats *stats,
465 enum lprocfs_stats_lock_ops opc,
466 unsigned long *flags);
467 void lprocfs_stats_unlock(struct lprocfs_stats *stats,
468 enum lprocfs_stats_lock_ops opc,
469 unsigned long *flags);
471 static inline unsigned int
472 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
474 unsigned int percpusize;
476 percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
478 /* irq safe stats need lc_array_sum[1] */
479 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
480 percpusize += stats->ls_num * sizeof(__s64);
482 if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
483 percpusize = L1_CACHE_ALIGN(percpusize);
488 static inline struct lprocfs_counter *
489 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
492 struct lprocfs_counter *cntr;
494 cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
496 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
497 cntr = (void *)cntr + index * sizeof(__s64);
502 /* Two optimized LPROCFS counter increment functions are provided:
503 * lprocfs_counter_incr(cntr, value) - optimized for by-one counters
504 * lprocfs_counter_add(cntr) - use for multi-valued counters
505 * Counter data layout allows config flag, counter lock and the
506 * count itself to reside within a single cache line.
509 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
511 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
514 #define lprocfs_counter_incr(stats, idx) \
515 lprocfs_counter_add(stats, idx, 1)
516 #define lprocfs_counter_decr(stats, idx) \
517 lprocfs_counter_sub(stats, idx, 1)
519 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
520 struct lprocfs_counter_header *header,
521 enum lprocfs_stats_flags flags,
522 enum lprocfs_fields_flags field);
523 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
524 enum lprocfs_fields_flags field);
526 extern struct lprocfs_stats *
527 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags);
528 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
529 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
530 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
531 extern int lprocfs_alloc_obd_stats(struct obd_device *obd,
532 unsigned int num_stats);
533 extern int lprocfs_alloc_md_stats(struct obd_device *obd,
534 unsigned int num_private_stats);
535 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
536 unsigned conf, const char *name,
538 extern void lprocfs_free_obd_stats(struct obd_device *obd);
539 extern void lprocfs_free_md_stats(struct obd_device *obd);
542 extern int lprocfs_add_clear_entry(struct obd_device *obd,
543 struct proc_dir_entry *entry);
544 #ifdef HAVE_SERVER_SUPPORT
545 extern int lprocfs_exp_setup(struct obd_export *exp, lnet_nid_t *peer_nid);
546 extern int lprocfs_exp_cleanup(struct obd_export *exp);
547 struct dentry *ldebugfs_add_symlink(const char *name, const char *target,
548 const char *format, ...);
550 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
553 extern struct proc_dir_entry *
554 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
555 void *data, const struct proc_ops *ops);
556 extern struct proc_dir_entry *
557 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
558 const char *format, ...);
559 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
560 #ifdef HAVE_SERVER_SUPPORT
562 lprocfs_nid_stats_clear_seq_write(struct file *file, const char __user *buffer,
563 size_t count, loff_t *off);
564 extern int lprocfs_nid_stats_clear_seq_show(struct seq_file *file, void *data);
566 extern int lprocfs_register_stats(struct proc_dir_entry *root, const char *name,
567 struct lprocfs_stats *stats);
568 extern const struct file_operations ldebugfs_stats_seq_fops;
570 /* lprocfs_status.c */
571 extern void ldebugfs_add_vars(struct dentry *parent, struct ldebugfs_vars *var,
573 extern struct dentry *ldebugfs_register(const char *name,
574 struct dentry *parent,
575 struct ldebugfs_vars *list,
577 extern int lprocfs_add_vars(struct proc_dir_entry *root,
578 struct lprocfs_vars *var, void *data);
580 extern struct proc_dir_entry *
581 lprocfs_register(const char *name, struct proc_dir_entry *parent,
582 struct lprocfs_vars *list, void *data);
584 extern void lprocfs_remove(struct proc_dir_entry **root);
585 extern void lprocfs_remove_proc_entry(const char *name,
586 struct proc_dir_entry *parent);
587 extern int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only);
588 extern int lprocfs_obd_cleanup(struct obd_device *obd);
590 extern int lprocfs_seq_create(struct proc_dir_entry *parent, const char *name,
591 mode_t mode, const struct proc_ops *seq_fops,
593 extern int lprocfs_obd_seq_create(struct obd_device *obd, const char *name,
594 mode_t mode, const struct proc_ops *seq_fops,
596 extern void lprocfs_stats_header(struct seq_file *seq, ktime_t now,
597 ktime_t ts_init, int width, const char *colon,
600 /* Generic callbacks */
601 extern int lprocfs_uuid_seq_show(struct seq_file *m, void *data);
602 extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
603 ssize_t conn_uuid_show(struct kobject *kobj, struct attribute *attr, char *buf);
604 extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
605 extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
606 extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
607 #ifdef HAVE_SERVER_SUPPORT
608 ssize_t num_exports_show(struct kobject *kobj, struct attribute *attr,
610 ssize_t grant_check_threshold_show(struct kobject *kobj,
611 struct attribute *attr, char *buf);
612 ssize_t grant_check_threshold_store(struct kobject *kobj,
613 struct attribute *attr,
614 const char *buffer, size_t count);
616 struct adaptive_timeout;
617 extern int lprocfs_at_hist_helper(struct seq_file *m,
618 struct adaptive_timeout *at);
619 extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
621 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
622 size_t count, loff_t *off);
623 #ifdef HAVE_SERVER_SUPPORT
625 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
626 size_t count, loff_t *off);
628 ssize_t ping_store(struct kobject *kobj, struct attribute *attr,
629 const char *buffer, size_t count);
630 ssize_t ping_show(struct kobject *kobj, struct attribute *attr,
634 ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
635 size_t count, loff_t *off);
636 static inline ssize_t
637 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
638 size_t count, loff_t *off)
640 return ldebugfs_import_seq_write(file, buffer, count, off);
643 extern int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data);
645 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
646 size_t count, loff_t *off);
648 int string_to_size(u64 *size, const char *buffer, size_t count);
649 int sysfs_memparse(const char *buffer, size_t count, u64 *val,
650 const char *defunit);
651 char *lprocfs_strnstr(const char *s1, const char *s2, size_t len);
652 char *lprocfs_find_named_value(const char *buffer, const char *name,
654 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
655 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
656 void lprocfs_oh_clear(struct obd_histogram *oh);
657 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
659 void lprocfs_oh_tally_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
660 void lprocfs_oh_tally_log2_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
661 int lprocfs_oh_alloc_pcpu(struct obd_hist_pcpu *oh);
662 void lprocfs_oh_clear_pcpu(struct obd_hist_pcpu *oh);
663 void lprocfs_oh_release_pcpu(struct obd_hist_pcpu *oh);
664 unsigned long lprocfs_oh_sum_pcpu(struct obd_hist_pcpu *oh);
665 unsigned long lprocfs_oh_counter_pcpu(struct obd_hist_pcpu *oh,
668 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
669 struct lprocfs_counter *cnt);
671 #ifdef HAVE_SERVER_SUPPORT
672 /* lprocfs_status.c: recovery status */
673 int lprocfs_recovery_status_seq_show(struct seq_file *m, void *data);
675 /* lprocfs_status.c: hash statistics */
676 int lprocfs_hash_seq_show(struct seq_file *m, void *data);
678 /* lprocfs_status.c: IR factor */
679 ssize_t ir_factor_show(struct kobject *kobj, struct attribute *attr,
681 ssize_t ir_factor_store(struct kobject *kobj, struct attribute *attr,
682 const char *buffer, size_t count);
685 /* lprocfs_status.c: dump pages on cksum error */
686 int lprocfs_checksum_dump_seq_show(struct seq_file *m, void *data);
688 lprocfs_checksum_dump_seq_write(struct file *file, const char __user *buffer,
689 size_t count, loff_t *off);
691 extern int lprocfs_single_release(struct inode *, struct file *);
692 extern int lprocfs_seq_release(struct inode *, struct file *);
694 /* You must use these macros when you want to refer to
695 * the import in a client obd_device for a lprocfs entry
696 * Note that it is not safe to 'goto', 'return' or 'break'
697 * out of the body of this statement. It *IS* safe to
698 * 'goto' the a label inside the statement, or to 'continue'
699 * to get out of the statement.
702 #define with_imp_locked_nested(__obd, __imp, __rc, __nest) \
703 for (down_read_nested(&(__obd)->u.cli.cl_sem, __nest), \
704 __imp = (__obd)->u.cli.cl_import, \
705 __rc = __imp ? 0 : -ENODEV; \
706 __imp ? 1 : (up_read(&(__obd)->u.cli.cl_sem), 0); \
709 #define with_imp_locked(__obd, __imp, __rc) \
710 with_imp_locked_nested(__obd, __imp, __rc, 0)
712 /* write the name##_seq_show function, call LDEBUGFS_SEQ_FOPS_RO for read-only
713 * debugfs entries; otherwise, you will define name##_seq_write function also
714 * for a read-write debugfs entry, and then call LDEBUGFS_SEQ_FOPS instead.
715 * Finally, call debugfs_create_file(filename, 0444, obd, data, &name#_fops);
717 #define __LDEBUGFS_SEQ_FOPS(name, custom_seq_write) \
718 static int name##_single_open(struct inode *inode, struct file *file) \
720 return single_open(file, name##_seq_show, inode->i_private); \
722 static const struct file_operations name##_fops = { \
723 .owner = THIS_MODULE, \
724 .open = name##_single_open, \
726 .write = custom_seq_write, \
727 .llseek = seq_lseek, \
728 .release = single_release, \
731 #define LDEBUGFS_SEQ_FOPS_RO(name) __LDEBUGFS_SEQ_FOPS(name, NULL)
732 #define LDEBUGFS_SEQ_FOPS(name) __LDEBUGFS_SEQ_FOPS(name, \
735 #define LDEBUGFS_SEQ_FOPS_RO_TYPE(name, type) \
736 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
740 return lprocfs_##type##_seq_show(m, m->private); \
742 LDEBUGFS_SEQ_FOPS_RO(name##_##type)
744 #define LDEBUGFS_SEQ_FOPS_RW_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 static ssize_t name##_##type##_seq_write(struct file *file, \
752 const char __user *buffer, size_t count, \
755 struct seq_file *seq = file->private_data; \
759 return ldebugfs_##type##_seq_write(file, buffer, count, \
762 LDEBUGFS_SEQ_FOPS(name##_##type);
764 #define LDEBUGFS_FOPS_WR_ONLY(name, type) \
765 static ssize_t name##_##type##_write(struct file *file, \
766 const char __user *buffer, size_t count, \
769 return ldebugfs_##type##_seq_write(file, buffer, count, \
772 static int name##_##type##_open(struct inode *inode, \
775 return single_open(file, NULL, inode->i_private); \
777 static const struct file_operations name##_##type##_fops = { \
778 .open = name##_##type##_open, \
779 .write = name##_##type##_write, \
780 .release = single_release, \
783 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
784 * proc entries; otherwise, you will define name##_seq_write function also for
785 * a read-write proc entry, and then call LPROC_SEQ_FOPS instead. Finally,
786 * call ldebugfs_obd_seq_create(obd, filename, 0444, &name#_fops, data);
788 #define __LPROC_SEQ_FOPS(name, custom_seq_write) \
789 static int name##_single_open(struct inode *inode, struct file *file) \
791 return single_open(file, name##_seq_show, \
792 inode->i_private ? inode->i_private : \
795 static const struct proc_ops name##_fops = { \
796 PROC_OWNER(THIS_MODULE) \
797 .proc_open = name##_single_open, \
798 .proc_read = seq_read, \
799 .proc_write = custom_seq_write, \
800 .proc_lseek = seq_lseek, \
801 .proc_release = lprocfs_single_release, \
804 #define LPROC_SEQ_FOPS_RO(name) __LPROC_SEQ_FOPS(name, NULL)
805 #define LPROC_SEQ_FOPS(name) __LPROC_SEQ_FOPS(name, name##_seq_write)
807 #define LPROC_SEQ_FOPS_RO_TYPE(name, type) \
808 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
810 return lprocfs_##type##_seq_show(m, m->private); \
812 LPROC_SEQ_FOPS_RO(name##_##type)
814 #define LPROC_SEQ_FOPS_RW_TYPE(name, type) \
815 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
817 return lprocfs_##type##_seq_show(m, m->private); \
819 static ssize_t name##_##type##_seq_write(struct file *file, \
820 const char __user *buffer, size_t count, \
823 struct seq_file *seq = file->private_data; \
824 return lprocfs_##type##_seq_write(file, buffer, \
825 count, seq->private); \
827 LPROC_SEQ_FOPS(name##_##type);
829 #define LPROC_SEQ_FOPS_WR_ONLY(name, type) \
830 static ssize_t name##_##type##_write(struct file *file, \
831 const char __user *buffer, size_t count, \
834 return lprocfs_##type##_seq_write(file, buffer, count, off);\
836 static int name##_##type##_open(struct inode *inode, struct file *file)\
838 return single_open(file, NULL, \
839 inode->i_private ? inode->i_private : \
842 static const struct proc_ops name##_##type##_fops = { \
843 .proc_open = name##_##type##_open, \
844 .proc_write = name##_##type##_write, \
845 .proc_release = lprocfs_single_release, \
849 struct attribute attr;
850 ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
852 ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
853 const char *buf, size_t len);
856 #define LUSTRE_ATTR(name, mode, show, store) \
857 static struct lustre_attr lustre_attr_##name = __ATTR(name, mode, show, store)
859 #define LUSTRE_WO_ATTR(name) LUSTRE_ATTR(name, 0200, NULL, name##_store)
860 #define LUSTRE_RO_ATTR(name) LUSTRE_ATTR(name, 0444, name##_show, NULL)
861 #define LUSTRE_RW_ATTR(name) LUSTRE_ATTR(name, 0644, name##_show, name##_store)
863 ssize_t lustre_attr_show(struct kobject *kobj, struct attribute *attr,
865 ssize_t lustre_attr_store(struct kobject *kobj, struct attribute *attr,
866 const char *buf, size_t len);
868 extern const struct sysfs_ops lustre_sysfs_ops;
871 struct ptlrpc_request;
872 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
874 #ifdef HAVE_SERVER_SUPPORT
875 /* lprocfs_jobstats.c */
876 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
877 int event, long amount);
878 void lprocfs_job_stats_fini(struct obd_device *obd);
879 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
880 cntr_init_callback fn);
881 ssize_t job_cleanup_interval_show(struct kobject *kobj, struct attribute *attr,
883 ssize_t job_cleanup_interval_store(struct kobject *kobj,
884 struct attribute *attr,
885 const char *buffer, size_t count);
886 /* lproc_status_server.c */
887 ssize_t recovery_time_soft_show(struct kobject *kobj, struct attribute *attr,
889 ssize_t recovery_time_soft_store(struct kobject *kobj,
890 struct attribute *attr,
891 const char *buffer, size_t count);
892 ssize_t recovery_time_hard_show(struct kobject *kobj, struct attribute *attr,
894 ssize_t recovery_time_hard_store(struct kobject *kobj,
895 struct attribute *attr,
896 const char *buffer, size_t count);
897 ssize_t instance_show(struct kobject *kobj, struct attribute *attr,
901 int lprocfs_obd_max_pages_per_rpc_seq_show(struct seq_file *m, void *data);
902 ssize_t lprocfs_obd_max_pages_per_rpc_seq_write(struct file *file,
903 const char __user *buffer,
904 size_t count, loff_t *off);
905 ssize_t short_io_bytes_show(struct kobject *kobj, struct attribute *attr,
907 ssize_t short_io_bytes_store(struct kobject *kobj, struct attribute *attr,
908 const char *buffer, size_t count);
910 struct root_squash_info;
911 int lprocfs_wr_root_squash(const char __user *buffer, unsigned long count,
912 struct root_squash_info *squash, char *name);
913 int lprocfs_wr_nosquash_nids(const char __user *buffer, unsigned long count,
914 struct root_squash_info *squash, char *name);
916 #else /* !CONFIG_PROC_FS */
918 #define proc_lustre_root NULL
920 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
921 int index, long amount)
923 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
926 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
927 int index, long amount)
929 static inline void lprocfs_counter_decr(struct lprocfs_stats *stats,
932 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
933 int index, unsigned conf,
934 const char *name, const char *units)
937 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
938 enum lprocfs_fields_flags field)
941 /* NB: we return !NULL to satisfy error checker */
942 static inline struct lprocfs_stats *
943 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags)
944 { return (struct lprocfs_stats *)1; }
945 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
947 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
949 static inline int lprocfs_register_stats(struct proc_dir_entry *root,
951 struct lprocfs_stats *stats)
953 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
955 static inline int lprocfs_alloc_obd_stats(struct obd_device *obd,
956 unsigned int num_stats)
958 static inline int lprocfs_alloc_md_stats(struct obd_device *obd,
959 unsigned int num_private_stats)
961 static inline void lprocfs_free_obd_stats(struct obd_device *obd)
963 static inline void lprocfs_free_md_stats(struct obd_device *obd)
967 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
969 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
971 #ifdef HAVE_SERVER_SUPPORT
973 ssize_t lprocfs_nid_stats_seq_write(struct file *file,
974 const char __user *buffer,
975 size_t count, loff_t *off)
978 int lprocfs_nid_stats_clear_seq_show(struct seq_file *m, void *data)
980 static inline int lprocfs_exp_setup(struct obd_export *exp,lnet_nid_t *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 */