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.
132 LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
133 LPROCFS_CNTR_AVGMINMAX = 0x0002,
134 LPROCFS_CNTR_STDDEV = 0x0004,
136 /* counter data type */
137 LPROCFS_TYPE_REQS = 0x0100,
138 LPROCFS_TYPE_BYTES = 0x0200,
139 LPROCFS_TYPE_PAGES = 0x0400,
140 LPROCFS_TYPE_USEC = 0x0800,
142 LPROCFS_TYPE_LATENCY = LPROCFS_TYPE_USEC |
143 LPROCFS_CNTR_AVGMINMAX |
145 LPROCFS_TYPE_BYTES_FULL = LPROCFS_TYPE_BYTES |
146 LPROCFS_CNTR_AVGMINMAX |
149 #define LC_MIN_INIT ((~(__u64)0) >> 1)
151 struct lprocfs_counter_header {
152 unsigned int lc_config;
153 const char *lc_name; /* must be static */
154 const char *lc_units; /* must be static */
157 struct lprocfs_counter {
163 * Every counter has lc_array_sum[0], while lc_array_sum[1] is only
164 * for irq context counter, i.e. stats with
165 * LPROCFS_STATS_FLAG_IRQ_SAFE flag, its counter need
168 __s64 lc_array_sum[1];
170 #define lc_sum lc_array_sum[0]
171 #define lc_sum_irq lc_array_sum[1]
173 struct lprocfs_percpu {
174 struct lprocfs_counter lp_cntr[0];
177 enum lprocfs_stats_lock_ops {
178 LPROCFS_GET_NUM_CPU = 0x0001, /* number allocated per-CPU stats */
179 LPROCFS_GET_SMP_ID = 0x0002, /* current stat to be updated */
182 enum lprocfs_stats_flags {
183 LPROCFS_STATS_FLAG_NONE = 0x0000, /* per cpu counter */
184 LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
185 * area and need locking */
186 LPROCFS_STATS_FLAG_IRQ_SAFE = 0x0002, /* alloc need irq safe */
189 enum lprocfs_fields_flags {
190 LPROCFS_FIELDS_FLAGS_CONFIG = 0x0001,
191 LPROCFS_FIELDS_FLAGS_SUM = 0x0002,
192 LPROCFS_FIELDS_FLAGS_MIN = 0x0003,
193 LPROCFS_FIELDS_FLAGS_MAX = 0x0004,
194 LPROCFS_FIELDS_FLAGS_AVG = 0x0005,
195 LPROCFS_FIELDS_FLAGS_SUMSQUARE = 0x0006,
196 LPROCFS_FIELDS_FLAGS_COUNT = 0x0007,
199 struct lprocfs_stats {
201 unsigned short ls_num;
202 /* 1 + the biggest cpu # whose ls_percpu slot has been allocated */
203 unsigned short ls_biggest_alloc_num;
204 enum lprocfs_stats_flags ls_flags;
206 /* Lock used when there are no percpu stats areas; For percpu stats,
207 * it is used to protect ls_biggest_alloc_num change */
210 /* has ls_num of counter headers */
211 struct lprocfs_counter_header *ls_cnt_header;
212 struct lprocfs_percpu *ls_percpu[0];
215 #define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
217 /* Pack all opcodes down into a single monotonically increasing index */
218 static inline int opcode_offset(__u32 opc) {
219 if (opc < OST_LAST_OPC) {
221 return (opc - OST_FIRST_OPC);
222 } else if (opc < MDS_LAST_OPC) {
224 return (opc - MDS_FIRST_OPC +
226 } else if (opc < LDLM_LAST_OPC) {
228 return (opc - LDLM_FIRST_OPC +
231 } else if (opc < MGS_LAST_OPC) {
233 return (opc - MGS_FIRST_OPC +
237 } else if (opc < OBD_LAST_OPC) {
239 return (opc - OBD_FIRST_OPC +
244 } else if (opc < LLOG_LAST_OPC) {
246 return (opc - LLOG_FIRST_OPC +
252 } else if (opc < QUOTA_LAST_OPC) {
254 return (opc - QUOTA_FIRST_OPC +
261 } else if (opc < SEQ_LAST_OPC) {
263 return (opc - SEQ_FIRST_OPC +
271 } else if (opc < SEC_LAST_OPC) {
273 return (opc - SEC_FIRST_OPC +
282 } else if (opc < FLD_LAST_OPC) {
284 return (opc - FLD_FIRST_OPC +
294 #ifdef HAVE_SERVER_SUPPORT
295 } else if (opc < OUT_UPDATE_LAST_OPC) {
297 return (opc - OUT_UPDATE_FIRST_OPC +
308 } else if (opc < LFSCK_LAST_OPC) {
310 return (opc - LFSCK_FIRST_OPC +
311 OPC_RANGE(OUT_UPDATE) +
322 #endif /* HAVE_SERVER_SUPPORT */
329 #define LUSTRE_MAX_OPCODES_CLIENT (OPC_RANGE(OST) + \
340 #ifdef HAVE_SERVER_SUPPORT
341 #define LUSTRE_MAX_OPCODES (LUSTRE_MAX_OPCODES_CLIENT + \
342 OPC_RANGE(OUT_UPDATE) + \
345 #define LUSTRE_MAX_OPCODES LUSTRE_MAX_OPCODES_CLIENT
348 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR) + \
352 PTLRPC_REQWAIT_CNTR = 0,
353 PTLRPC_REQQDEPTH_CNTR,
354 PTLRPC_REQACTIVE_CNTR,
356 PTLRPC_REQBUF_AVAIL_CNTR,
360 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
362 enum lprocfs_extra_opc {
363 LDLM_GLIMPSE_ENQUEUE = 0,
381 #ifdef HAVE_SERVER_SUPPORT
387 BRW_R_DISCONT_BLOCKS,
388 BRW_W_DISCONT_BLOCKS,
400 struct brw_stats_props {
401 const char *bsp_name;
402 const char *bsp_units;
408 struct obd_hist_pcpu bs_hist[BRW_RW_STATS_NUM];
409 struct brw_stats_props bs_props[BRW_RW_STATS_NUM / 2];
412 int lprocfs_init_brw_stats(struct brw_stats *brw_stats);
413 void lprocfs_fini_brw_stats(struct brw_stats *brw_stats);
415 void ldebugfs_register_osd_stats(struct dentry *parent,
416 struct brw_stats *brw_stats,
417 struct lprocfs_stats *stats);
418 #endif /* HAVE_SERVER_SUPPORT */
420 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
422 extern struct proc_dir_entry *proc_lustre_root;
423 extern struct dentry *debugfs_lustre_root;
424 extern struct kset *lustre_kset;
428 #define JOBSTATS_JOBID_VAR_MAX_LEN 20
429 #define JOBSTATS_DISABLE "disable"
430 #define JOBSTATS_PROCNAME_UID "procname_uid"
431 #define JOBSTATS_NODELOCAL "nodelocal"
432 #define JOBSTATS_SESSION "session"
434 typedef void (*cntr_init_callback)(struct lprocfs_stats *stats,
435 unsigned int offset);
437 struct obd_job_stats {
438 struct cfs_hash *ojs_hash; /* hash of jobids */
439 struct list_head ojs_list; /* list of job_stat structs */
440 rwlock_t ojs_lock; /* protect ojs_list/js_list */
441 ktime_t ojs_cleanup_interval;/* 1/2 expiry seconds */
442 ktime_t ojs_cleanup_last;/* previous cleanup time */
443 cntr_init_callback ojs_cntr_init_fn;/* lprocfs_stats initializer */
444 unsigned short ojs_cntr_num; /* number of stats in struct */
445 bool ojs_cleaning; /* currently expiring stats */
448 #ifdef CONFIG_PROC_FS
450 int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
452 int lprocfs_stats_lock(struct lprocfs_stats *stats,
453 enum lprocfs_stats_lock_ops opc,
454 unsigned long *flags);
455 void lprocfs_stats_unlock(struct lprocfs_stats *stats,
456 enum lprocfs_stats_lock_ops opc,
457 unsigned long *flags);
459 static inline unsigned int
460 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
462 unsigned int percpusize;
464 percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
466 /* irq safe stats need lc_array_sum[1] */
467 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
468 percpusize += stats->ls_num * sizeof(__s64);
470 if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
471 percpusize = L1_CACHE_ALIGN(percpusize);
476 static inline struct lprocfs_counter *
477 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
480 struct lprocfs_counter *cntr;
482 cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
484 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
485 cntr = (void *)cntr + index * sizeof(__s64);
490 /* Two optimized LPROCFS counter increment functions are provided:
491 * lprocfs_counter_incr(cntr, value) - optimized for by-one counters
492 * lprocfs_counter_add(cntr) - use for multi-valued counters
493 * Counter data layout allows config flag, counter lock and the
494 * count itself to reside within a single cache line.
497 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
499 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
502 #define lprocfs_counter_incr(stats, idx) \
503 lprocfs_counter_add(stats, idx, 1)
504 #define lprocfs_counter_decr(stats, idx) \
505 lprocfs_counter_sub(stats, idx, 1)
507 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
508 struct lprocfs_counter_header *header,
509 enum lprocfs_stats_flags flags,
510 enum lprocfs_fields_flags field);
511 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
512 enum lprocfs_fields_flags field);
514 extern struct lprocfs_stats *
515 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags);
516 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
517 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
518 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
519 extern int lprocfs_alloc_obd_stats(struct obd_device *obd,
520 unsigned int num_stats);
521 extern int lprocfs_alloc_md_stats(struct obd_device *obd,
522 unsigned int num_private_stats);
523 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
524 unsigned conf, const char *name,
526 extern void lprocfs_free_obd_stats(struct obd_device *obd);
527 extern void lprocfs_free_md_stats(struct obd_device *obd);
530 extern int lprocfs_add_clear_entry(struct obd_device *obd,
531 struct proc_dir_entry *entry);
532 #ifdef HAVE_SERVER_SUPPORT
533 extern int lprocfs_exp_setup(struct obd_export *exp, lnet_nid_t *peer_nid);
534 extern int lprocfs_exp_cleanup(struct obd_export *exp);
535 struct dentry *ldebugfs_add_symlink(const char *name, const char *target,
536 const char *format, ...);
538 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
541 extern struct proc_dir_entry *
542 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
543 void *data, const struct proc_ops *ops);
544 extern struct proc_dir_entry *
545 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
546 const char *format, ...);
547 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
548 #ifdef HAVE_SERVER_SUPPORT
550 lprocfs_nid_stats_clear_seq_write(struct file *file, const char __user *buffer,
551 size_t count, loff_t *off);
552 extern int lprocfs_nid_stats_clear_seq_show(struct seq_file *file, void *data);
554 extern int lprocfs_register_stats(struct proc_dir_entry *root, const char *name,
555 struct lprocfs_stats *stats);
556 extern const struct file_operations ldebugfs_stats_seq_fops;
558 /* lprocfs_status.c */
559 extern void ldebugfs_add_vars(struct dentry *parent, struct ldebugfs_vars *var,
561 extern struct dentry *ldebugfs_register(const char *name,
562 struct dentry *parent,
563 struct ldebugfs_vars *list,
565 extern int lprocfs_add_vars(struct proc_dir_entry *root,
566 struct lprocfs_vars *var, void *data);
568 extern struct proc_dir_entry *
569 lprocfs_register(const char *name, struct proc_dir_entry *parent,
570 struct lprocfs_vars *list, void *data);
572 extern void lprocfs_remove(struct proc_dir_entry **root);
573 extern void lprocfs_remove_proc_entry(const char *name,
574 struct proc_dir_entry *parent);
575 extern int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only);
576 extern int lprocfs_obd_cleanup(struct obd_device *obd);
578 extern int lprocfs_seq_create(struct proc_dir_entry *parent, const char *name,
579 mode_t mode, const struct proc_ops *seq_fops,
581 extern int lprocfs_obd_seq_create(struct obd_device *obd, const char *name,
582 mode_t mode, const struct proc_ops *seq_fops,
584 extern void lprocfs_stats_header(struct seq_file *seq, ktime_t now,
585 ktime_t ts_init, int width, const char *colon,
588 /* Generic callbacks */
589 extern int lprocfs_uuid_seq_show(struct seq_file *m, void *data);
590 extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
591 ssize_t conn_uuid_show(struct kobject *kobj, struct attribute *attr, char *buf);
592 extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
593 extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
594 extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
595 #ifdef HAVE_SERVER_SUPPORT
596 ssize_t num_exports_show(struct kobject *kobj, struct attribute *attr,
598 ssize_t grant_check_threshold_show(struct kobject *kobj,
599 struct attribute *attr, char *buf);
600 ssize_t grant_check_threshold_store(struct kobject *kobj,
601 struct attribute *attr,
602 const char *buffer, size_t count);
604 struct adaptive_timeout;
605 extern int lprocfs_at_hist_helper(struct seq_file *m,
606 struct adaptive_timeout *at);
607 extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
609 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
610 size_t count, loff_t *off);
611 #ifdef HAVE_SERVER_SUPPORT
613 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
614 size_t count, loff_t *off);
616 ssize_t ping_store(struct kobject *kobj, struct attribute *attr,
617 const char *buffer, size_t count);
618 ssize_t ping_show(struct kobject *kobj, struct attribute *attr,
622 ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
623 size_t count, loff_t *off);
624 static inline ssize_t
625 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
626 size_t count, loff_t *off)
628 return ldebugfs_import_seq_write(file, buffer, count, off);
631 extern int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data);
633 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
634 size_t count, loff_t *off);
636 int string_to_size(u64 *size, const char *buffer, size_t count);
637 int sysfs_memparse(const char *buffer, size_t count, u64 *val,
638 const char *defunit);
639 char *lprocfs_strnstr(const char *s1, const char *s2, size_t len);
640 char *lprocfs_find_named_value(const char *buffer, const char *name,
642 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
643 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
644 void lprocfs_oh_clear(struct obd_histogram *oh);
645 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
647 void lprocfs_oh_tally_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
648 void lprocfs_oh_tally_log2_pcpu(struct obd_hist_pcpu *oh, unsigned int value);
649 int lprocfs_oh_alloc_pcpu(struct obd_hist_pcpu *oh);
650 void lprocfs_oh_clear_pcpu(struct obd_hist_pcpu *oh);
651 void lprocfs_oh_release_pcpu(struct obd_hist_pcpu *oh);
652 unsigned long lprocfs_oh_sum_pcpu(struct obd_hist_pcpu *oh);
653 unsigned long lprocfs_oh_counter_pcpu(struct obd_hist_pcpu *oh,
656 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
657 struct lprocfs_counter *cnt);
659 #ifdef HAVE_SERVER_SUPPORT
660 /* lprocfs_status.c: recovery status */
661 int lprocfs_recovery_status_seq_show(struct seq_file *m, void *data);
663 /* lprocfs_status.c: hash statistics */
664 int lprocfs_hash_seq_show(struct seq_file *m, void *data);
666 /* lprocfs_status.c: IR factor */
667 ssize_t ir_factor_show(struct kobject *kobj, struct attribute *attr,
669 ssize_t ir_factor_store(struct kobject *kobj, struct attribute *attr,
670 const char *buffer, size_t count);
673 /* lprocfs_status.c: dump pages on cksum error */
674 int lprocfs_checksum_dump_seq_show(struct seq_file *m, void *data);
676 lprocfs_checksum_dump_seq_write(struct file *file, const char __user *buffer,
677 size_t count, loff_t *off);
679 extern int lprocfs_single_release(struct inode *, struct file *);
680 extern int lprocfs_seq_release(struct inode *, struct file *);
682 /* You must use these macros when you want to refer to
683 * the import in a client obd_device for a lprocfs entry
684 * Note that it is not safe to 'goto', 'return' or 'break'
685 * out of the body of this statement. It *IS* safe to
686 * 'goto' the a label inside the statement, or to 'continue'
687 * to get out of the statement.
690 #define with_imp_locked_nested(__obd, __imp, __rc, __nest) \
691 for (down_read_nested(&(__obd)->u.cli.cl_sem, __nest), \
692 __imp = (__obd)->u.cli.cl_import, \
693 __rc = __imp ? 0 : -ENODEV; \
694 __imp ? 1 : (up_read(&(__obd)->u.cli.cl_sem), 0); \
697 #define with_imp_locked(__obd, __imp, __rc) \
698 with_imp_locked_nested(__obd, __imp, __rc, 0)
700 /* write the name##_seq_show function, call LDEBUGFS_SEQ_FOPS_RO for read-only
701 * debugfs entries; otherwise, you will define name##_seq_write function also
702 * for a read-write debugfs entry, and then call LDEBUGFS_SEQ_FOPS instead.
703 * Finally, call debugfs_create_file(filename, 0444, obd, data, &name#_fops);
705 #define __LDEBUGFS_SEQ_FOPS(name, custom_seq_write) \
706 static int name##_single_open(struct inode *inode, struct file *file) \
708 return single_open(file, name##_seq_show, inode->i_private); \
710 static const struct file_operations name##_fops = { \
711 .owner = THIS_MODULE, \
712 .open = name##_single_open, \
714 .write = custom_seq_write, \
715 .llseek = seq_lseek, \
716 .release = single_release, \
719 #define LDEBUGFS_SEQ_FOPS_RO(name) __LDEBUGFS_SEQ_FOPS(name, NULL)
720 #define LDEBUGFS_SEQ_FOPS(name) __LDEBUGFS_SEQ_FOPS(name, \
723 #define LDEBUGFS_SEQ_FOPS_RO_TYPE(name, type) \
724 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
728 return lprocfs_##type##_seq_show(m, m->private); \
730 LDEBUGFS_SEQ_FOPS_RO(name##_##type)
732 #define LDEBUGFS_SEQ_FOPS_RW_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 static ssize_t name##_##type##_seq_write(struct file *file, \
740 const char __user *buffer, size_t count, \
743 struct seq_file *seq = file->private_data; \
747 return ldebugfs_##type##_seq_write(file, buffer, count, \
750 LDEBUGFS_SEQ_FOPS(name##_##type);
752 #define LDEBUGFS_FOPS_WR_ONLY(name, type) \
753 static ssize_t name##_##type##_write(struct file *file, \
754 const char __user *buffer, size_t count, \
757 return ldebugfs_##type##_seq_write(file, buffer, count, \
760 static int name##_##type##_open(struct inode *inode, \
763 return single_open(file, NULL, inode->i_private); \
765 static const struct file_operations name##_##type##_fops = { \
766 .open = name##_##type##_open, \
767 .write = name##_##type##_write, \
768 .release = single_release, \
771 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
772 * proc entries; otherwise, you will define name##_seq_write function also for
773 * a read-write proc entry, and then call LPROC_SEQ_FOPS instead. Finally,
774 * call ldebugfs_obd_seq_create(obd, filename, 0444, &name#_fops, data);
776 #define __LPROC_SEQ_FOPS(name, custom_seq_write) \
777 static int name##_single_open(struct inode *inode, struct file *file) \
779 return single_open(file, name##_seq_show, \
780 inode->i_private ? inode->i_private : \
783 static const struct proc_ops name##_fops = { \
784 PROC_OWNER(THIS_MODULE) \
785 .proc_open = name##_single_open, \
786 .proc_read = seq_read, \
787 .proc_write = custom_seq_write, \
788 .proc_lseek = seq_lseek, \
789 .proc_release = lprocfs_single_release, \
792 #define LPROC_SEQ_FOPS_RO(name) __LPROC_SEQ_FOPS(name, NULL)
793 #define LPROC_SEQ_FOPS(name) __LPROC_SEQ_FOPS(name, name##_seq_write)
795 #define LPROC_SEQ_FOPS_RO_TYPE(name, type) \
796 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
798 return lprocfs_##type##_seq_show(m, m->private); \
800 LPROC_SEQ_FOPS_RO(name##_##type)
802 #define LPROC_SEQ_FOPS_RW_TYPE(name, type) \
803 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
805 return lprocfs_##type##_seq_show(m, m->private); \
807 static ssize_t name##_##type##_seq_write(struct file *file, \
808 const char __user *buffer, size_t count, \
811 struct seq_file *seq = file->private_data; \
812 return lprocfs_##type##_seq_write(file, buffer, \
813 count, seq->private); \
815 LPROC_SEQ_FOPS(name##_##type);
817 #define LPROC_SEQ_FOPS_WR_ONLY(name, type) \
818 static ssize_t name##_##type##_write(struct file *file, \
819 const char __user *buffer, size_t count, \
822 return lprocfs_##type##_seq_write(file, buffer, count, off);\
824 static int name##_##type##_open(struct inode *inode, struct file *file)\
826 return single_open(file, NULL, \
827 inode->i_private ? inode->i_private : \
830 static const struct proc_ops name##_##type##_fops = { \
831 .proc_open = name##_##type##_open, \
832 .proc_write = name##_##type##_write, \
833 .proc_release = lprocfs_single_release, \
837 struct attribute attr;
838 ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
840 ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
841 const char *buf, size_t len);
844 #define LUSTRE_ATTR(name, mode, show, store) \
845 static struct lustre_attr lustre_attr_##name = __ATTR(name, mode, show, store)
847 #define LUSTRE_WO_ATTR(name) LUSTRE_ATTR(name, 0200, NULL, name##_store)
848 #define LUSTRE_RO_ATTR(name) LUSTRE_ATTR(name, 0444, name##_show, NULL)
849 #define LUSTRE_RW_ATTR(name) LUSTRE_ATTR(name, 0644, name##_show, name##_store)
851 ssize_t lustre_attr_show(struct kobject *kobj, struct attribute *attr,
853 ssize_t lustre_attr_store(struct kobject *kobj, struct attribute *attr,
854 const char *buf, size_t len);
856 extern const struct sysfs_ops lustre_sysfs_ops;
859 struct ptlrpc_request;
860 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
862 #ifdef HAVE_SERVER_SUPPORT
863 /* lprocfs_jobstats.c */
864 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
865 int event, long amount);
866 void lprocfs_job_stats_fini(struct obd_device *obd);
867 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
868 cntr_init_callback fn);
869 ssize_t job_cleanup_interval_show(struct kobject *kobj, struct attribute *attr,
871 ssize_t job_cleanup_interval_store(struct kobject *kobj,
872 struct attribute *attr,
873 const char *buffer, size_t count);
874 /* lproc_status_server.c */
875 ssize_t recovery_time_soft_show(struct kobject *kobj, struct attribute *attr,
877 ssize_t recovery_time_soft_store(struct kobject *kobj,
878 struct attribute *attr,
879 const char *buffer, size_t count);
880 ssize_t recovery_time_hard_show(struct kobject *kobj, struct attribute *attr,
882 ssize_t recovery_time_hard_store(struct kobject *kobj,
883 struct attribute *attr,
884 const char *buffer, size_t count);
885 ssize_t instance_show(struct kobject *kobj, struct attribute *attr,
889 int lprocfs_obd_max_pages_per_rpc_seq_show(struct seq_file *m, void *data);
890 ssize_t lprocfs_obd_max_pages_per_rpc_seq_write(struct file *file,
891 const char __user *buffer,
892 size_t count, loff_t *off);
893 ssize_t short_io_bytes_show(struct kobject *kobj, struct attribute *attr,
895 ssize_t short_io_bytes_store(struct kobject *kobj, struct attribute *attr,
896 const char *buffer, size_t count);
898 struct root_squash_info;
899 int lprocfs_wr_root_squash(const char __user *buffer, unsigned long count,
900 struct root_squash_info *squash, char *name);
901 int lprocfs_wr_nosquash_nids(const char __user *buffer, unsigned long count,
902 struct root_squash_info *squash, char *name);
904 #else /* !CONFIG_PROC_FS */
906 #define proc_lustre_root NULL
908 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
909 int index, long amount)
911 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
914 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
915 int index, long amount)
917 static inline void lprocfs_counter_decr(struct lprocfs_stats *stats,
920 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
921 int index, unsigned conf,
922 const char *name, const char *units)
925 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
926 enum lprocfs_fields_flags field)
929 /* NB: we return !NULL to satisfy error checker */
930 static inline struct lprocfs_stats *
931 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags)
932 { return (struct lprocfs_stats *)1; }
933 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
935 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
937 static inline int lprocfs_register_stats(struct proc_dir_entry *root,
939 struct lprocfs_stats *stats)
941 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
943 static inline int lprocfs_alloc_obd_stats(struct obd_device *obd,
944 unsigned int num_stats)
946 static inline int lprocfs_alloc_md_stats(struct obd_device *obd,
947 unsigned int num_private_stats)
949 static inline void lprocfs_free_obd_stats(struct obd_device *obd)
951 static inline void lprocfs_free_md_stats(struct obd_device *obd)
955 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
957 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
959 #ifdef HAVE_SERVER_SUPPORT
961 ssize_t lprocfs_nid_stats_seq_write(struct file *file,
962 const char __user *buffer,
963 size_t count, loff_t *off)
966 int lprocfs_nid_stats_clear_seq_show(struct seq_file *m, void *data)
968 static inline int lprocfs_exp_setup(struct obd_export *exp,lnet_nid_t *peer_nid)
971 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
973 static inline struct proc_dir_entry *
974 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
975 void *data, const struct file_operations *fops)
977 static inline struct proc_dir_entry *
978 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
979 const char *format, ...)
981 static inline int lprocfs_add_vars(struct proc_dir_entry *root,
982 struct lprocfs_vars *var, void *data)
984 static inline struct proc_dir_entry *
985 lprocfs_register(const char *name, struct proc_dir_entry *parent,
986 struct lprocfs_vars *list, void *data)
988 static inline void lprocfs_remove(struct proc_dir_entry **root)
990 static inline void lprocfs_remove_proc_entry(const char *name,
991 struct proc_dir_entry *parent)
993 static inline int lprocfs_obd_setup(struct obd_device *obd, bool uuid_only)
995 static inline int lprocfs_obd_cleanup(struct obd_device *obd)
997 static inline int lprocfs_uuid_seq_show(struct seq_file *m, void *data)
999 static inline int lprocfs_server_seq_show(struct seq_file *m, void *data)
1001 static inline int lprocfs_import_seq_show(struct seq_file *m, void *data)
1003 static inline int lprocfs_state_seq_show(struct seq_file *m, void *data)
1005 static inline int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data)
1007 #ifdef HAVE_SERVER_SUPPORT
1008 static inline int lprocfs_num_exports_seq_show(struct seq_file *m, void *data)
1011 struct adaptive_timeout;
1012 static inline int lprocfs_at_hist_helper(struct seq_file *m,
1013 struct adaptive_timeout *at)
1015 static inline int lprocfs_timeouts_seq_show(struct seq_file *m, void *data)
1017 static inline ssize_t
1018 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
1019 size_t count, loff_t *off)
1021 #ifdef HAVE_SERVER_SUPPORT
1022 static inline ssize_t
1023 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
1024 size_t count, loff_t *off)
1027 static inline ssize_t
1028 lprocfs_ping_seq_write(struct file *file, const char __user *buffer,
1029 size_t count, loff_t *off)
1031 static inline ssize_t
1032 ldebugfs_import_seq_write(struct file *file, const char __user *buffer,
1033 size_t count, loff_t *off)
1035 static inline ssize_t
1036 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
1037 size_t count, loff_t *off)
1040 lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data)
1042 static inline ssize_t
1043 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
1044 size_t count, loff_t *off)
1047 /* Statfs helpers */
1049 int lprocfs_blksize_seq_show(struct seq_file *m, void *data)
1052 int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data)
1055 int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data)
1058 int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data)
1061 int lprocfs_filestotal_seq_show(struct seq_file *m, void *data)
1064 int lprocfs_filesfree_seq_show(struct seq_file *m, void *data)
1067 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value)
1070 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value)
1073 void lprocfs_oh_clear(struct obd_histogram *oh)
1076 unsigned long lprocfs_oh_sum(struct obd_histogram *oh)
1079 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
1080 struct lprocfs_counter *cnt)
1083 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
1084 enum lprocfs_fields_flags field)
1085 { return (__u64)0; }
1087 #define LPROC_SEQ_FOPS_RO(name)
1088 #define LPROC_SEQ_FOPS(name)
1089 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)
1090 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)
1091 #define LPROC_SEQ_FOPS_WR_ONLY(name, type)
1093 /* lprocfs_jobstats.c */
1095 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid, int event,
1099 void lprocfs_job_stats_fini(struct obd_device *obd)
1102 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
1103 cntr_init_callback fn)
1107 /* lproc_ptlrpc.c */
1108 #define target_print_req NULL
1110 #endif /* CONFIG_PROC_FS */
1112 #endif /* LPROCFS_STATUS_H */