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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lprocfs_status.h
38 * Top level header file for LProc SNMP
40 * Author: Hariharan Thantry thantry@users.sourceforge.net
42 #ifndef _LPROCFS_SNMP_H
43 #define _LPROCFS_SNMP_H
45 #if defined(__linux__)
46 #include <linux/lprocfs_status.h>
47 #elif defined(__APPLE__)
48 #include <darwin/lprocfs_status.h>
49 #elif defined(__WINNT__)
50 #include <winnt/lprocfs_status.h>
52 #error Unsupported operating system.
54 #include <lustre/lustre_idl.h>
55 #include <libcfs/params_tree.h>
57 #ifndef HAVE_ONLY_PROCFS_SEQ
60 read_proc_t *read_fptr;
61 write_proc_t *write_fptr;
63 const struct file_operations *fops;
70 struct lprocfs_static_vars {
71 struct lprocfs_vars *module_vars;
72 struct lprocfs_vars *obd_vars;
77 struct lprocfs_seq_vars {
79 const struct file_operations *fops;
87 /* if we find more consumers this could be generalized */
88 #define OBD_HIST_MAX 32
89 struct obd_histogram {
91 unsigned long oh_buckets[OBD_HIST_MAX];
103 BRW_R_DISCONT_BLOCKS,
104 BRW_W_DISCONT_BLOCKS,
113 struct obd_histogram hist[BRW_LAST];
117 RENAME_SAMEDIR_SIZE = 0,
118 RENAME_CROSSDIR_SRC_SIZE,
119 RENAME_CROSSDIR_TGT_SIZE,
123 struct rename_stats {
124 struct obd_histogram hist[RENAME_LAST];
127 /* An lprocfs counter can be configured using the enum bit masks below.
129 * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
130 * protects this counter from concurrent updates. If not specified,
131 * lprocfs an internal per-counter lock variable. External locks are
132 * not used to protect counter increments, but are used to protect
133 * counter readout and resets.
135 * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
136 * (i.e. counter can be incremented by more than "1"). When specified,
137 * the counter maintains min, max and sum in addition to a simple
138 * invocation count. This allows averages to be be computed.
139 * If not specified, the counter is an increment-by-1 counter.
140 * min, max, sum, etc. are not maintained.
142 * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
143 * squares (for multi-valued counter samples only). This allows
144 * external computation of standard deviation, but involves a 64-bit
145 * multiply per counter increment.
149 LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
150 LPROCFS_CNTR_AVGMINMAX = 0x0002,
151 LPROCFS_CNTR_STDDEV = 0x0004,
153 /* counter data type */
154 LPROCFS_TYPE_REGS = 0x0100,
155 LPROCFS_TYPE_BYTES = 0x0200,
156 LPROCFS_TYPE_PAGES = 0x0400,
157 LPROCFS_TYPE_CYCLE = 0x0800,
160 #define LC_MIN_INIT ((~(__u64)0) >> 1)
162 struct lprocfs_counter_header {
163 unsigned int lc_config;
164 const char *lc_name; /* must be static */
165 const char *lc_units; /* must be static */
168 struct lprocfs_counter {
174 * Every counter has lc_array_sum[0], while lc_array_sum[1] is only
175 * for irq context counter, i.e. stats with
176 * LPROCFS_STATS_FLAG_IRQ_SAFE flag, its counter need
179 __s64 lc_array_sum[1];
181 #define lc_sum lc_array_sum[0]
182 #define lc_sum_irq lc_array_sum[1]
184 struct lprocfs_percpu {
188 struct lprocfs_counter lp_cntr[0];
191 #define LPROCFS_GET_NUM_CPU 0x0001
192 #define LPROCFS_GET_SMP_ID 0x0002
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;
217 /* Lock used when there are no percpu stats areas; For percpu stats,
218 * it is used to protect ls_biggest_alloc_num change */
221 /* has ls_num of counter headers */
222 struct lprocfs_counter_header *ls_cnt_header;
223 struct lprocfs_percpu *ls_percpu[0];
226 #define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
228 /* Pack all opcodes down into a single monotonically increasing index */
229 static inline int opcode_offset(__u32 opc) {
230 if (opc < OST_LAST_OPC) {
232 return (opc - OST_FIRST_OPC);
233 } else if (opc < MDS_LAST_OPC) {
235 return (opc - MDS_FIRST_OPC +
237 } else if (opc < LDLM_LAST_OPC) {
239 return (opc - LDLM_FIRST_OPC +
242 } else if (opc < MGS_LAST_OPC) {
244 return (opc - MGS_FIRST_OPC +
248 } else if (opc < OBD_LAST_OPC) {
250 return (opc - OBD_FIRST_OPC +
255 } else if (opc < LLOG_LAST_OPC) {
257 return (opc - LLOG_FIRST_OPC +
263 } else if (opc < QUOTA_LAST_OPC) {
265 return (opc - QUOTA_FIRST_OPC +
272 } else if (opc < SEQ_LAST_OPC) {
274 return (opc - SEQ_FIRST_OPC +
282 } else if (opc < SEC_LAST_OPC) {
284 return (opc - SEC_FIRST_OPC +
293 } else if (opc < FLD_LAST_OPC) {
295 return (opc - FLD_FIRST_OPC +
305 } else if (opc < UPDATE_LAST_OPC) {
307 return (opc - UPDATE_FIRST_OPC +
325 #define LUSTRE_MAX_OPCODES (OPC_RANGE(OST) + \
337 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR) + \
341 PTLRPC_REQWAIT_CNTR = 0,
342 PTLRPC_REQQDEPTH_CNTR,
343 PTLRPC_REQACTIVE_CNTR,
345 PTLRPC_REQBUF_AVAIL_CNTR,
349 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
352 LDLM_GLIMPSE_ENQUEUE = 0,
369 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
371 extern cfs_proc_dir_entry_t *proc_lustre_root;
374 struct obd_histogram;
376 /* Days / hours / mins / seconds format */
380 static inline void s2dhms(struct dhms *ts, time_t secs)
382 ts->d = secs / 86400;
389 #define DHMS_FMT "%dd%dh%02dm%02ds"
390 #define DHMS_VARS(x) (x)->d, (x)->h, (x)->m, (x)->s
392 #define JOBSTATS_JOBID_VAR_MAX_LEN 20
393 #define JOBSTATS_DISABLE "disable"
394 #define JOBSTATS_PROCNAME_UID "procname_uid"
396 typedef void (*cntr_init_callback)(struct lprocfs_stats *stats);
398 struct obd_job_stats {
399 cfs_hash_t *ojs_hash;
401 rwlock_t ojs_lock; /* protect the obj_list */
402 cntr_init_callback ojs_cntr_init_fn;
404 int ojs_cleanup_interval;
405 time_t ojs_last_cleanup;
410 extern int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
414 * < 0 : on error (only possible for opc as LPROCFS_GET_SMP_ID)
416 static inline int lprocfs_stats_lock(struct lprocfs_stats *stats, int opc,
417 unsigned long *flags)
425 case LPROCFS_GET_SMP_ID:
426 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
427 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE)
428 spin_lock_irqsave(&stats->ls_lock, *flags);
430 spin_lock(&stats->ls_lock);
433 unsigned int cpuid = get_cpu();
435 if (unlikely(stats->ls_percpu[cpuid] == NULL)) {
436 rc = lprocfs_stats_alloc_one(stats, cpuid);
445 case LPROCFS_GET_NUM_CPU:
446 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
447 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE)
448 spin_lock_irqsave(&stats->ls_lock, *flags);
450 spin_lock(&stats->ls_lock);
453 return stats->ls_biggest_alloc_num;
458 static inline void lprocfs_stats_unlock(struct lprocfs_stats *stats, int opc,
459 unsigned long *flags)
465 case LPROCFS_GET_SMP_ID:
466 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
467 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) {
468 spin_unlock_irqrestore(&stats->ls_lock,
471 spin_unlock(&stats->ls_lock);
478 case LPROCFS_GET_NUM_CPU:
479 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
480 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) {
481 spin_unlock_irqrestore(&stats->ls_lock,
484 spin_unlock(&stats->ls_lock);
491 static inline unsigned int
492 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
494 unsigned int percpusize;
496 percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
498 /* irq safe stats need lc_array_sum[1] */
499 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
500 percpusize += stats->ls_num * sizeof(__s64);
502 if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
503 percpusize = L1_CACHE_ALIGN(percpusize);
508 static inline struct lprocfs_counter *
509 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
512 struct lprocfs_counter *cntr;
514 cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
516 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
517 cntr = (void *)cntr + index * sizeof(__s64);
522 /* Two optimized LPROCFS counter increment functions are provided:
523 * lprocfs_counter_incr(cntr, value) - optimized for by-one counters
524 * lprocfs_counter_add(cntr) - use for multi-valued counters
525 * Counter data layout allows config flag, counter lock and the
526 * count itself to reside within a single cache line.
529 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
531 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
534 #define lprocfs_counter_incr(stats, idx) \
535 lprocfs_counter_add(stats, idx, 1)
536 #define lprocfs_counter_decr(stats, idx) \
537 lprocfs_counter_sub(stats, idx, 1)
539 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
540 struct lprocfs_counter_header *header,
541 enum lprocfs_stats_flags flags,
542 enum lprocfs_fields_flags field);
543 static inline __u64 lprocfs_stats_collector(struct lprocfs_stats *stats,
545 enum lprocfs_fields_flags field)
548 unsigned int num_cpu;
549 unsigned long flags = 0;
552 LASSERT(stats != NULL);
554 num_cpu = lprocfs_stats_lock(stats, LPROCFS_GET_NUM_CPU, &flags);
555 for (i = 0; i < num_cpu; i++) {
556 if (stats->ls_percpu[i] == NULL)
558 ret += lprocfs_read_helper(
559 lprocfs_stats_counter_get(stats, i, idx),
560 &stats->ls_cnt_header[idx], stats->ls_flags,
563 lprocfs_stats_unlock(stats, LPROCFS_GET_NUM_CPU, &flags);
567 extern struct lprocfs_stats *
568 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags);
569 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
570 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
571 extern void lprocfs_init_ops_stats(int num_private_stats,
572 struct lprocfs_stats *stats);
573 extern void lprocfs_init_mps_stats(int num_private_stats,
574 struct lprocfs_stats *stats);
575 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
576 extern int lprocfs_alloc_obd_stats(struct obd_device *obddev,
577 unsigned int num_private_stats);
578 extern int lprocfs_alloc_md_stats(struct obd_device *obddev,
579 unsigned int num_private_stats);
580 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
581 unsigned conf, const char *name,
583 extern void lprocfs_free_obd_stats(struct obd_device *obddev);
584 extern void lprocfs_free_md_stats(struct obd_device *obddev);
587 extern int lprocfs_add_clear_entry(struct obd_device * obd,
588 cfs_proc_dir_entry_t *entry);
589 #ifdef HAVE_SERVER_SUPPORT
590 extern int lprocfs_exp_setup(struct obd_export *exp,
591 lnet_nid_t *peer_nid, int *newnid);
593 extern int lprocfs_exp_cleanup(struct obd_export *exp);
594 extern cfs_proc_dir_entry_t *lprocfs_add_simple(struct proc_dir_entry *root,
596 #ifndef HAVE_ONLY_PROCFS_SEQ
597 read_proc_t *read_proc,
598 write_proc_t *write_proc,
601 struct file_operations *fops);
602 extern struct proc_dir_entry *
603 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
604 const char *format, ...);
605 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
607 lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
608 unsigned long count, void *data);
609 extern int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
610 int count, int *eof, void *data);
612 extern int lprocfs_register_stats(cfs_proc_dir_entry_t *root, const char *name,
613 struct lprocfs_stats *stats);
615 /* lprocfs_status.c */
616 #ifndef HAVE_ONLY_PROCFS_SEQ
617 extern int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
618 struct lprocfs_vars *var,
621 extern cfs_proc_dir_entry_t *lprocfs_register(const char *name,
622 cfs_proc_dir_entry_t *parent,
623 struct lprocfs_vars *list,
626 extern int lprocfs_seq_add_vars(cfs_proc_dir_entry_t *root,
627 struct lprocfs_seq_vars *var,
630 extern cfs_proc_dir_entry_t *
631 lprocfs_seq_register(const char *name, cfs_proc_dir_entry_t *parent,
632 struct lprocfs_seq_vars *list, void *data);
633 extern void lprocfs_remove(cfs_proc_dir_entry_t **root);
634 extern void lprocfs_remove_proc_entry(const char *name,
635 struct proc_dir_entry *parent);
636 #ifndef HAVE_ONLY_PROCFS_SEQ
637 extern void lprocfs_try_remove_proc_entry(const char *name,
638 struct proc_dir_entry *parent);
640 extern cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *root,
642 extern int lprocfs_obd_setup(struct obd_device *obd, struct lprocfs_vars *list);
644 extern int lprocfs_seq_obd_setup(struct obd_device *dev);
645 extern int lprocfs_obd_cleanup(struct obd_device *obd);
646 #ifdef HAVE_SERVER_SUPPORT
647 extern struct file_operations lprocfs_evict_client_fops;
649 extern int lprocfs_seq_create(cfs_proc_dir_entry_t *parent, const char *name,
651 const struct file_operations *seq_fops,
653 extern int lprocfs_obd_seq_create(struct obd_device *dev, const char *name,
655 const struct file_operations *seq_fops,
658 /* Generic callbacks */
659 #ifndef HAVE_ONLY_PROCFS_SEQ
660 extern int lprocfs_rd_u64(char *page, char **start, off_t off,
661 int count, int *eof, void *data);
662 extern int lprocfs_rd_atomic(char *page, char **start, off_t off,
663 int count, int *eof, void *data);
664 extern int lprocfs_wr_atomic(struct file *file, const char *buffer,
665 unsigned long count, void *data);
666 extern int lprocfs_rd_uint(char *page, char **start, off_t off,
667 int count, int *eof, void *data);
668 extern int lprocfs_rd_uuid(char *page, char **start, off_t off,
669 int count, int *eof, void *data);
670 extern int lprocfs_rd_name(char *page, char **start, off_t off,
671 int count, int *eof, void *data);
672 extern int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
673 int count, int *eof, void *data);
674 extern int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
675 int count, int *eof, void *data);
676 extern int lprocfs_rd_import(char *page, char **start, off_t off, int count,
677 int *eof, void *data);
678 extern int lprocfs_rd_state(char *page, char **start, off_t off, int count,
679 int *eof, void *data);
680 extern int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
681 int count, int *eof, void *data);
682 extern int lprocfs_rd_num_exports(char *page, char **start, off_t off,
683 int count, int *eof, void *data);
684 extern int lprocfs_rd_numrefs(char *page, char **start, off_t off,
685 int count, int *eof, void *data);
687 extern int lprocfs_u64_seq_show(struct seq_file *m, void *data);
688 extern int lprocfs_atomic_seq_show(struct seq_file *m, void *data);
689 extern ssize_t lprocfs_atomic_seq_write(struct file *file, const char *buffer,
690 size_t count, loff_t *off);
691 extern int lprocfs_uint_seq_show(struct seq_file *m, void *data);
692 extern ssize_t lprocfs_uint_seq_write(struct file *file, const char *buffer,
693 size_t count, loff_t *off);
694 extern int lprocfs_wr_uint(struct file *file, const char *buffer,
695 unsigned long count, void *data);
696 extern int lprocfs_uuid_seq_show(struct seq_file *m, void *data);
697 extern int lprocfs_name_seq_show(struct seq_file *m, void *data);
698 extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
699 extern int lprocfs_conn_uuid_seq_show(struct seq_file *m, void *data);
700 extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
701 extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
702 extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
703 struct adaptive_timeout;
704 #ifndef HAVE_ONLY_PROCFS_SEQ
705 extern int lprocfs_at_hist_helper(char *page, int count, int rc,
706 struct adaptive_timeout *at);
707 extern int lprocfs_rd_timeouts(char *page, char **start, off_t off,
708 int count, int *eof, void *data);
709 extern int lprocfs_wr_timeouts(struct file *file, const char *buffer,
710 unsigned long count, void *data);
712 extern int lprocfs_seq_at_hist_helper(struct seq_file *m,
713 struct adaptive_timeout *at);
714 extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
716 lprocfs_timeouts_seq_write(struct file *file, const char *buffer,
717 size_t count, loff_t *off);
718 extern int lprocfs_wr_evict_client(struct file *file, const char *buffer,
719 unsigned long count, void *data);
720 #ifndef HAVE_ONLY_PROCFS_SEQ
721 extern int lprocfs_wr_ping(struct file *file, const char *buffer,
722 unsigned long count, void *data);
723 extern int lprocfs_wr_import(struct file *file, const char *buffer,
724 unsigned long count, void *data);
725 extern int lprocfs_rd_pinger_recov(char *page, char **start, off_t off,
726 int count, int *eof, void *data);
727 extern int lprocfs_wr_pinger_recov(struct file *file, const char *buffer,
728 unsigned long count, void *data);
731 lprocfs_ping_seq_write(struct file *file, const char *buffer,
732 size_t count, loff_t *off);
734 lprocfs_import_seq_write(struct file *file, const char *buffer,
735 size_t count, loff_t *off);
736 extern int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data);
738 lprocfs_pinger_recov_seq_write(struct file *file, const char *buffer,
739 size_t count, loff_t *off);
742 #ifndef HAVE_ONLY_PROCFS_SEQ
743 extern int lprocfs_rd_blksize(char *page, char **start, off_t off,
744 int count, int *eof, void *data);
745 extern int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
746 int count, int *eof, void *data);
747 extern int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
748 int count, int *eof, void *data);
749 extern int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
750 int count, int *eof, void *data);
751 extern int lprocfs_rd_filestotal(char *page, char **start, off_t off,
752 int count, int *eof, void *data);
753 extern int lprocfs_rd_filesfree(char *page, char **start, off_t off,
754 int count, int *eof, void *data);
755 extern int lprocfs_rd_filegroups(char *page, char **start, off_t off,
756 int count, int *eof, void *data);
758 extern int lprocfs_blksize_seq_show(struct seq_file *m, void *data);
759 extern int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data);
760 extern int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data);
761 extern int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data);
762 extern int lprocfs_filestotal_seq_show(struct seq_file *m, void *data);
763 extern int lprocfs_filesfree_seq_show(struct seq_file *m, void *data);
765 extern int lprocfs_write_helper(const char *buffer, unsigned long count,
767 extern int lprocfs_write_frac_helper(const char *buffer, unsigned long count,
769 extern int lprocfs_seq_read_frac_helper(struct seq_file *m, long val, int mult);
770 extern int lprocfs_read_frac_helper(char *buffer, unsigned long count,
772 extern int lprocfs_write_u64_helper(const char *buffer, unsigned long count,
774 extern int lprocfs_write_frac_u64_helper(const char *buffer,
776 __u64 *val, int mult);
777 char *lprocfs_find_named_value(const char *buffer, const char *name,
779 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
780 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
781 void lprocfs_oh_clear(struct obd_histogram *oh);
782 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
784 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
785 struct lprocfs_counter *cnt);
787 #ifdef HAVE_SERVER_SUPPORT
788 /* lprocfs_status.c: recovery status */
789 int lprocfs_obd_rd_recovery_status(char *page, char **start, off_t off,
790 int count, int *eof, void *data);
792 /* lprocfs_statuc.c: hash statistics */
793 int lprocfs_obd_rd_hash(char *page, char **start, off_t off,
794 int count, int *eof, void *data);
796 /* lprocfs_status.c: IR factor */
797 int lprocfs_obd_rd_ir_factor(char *page, char **start, off_t off,
798 int count, int *eof, void *data);
799 int lprocfs_obd_wr_ir_factor(struct file *file, const char *buffer,
800 unsigned long count, void *data);
802 extern int lprocfs_single_release(cfs_inode_t *, struct file *);
803 extern int lprocfs_seq_release(cfs_inode_t *, struct file *);
805 /* You must use these macros when you want to refer to
806 * the import in a client obd_device for a lprocfs entry */
807 #define LPROCFS_CLIMP_CHECK(obd) do { \
808 typecheck(struct obd_device *, obd); \
809 down_read(&(obd)->u.cli.cl_sem); \
810 if ((obd)->u.cli.cl_import == NULL) { \
811 up_read(&(obd)->u.cli.cl_sem); \
815 #define LPROCFS_CLIMP_EXIT(obd) \
816 up_read(&(obd)->u.cli.cl_sem);
818 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
819 proc entries; otherwise, you will define name##_seq_write function also for
820 a read-write proc entry, and then call LPROC_SEQ_SEQ instead. Finally,
821 call lprocfs_obd_seq_create(obd, filename, 0444, &name#_fops, data); */
822 #define __LPROC_SEQ_FOPS(name, custom_seq_write) \
823 static int name##_single_open(cfs_inode_t *inode, struct file *file) \
825 LPROCFS_ENTRY_CHECK(PDE(inode)); \
826 return single_open(file, name##_seq_show, PDE_DATA(inode)); \
828 struct file_operations name##_fops = { \
829 .owner = THIS_MODULE, \
830 .open = name##_single_open, \
832 .write = custom_seq_write, \
833 .llseek = seq_lseek, \
834 .release = lprocfs_single_release, \
837 #define LPROC_SEQ_FOPS_RO(name) __LPROC_SEQ_FOPS(name, NULL)
838 #define LPROC_SEQ_FOPS(name) __LPROC_SEQ_FOPS(name, name##_seq_write)
840 #define LPROC_SEQ_FOPS_RO_TYPE(name, type) \
841 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
843 return lprocfs_##type##_seq_show(m, m->private); \
845 LPROC_SEQ_FOPS_RO(name##_##type)
847 #define LPROC_SEQ_FOPS_RW_TYPE(name, type) \
848 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
850 return lprocfs_##type##_seq_show(m, m->private); \
852 static ssize_t name##_##type##_seq_write(struct file *file, \
853 const char *buffer, size_t count, loff_t *off) \
855 struct seq_file *seq = file->private_data; \
856 return lprocfs_##type##_seq_write(file, buffer, \
857 count, seq->private); \
859 LPROC_SEQ_FOPS(name##_##type);
861 #define LPROC_SEQ_FOPS_WO_TYPE(name, type) \
862 static ssize_t name##_##type##_write(struct file *file, \
863 const char *buffer, size_t count, loff_t *off) \
865 return lprocfs_##type##_seq_write(file, buffer, count, off); \
867 static int name##_##type##_open(cfs_inode_t *inode, struct file *file) \
869 return single_open(file, NULL, PDE_DATA(inode)); \
871 struct file_operations name##_##type##_fops = { \
872 .open = name##_##type##_open, \
873 .write = name##_##type##_write, \
874 .release = lprocfs_single_release, \
877 /* lprocfs_jobstats.c */
878 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
879 int event, long amount);
880 void lprocfs_job_stats_fini(struct obd_device *obd);
881 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
882 cntr_init_callback fn);
883 int lprocfs_rd_job_interval(char *page, char **start, off_t off,
884 int count, int *eof, void *data);
885 int lprocfs_wr_job_interval(struct file *file, const char *buffer,
886 unsigned long count, void *data);
889 struct ptlrpc_request;
890 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
893 int lprocfs_obd_rd_recovery_time_soft(char *page, char **start, off_t off,
894 int count, int *eof, void *data);
895 int lprocfs_obd_wr_recovery_time_soft(struct file *file,
897 unsigned long count, void *data);
898 int lprocfs_obd_rd_recovery_time_hard(char *page, char **start, off_t off,
899 int count, int *eof, void *data);
900 int lprocfs_obd_wr_recovery_time_hard(struct file *file,
902 unsigned long count, void *data);
903 #ifndef HAVE_ONLY_PROCFS_SEQ
904 int lprocfs_obd_rd_max_pages_per_rpc(char *page, char **start, off_t off,
905 int count, int *eof, void *data);
906 int lprocfs_obd_wr_max_pages_per_rpc(struct file *file, const char *buffer,
907 unsigned long count, void *data);
909 int lprocfs_obd_max_pages_per_rpc_seq_show(struct seq_file *m, void *data);
911 lprocfs_obd_max_pages_per_rpc_seq_write(struct file *file, const char *buffer,
912 size_t count, loff_t *off);
913 int lprocfs_target_rd_instance(char *page, char **start, off_t off,
914 int count, int *eof, void *data);
916 /* all quota proc functions */
917 extern int lprocfs_quota_rd_bunit(char *page, char **start,
918 off_t off, int count,
919 int *eof, void *data);
920 extern int lprocfs_quota_wr_bunit(struct file *file, const char *buffer,
921 unsigned long count, void *data);
922 extern int lprocfs_quota_rd_btune(char *page, char **start,
923 off_t off, int count,
924 int *eof, void *data);
925 extern int lprocfs_quota_wr_btune(struct file *file, const char *buffer,
926 unsigned long count, void *data);
927 extern int lprocfs_quota_rd_iunit(char *page, char **start,
928 off_t off, int count,
929 int *eof, void *data);
930 extern int lprocfs_quota_wr_iunit(struct file *file, const char *buffer,
931 unsigned long count, void *data);
932 extern int lprocfs_quota_rd_itune(char *page, char **start,
933 off_t off, int count,
934 int *eof, void *data);
935 extern int lprocfs_quota_wr_itune(struct file *file, const char *buffer,
936 unsigned long count, void *data);
937 extern int lprocfs_quota_rd_type(char *page, char **start, off_t off, int count,
938 int *eof, void *data);
939 extern int lprocfs_quota_wr_type(struct file *file, const char *buffer,
940 unsigned long count, void *data);
941 extern int lprocfs_quota_rd_switch_seconds(char *page, char **start, off_t off,
942 int count, int *eof, void *data);
943 extern int lprocfs_quota_wr_switch_seconds(struct file *file,
945 unsigned long count, void *data);
946 extern int lprocfs_quota_rd_sync_blk(char *page, char **start, off_t off,
947 int count, int *eof, void *data);
948 extern int lprocfs_quota_wr_sync_blk(struct file *file, const char *buffer,
949 unsigned long count, void *data);
950 extern int lprocfs_quota_rd_switch_qs(char *page, char **start, off_t off,
951 int count, int *eof, void *data);
952 extern int lprocfs_quota_wr_switch_qs(struct file *file,
954 unsigned long count, void *data);
955 extern int lprocfs_quota_rd_boundary_factor(char *page, char **start, off_t off,
956 int count, int *eof, void *data);
957 extern int lprocfs_quota_wr_boundary_factor(struct file *file,
959 unsigned long count, void *data);
960 extern int lprocfs_quota_rd_least_bunit(char *page, char **start, off_t off,
961 int count, int *eof, void *data);
962 extern int lprocfs_quota_wr_least_bunit(struct file *file,
964 unsigned long count, void *data);
965 extern int lprocfs_quota_rd_least_iunit(char *page, char **start, off_t off,
966 int count, int *eof, void *data);
967 extern int lprocfs_quota_wr_least_iunit(struct file *file,
969 unsigned long count, void *data);
970 extern int lprocfs_quota_rd_qs_factor(char *page, char **start, off_t off,
971 int count, int *eof, void *data);
972 extern int lprocfs_quota_wr_qs_factor(struct file *file,
974 unsigned long count, void *data);
976 /* LPROCFS is not defined */
978 #define proc_lustre_root NULL
980 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
981 int index, long amount)
983 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
986 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
987 int index, long amount)
989 static inline void lprocfs_counter_decr(struct lprocfs_stats *stats,
992 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
993 int index, unsigned conf,
994 const char *name, const char *units)
997 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
998 enum lprocfs_fields_flags field)
1001 /* NB: we return !NULL to satisfy error checker */
1002 static inline struct lprocfs_stats *
1003 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags)
1004 { return (struct lprocfs_stats *)1; }
1005 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
1007 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
1009 static inline int lprocfs_register_stats(cfs_proc_dir_entry_t *root,
1011 struct lprocfs_stats *stats)
1013 static inline void lprocfs_init_ops_stats(int num_private_stats,
1014 struct lprocfs_stats *stats)
1016 static inline void lprocfs_init_mps_stats(int num_private_stats,
1017 struct lprocfs_stats *stats)
1019 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
1021 static inline int lprocfs_alloc_obd_stats(struct obd_device *obddev,
1022 unsigned int num_private_stats)
1024 static inline int lprocfs_alloc_md_stats(struct obd_device *obddev,
1025 unsigned int num_private_stats)
1027 static inline void lprocfs_free_obd_stats(struct obd_device *obddev)
1029 static inline void lprocfs_free_md_stats(struct obd_device *obddev)
1033 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
1035 #ifdef HAVE_SERVER_SUPPORT
1036 static inline int lprocfs_exp_setup(struct obd_export *exp,lnet_nid_t *peer_nid,
1040 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
1042 static inline cfs_proc_dir_entry_t *
1043 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
1044 #ifndef HAVE_ONLY_PROCFS_SEQ
1045 read_proc_t *read_proc, write_proc_t *write_proc,
1047 void *data, struct file_operations *fops)
1049 static inline struct proc_dir_entry *
1050 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
1051 const char *format, ...)
1053 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
1056 int lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
1057 unsigned long count, void *data)
1060 int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
1061 int count, int *eof, void *data)
1064 #ifndef HAVE_ONLY_PROCFS_SEQ
1065 static inline cfs_proc_dir_entry_t *
1066 lprocfs_register(const char *name, cfs_proc_dir_entry_t *parent,
1067 struct lprocfs_vars *list, void *data)
1069 static inline int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
1070 struct lprocfs_vars *var,
1074 static inline int lprocfs_seq_add_vars(cfs_proc_dir_entry_t *root,
1075 struct lprocfs_seq_vars *var,
1078 #ifndef HAVE_ONLY_PROCFS_SEQ
1079 static inline cfs_proc_dir_entry_t *
1080 lprocfs_seq_register(const char *name, cfs_proc_dir_entry_t *parent,
1081 struct lprocfs_vars *list, void *data)
1084 static inline void lprocfs_remove(cfs_proc_dir_entry_t **root)
1086 static inline void lprocfs_remove_proc_entry(const char *name,
1087 struct proc_dir_entry *parent)
1089 #ifndef HAVE_ONLY_PROCFS_SEQ
1090 static inline void lprocfs_try_remove_proc_entry(const char *name,
1091 struct proc_dir_entry *parent)
1093 static inline cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *head,
1096 static inline int lprocfs_obd_setup(struct obd_device *dev,
1097 struct lprocfs_vars *list)
1100 static inline int lprocfs_seq_obd_setup(struct obd_device *dev)
1102 static inline int lprocfs_obd_cleanup(struct obd_device *dev)
1104 static inline int lprocfs_rd_u64(char *page, char **start, off_t off,
1105 int count, int *eof, void *data)
1107 #ifndef HAVE_ONLY_PROCFS_SEQ
1108 static inline int lprocfs_rd_uuid(char *page, char **start, off_t off,
1109 int count, int *eof, void *data)
1111 static inline int lprocfs_rd_name(char *page, char **start, off_t off,
1112 int count, int *eof, void *data)
1114 static inline int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
1115 int count, int *eof, void *data)
1117 static inline int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
1118 int count, int *eof, void *data)
1120 static inline int lprocfs_rd_import(char *page, char **start, off_t off,
1121 int count, int *eof, void *data)
1123 static inline int lprocfs_rd_pinger_recov(char *page, char **start, off_t off,
1124 int count, int *eof, void *data)
1126 static inline int lprocfs_rd_state(char *page, char **start, off_t off,
1127 int count, int *eof, void *data)
1129 static inline int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
1130 int count, int *eof, void *data)
1132 static inline int lprocfs_rd_num_exports(char *page, char **start, off_t off,
1133 int count, int *eof, void *data)
1135 static inline int lprocfs_rd_numrefs(struct seq_file *m, void *data)
1137 struct adaptive_timeout;
1138 static inline int lprocfs_at_hist_helper(char *page, int count, int rc,
1139 struct adaptive_timeout *at)
1141 static inline int lprocfs_rd_timeouts(char *page, char **start, off_t off,
1142 int count, int *eof, void *data)
1144 static inline int lprocfs_wr_timeouts(struct file *file,
1146 unsigned long count, void *data)
1148 static inline int lprocfs_wr_evict_client(struct file *file,
1150 unsigned long count, void *data)
1152 static inline int lprocfs_wr_ping(struct file *file, const char *buffer,
1153 unsigned long count, void *data)
1155 static inline int lprocfs_wr_import(struct file *file, const char *buffer,
1156 unsigned long count, void *data)
1158 static inline int lprocfs_wr_pinger_recov(struct file *file, const char *buffer,
1159 unsigned long count, void *data)
1162 static inline int lprocfs_uuid_seq_show(struct seq_file *m, void *data)
1164 static inline int lprocfs_name_seq_show(struct seq_file *m, void *data)
1166 static inline int lprocfs_server_seq_show(struct seq_file *m, void *data)
1168 static inline int lprocfs_conn_uuid_seq_show(struct seq_file *m, void *data)
1170 static inline int lprocfs_import_seq_show(struct seq_file *m, void *data)
1172 static inline int lprocfs_state_seq_show(struct seq_file *m, void *data)
1174 static inline int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data)
1176 static inline int lprocfs_num_exports_seq_show(struct seq_file *m, void *data)
1178 struct adaptive_timeout;
1179 static inline int lprocfs_seq_at_hist_helper(struct seq_file *m,
1180 struct adaptive_timeout *at)
1182 static inline int lprocfs_timeouts_seq_show(struct seq_file *m, void *data)
1184 static inline ssize_t
1185 lprocfs_timeouts_seq_write(struct file *file, const char *buffer,
1186 size_t count, loff_t *off)
1188 static inline ssize_t
1189 lprocfs_evict_client_seq_write(struct file *file, const char *buffer,
1190 size_t count, loff_t *off)
1192 static inline ssize_t
1193 lprocfs_ping_seq_write(struct file *file, const char *buffer,
1194 size_t count, loff_t *off)
1196 static inline ssize_t
1197 lprocfs_import_seq_write(struct file *file, const char *buffer,
1198 size_t count, loff_t *off)
1201 lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data)
1203 static inline ssize_t
1204 lprocfs_pinger_recov_seq_write(struct file *file, const char *buffer,
1205 size_t count, loff_t *off)
1208 /* Statfs helpers */
1209 #ifndef HAVE_ONLY_PROCFS_SEQ
1211 int lprocfs_rd_blksize(char *page, char **start, off_t off,
1212 int count, int *eof, void *data)
1215 int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
1216 int count, int *eof, void *data)
1219 int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
1220 int count, int *eof, void *data)
1223 int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
1224 int count, int *eof, void *data)
1227 int lprocfs_rd_filestotal(char *page, char **start, off_t off,
1228 int count, int *eof, void *data)
1231 int lprocfs_rd_filesfree(char *page, char **start, off_t off,
1232 int count, int *eof, void *data)
1236 int lprocfs_blksize_seq_show(struct seq_file *m, void *data)
1239 int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data)
1242 int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data)
1245 int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data)
1248 int lprocfs_filestotal_seq_show(struct seq_file *m, void *data)
1251 int lprocfs_filesfree_seq_show(struct seq_file *m, void *data)
1254 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value)
1257 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value)
1260 void lprocfs_oh_clear(struct obd_histogram *oh)
1263 unsigned long lprocfs_oh_sum(struct obd_histogram *oh)
1266 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
1267 struct lprocfs_counter *cnt)
1270 __u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
1271 enum lprocfs_fields_flags field)
1272 { return (__u64)0; }
1274 #define LPROC_SEQ_FOPS_RO(name)
1275 #define LPROC_SEQ_FOPS(name)
1276 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)
1277 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)
1278 #define LPROC_SEQ_FOPS_WO_TYPE(name, type)
1280 /* lprocfs_jobstats.c */
1282 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid, int event,
1286 void lprocfs_job_stats_fini(struct obd_device *obd)
1289 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
1290 cntr_init_callback fn)
1294 /* lproc_ptlrpc.c */
1295 #define target_print_req NULL
1297 #endif /* LPROCFS */
1299 #endif /* LPROCFS_SNMP_H */