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 +
318 } else if (opc < LFSCK_LAST_OPC) {
320 return (opc - LFSCK_FIRST_OPC +
339 #define LUSTRE_MAX_OPCODES (OPC_RANGE(OST) + \
349 OPC_RANGE(UPDATE) + \
352 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR) + \
356 PTLRPC_REQWAIT_CNTR = 0,
357 PTLRPC_REQQDEPTH_CNTR,
358 PTLRPC_REQACTIVE_CNTR,
360 PTLRPC_REQBUF_AVAIL_CNTR,
364 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
367 LDLM_GLIMPSE_ENQUEUE = 0,
384 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
386 extern cfs_proc_dir_entry_t *proc_lustre_root;
389 struct obd_histogram;
391 /* Days / hours / mins / seconds format */
395 static inline void s2dhms(struct dhms *ts, time_t secs)
397 ts->d = secs / 86400;
404 #define DHMS_FMT "%dd%dh%02dm%02ds"
405 #define DHMS_VARS(x) (x)->d, (x)->h, (x)->m, (x)->s
407 #define JOBSTATS_JOBID_VAR_MAX_LEN 20
408 #define JOBSTATS_DISABLE "disable"
409 #define JOBSTATS_PROCNAME_UID "procname_uid"
411 typedef void (*cntr_init_callback)(struct lprocfs_stats *stats);
413 struct obd_job_stats {
414 cfs_hash_t *ojs_hash;
416 rwlock_t ojs_lock; /* protect the obj_list */
417 cntr_init_callback ojs_cntr_init_fn;
419 int ojs_cleanup_interval;
420 time_t ojs_last_cleanup;
425 extern int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
429 * < 0 : on error (only possible for opc as LPROCFS_GET_SMP_ID)
431 static inline int lprocfs_stats_lock(struct lprocfs_stats *stats, int opc,
432 unsigned long *flags)
440 case LPROCFS_GET_SMP_ID:
441 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
442 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE)
443 spin_lock_irqsave(&stats->ls_lock, *flags);
445 spin_lock(&stats->ls_lock);
448 unsigned int cpuid = get_cpu();
450 if (unlikely(stats->ls_percpu[cpuid] == NULL)) {
451 rc = lprocfs_stats_alloc_one(stats, cpuid);
460 case LPROCFS_GET_NUM_CPU:
461 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
462 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE)
463 spin_lock_irqsave(&stats->ls_lock, *flags);
465 spin_lock(&stats->ls_lock);
468 return stats->ls_biggest_alloc_num;
473 static inline void lprocfs_stats_unlock(struct lprocfs_stats *stats, int opc,
474 unsigned long *flags)
480 case LPROCFS_GET_SMP_ID:
481 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
482 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) {
483 spin_unlock_irqrestore(&stats->ls_lock,
486 spin_unlock(&stats->ls_lock);
493 case LPROCFS_GET_NUM_CPU:
494 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
495 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) {
496 spin_unlock_irqrestore(&stats->ls_lock,
499 spin_unlock(&stats->ls_lock);
506 static inline unsigned int
507 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
509 unsigned int percpusize;
511 percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
513 /* irq safe stats need lc_array_sum[1] */
514 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
515 percpusize += stats->ls_num * sizeof(__s64);
517 if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
518 percpusize = L1_CACHE_ALIGN(percpusize);
523 static inline struct lprocfs_counter *
524 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
527 struct lprocfs_counter *cntr;
529 cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
531 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
532 cntr = (void *)cntr + index * sizeof(__s64);
537 /* Two optimized LPROCFS counter increment functions are provided:
538 * lprocfs_counter_incr(cntr, value) - optimized for by-one counters
539 * lprocfs_counter_add(cntr) - use for multi-valued counters
540 * Counter data layout allows config flag, counter lock and the
541 * count itself to reside within a single cache line.
544 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
546 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
549 #define lprocfs_counter_incr(stats, idx) \
550 lprocfs_counter_add(stats, idx, 1)
551 #define lprocfs_counter_decr(stats, idx) \
552 lprocfs_counter_sub(stats, idx, 1)
554 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
555 struct lprocfs_counter_header *header,
556 enum lprocfs_stats_flags flags,
557 enum lprocfs_fields_flags field);
558 static inline __u64 lprocfs_stats_collector(struct lprocfs_stats *stats,
560 enum lprocfs_fields_flags field)
563 unsigned int num_cpu;
564 unsigned long flags = 0;
567 LASSERT(stats != NULL);
569 num_cpu = lprocfs_stats_lock(stats, LPROCFS_GET_NUM_CPU, &flags);
570 for (i = 0; i < num_cpu; i++) {
571 if (stats->ls_percpu[i] == NULL)
573 ret += lprocfs_read_helper(
574 lprocfs_stats_counter_get(stats, i, idx),
575 &stats->ls_cnt_header[idx], stats->ls_flags,
578 lprocfs_stats_unlock(stats, LPROCFS_GET_NUM_CPU, &flags);
582 extern struct lprocfs_stats *
583 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags);
584 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
585 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
586 extern void lprocfs_init_ops_stats(int num_private_stats,
587 struct lprocfs_stats *stats);
588 extern void lprocfs_init_mps_stats(int num_private_stats,
589 struct lprocfs_stats *stats);
590 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
591 extern int lprocfs_alloc_obd_stats(struct obd_device *obddev,
592 unsigned int num_private_stats);
593 extern int lprocfs_alloc_md_stats(struct obd_device *obddev,
594 unsigned int num_private_stats);
595 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
596 unsigned conf, const char *name,
598 extern void lprocfs_free_obd_stats(struct obd_device *obddev);
599 extern void lprocfs_free_md_stats(struct obd_device *obddev);
602 extern int lprocfs_add_clear_entry(struct obd_device * obd,
603 cfs_proc_dir_entry_t *entry);
604 #ifdef HAVE_SERVER_SUPPORT
605 extern int lprocfs_exp_setup(struct obd_export *exp,
606 lnet_nid_t *peer_nid, int *newnid);
608 extern int lprocfs_exp_cleanup(struct obd_export *exp);
609 extern cfs_proc_dir_entry_t *lprocfs_add_simple(struct proc_dir_entry *root,
611 #ifndef HAVE_ONLY_PROCFS_SEQ
612 read_proc_t *read_proc,
613 write_proc_t *write_proc,
616 struct file_operations *fops);
617 extern struct proc_dir_entry *
618 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
619 const char *format, ...);
620 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
621 #ifdef HAVE_SERVER_SUPPORT
622 #ifndef HAVE_ONLY_PROCFS_SEQ
624 lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
625 unsigned long count, void *data);
626 extern int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
627 int count, int *eof, void *data);
630 lprocfs_nid_stats_clear_seq_write(struct file *file, const char *buffer,
631 size_t count, loff_t *off);
632 extern int lprocfs_nid_stats_clear_seq_show(struct seq_file *file, void *data);
634 extern int lprocfs_register_stats(cfs_proc_dir_entry_t *root, const char *name,
635 struct lprocfs_stats *stats);
637 /* lprocfs_status.c */
638 #ifndef HAVE_ONLY_PROCFS_SEQ
639 extern int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
640 struct lprocfs_vars *var,
643 extern cfs_proc_dir_entry_t *lprocfs_register(const char *name,
644 cfs_proc_dir_entry_t *parent,
645 struct lprocfs_vars *list,
648 extern int lprocfs_seq_add_vars(cfs_proc_dir_entry_t *root,
649 struct lprocfs_seq_vars *var,
652 extern cfs_proc_dir_entry_t *
653 lprocfs_seq_register(const char *name, cfs_proc_dir_entry_t *parent,
654 struct lprocfs_seq_vars *list, void *data);
655 extern void lprocfs_remove(cfs_proc_dir_entry_t **root);
656 extern void lprocfs_remove_proc_entry(const char *name,
657 struct proc_dir_entry *parent);
658 #ifndef HAVE_ONLY_PROCFS_SEQ
659 extern void lprocfs_try_remove_proc_entry(const char *name,
660 struct proc_dir_entry *parent);
662 extern cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *root,
664 extern int lprocfs_obd_setup(struct obd_device *obd, struct lprocfs_vars *list);
666 extern int lprocfs_seq_obd_setup(struct obd_device *dev);
667 extern int lprocfs_obd_cleanup(struct obd_device *obd);
668 #ifdef HAVE_SERVER_SUPPORT
669 extern struct file_operations lprocfs_evict_client_fops;
671 extern int lprocfs_seq_create(cfs_proc_dir_entry_t *parent, const char *name,
673 const struct file_operations *seq_fops,
675 extern int lprocfs_obd_seq_create(struct obd_device *dev, const char *name,
677 const struct file_operations *seq_fops,
680 /* Generic callbacks */
681 #ifndef HAVE_ONLY_PROCFS_SEQ
682 extern int lprocfs_rd_u64(char *page, char **start, off_t off,
683 int count, int *eof, void *data);
684 extern int lprocfs_rd_atomic(char *page, char **start, off_t off,
685 int count, int *eof, void *data);
686 extern int lprocfs_wr_atomic(struct file *file, const char *buffer,
687 unsigned long count, void *data);
688 extern int lprocfs_rd_uint(char *page, char **start, off_t off,
689 int count, int *eof, void *data);
690 extern int lprocfs_rd_uuid(char *page, char **start, off_t off,
691 int count, int *eof, void *data);
692 extern int lprocfs_rd_name(char *page, char **start, off_t off,
693 int count, int *eof, void *data);
694 extern int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
695 int count, int *eof, void *data);
696 extern int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
697 int count, int *eof, void *data);
698 extern int lprocfs_rd_import(char *page, char **start, off_t off, int count,
699 int *eof, void *data);
700 extern int lprocfs_rd_state(char *page, char **start, off_t off, int count,
701 int *eof, void *data);
702 extern int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
703 int count, int *eof, void *data);
704 extern int lprocfs_rd_num_exports(char *page, char **start, off_t off,
705 int count, int *eof, void *data);
706 extern int lprocfs_rd_numrefs(char *page, char **start, off_t off,
707 int count, int *eof, void *data);
709 extern int lprocfs_u64_seq_show(struct seq_file *m, void *data);
710 extern int lprocfs_atomic_seq_show(struct seq_file *m, void *data);
711 extern ssize_t lprocfs_atomic_seq_write(struct file *file, const char *buffer,
712 size_t count, loff_t *off);
713 extern int lprocfs_uint_seq_show(struct seq_file *m, void *data);
714 extern ssize_t lprocfs_uint_seq_write(struct file *file, const char *buffer,
715 size_t count, loff_t *off);
716 extern int lprocfs_wr_uint(struct file *file, const char *buffer,
717 unsigned long count, void *data);
718 extern int lprocfs_uuid_seq_show(struct seq_file *m, void *data);
719 extern int lprocfs_name_seq_show(struct seq_file *m, void *data);
720 extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
721 extern int lprocfs_conn_uuid_seq_show(struct seq_file *m, void *data);
722 extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
723 extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
724 extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
725 #ifdef HAVE_SERVER_SUPPORT
726 extern int lprocfs_num_exports_seq_show(struct seq_file *m, void *data);
728 struct adaptive_timeout;
729 #ifndef HAVE_ONLY_PROCFS_SEQ
730 extern int lprocfs_at_hist_helper(char *page, int count, int rc,
731 struct adaptive_timeout *at);
732 extern int lprocfs_rd_timeouts(char *page, char **start, off_t off,
733 int count, int *eof, void *data);
734 extern int lprocfs_wr_timeouts(struct file *file, const char *buffer,
735 unsigned long count, void *data);
737 extern int lprocfs_seq_at_hist_helper(struct seq_file *m,
738 struct adaptive_timeout *at);
739 extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
741 lprocfs_timeouts_seq_write(struct file *file, const char *buffer,
742 size_t count, loff_t *off);
743 #ifndef HAVE_ONLY_PROCFS_SEQ
744 #ifdef HAVE_SERVER_SUPPORT
745 extern int lprocfs_wr_evict_client(struct file *file, const char *buffer,
746 unsigned long count, void *data);
748 extern int lprocfs_wr_ping(struct file *file, const char *buffer,
749 unsigned long count, void *data);
750 extern int lprocfs_wr_import(struct file *file, const char *buffer,
751 unsigned long count, void *data);
752 extern int lprocfs_rd_pinger_recov(char *page, char **start, off_t off,
753 int count, int *eof, void *data);
754 extern int lprocfs_wr_pinger_recov(struct file *file, const char *buffer,
755 unsigned long count, void *data);
757 #ifdef HAVE_SERVER_SUPPORT
759 lprocfs_evict_client_seq_write(struct file *file, const char *buffer,
760 size_t count, loff_t *off);
763 lprocfs_ping_seq_write(struct file *file, const char *buffer,
764 size_t count, loff_t *off);
766 lprocfs_import_seq_write(struct file *file, const char *buffer,
767 size_t count, loff_t *off);
768 extern int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data);
770 lprocfs_pinger_recov_seq_write(struct file *file, const char *buffer,
771 size_t count, loff_t *off);
774 #ifndef HAVE_ONLY_PROCFS_SEQ
775 extern int lprocfs_rd_blksize(char *page, char **start, off_t off,
776 int count, int *eof, void *data);
777 extern int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
778 int count, int *eof, void *data);
779 extern int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
780 int count, int *eof, void *data);
781 extern int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
782 int count, int *eof, void *data);
783 extern int lprocfs_rd_filestotal(char *page, char **start, off_t off,
784 int count, int *eof, void *data);
785 extern int lprocfs_rd_filesfree(char *page, char **start, off_t off,
786 int count, int *eof, void *data);
787 extern int lprocfs_rd_filegroups(char *page, char **start, off_t off,
788 int count, int *eof, void *data);
790 extern int lprocfs_blksize_seq_show(struct seq_file *m, void *data);
791 extern int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data);
792 extern int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data);
793 extern int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data);
794 extern int lprocfs_filestotal_seq_show(struct seq_file *m, void *data);
795 extern int lprocfs_filesfree_seq_show(struct seq_file *m, void *data);
797 extern int lprocfs_write_helper(const char *buffer, unsigned long count,
799 extern int lprocfs_write_frac_helper(const char *buffer, unsigned long count,
801 extern int lprocfs_seq_read_frac_helper(struct seq_file *m, long val, int mult);
802 extern int lprocfs_read_frac_helper(char *buffer, unsigned long count,
804 extern int lprocfs_write_u64_helper(const char *buffer, unsigned long count,
806 extern int lprocfs_write_frac_u64_helper(const char *buffer,
808 __u64 *val, int mult);
809 char *lprocfs_find_named_value(const char *buffer, const char *name,
811 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
812 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
813 void lprocfs_oh_clear(struct obd_histogram *oh);
814 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
816 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
817 struct lprocfs_counter *cnt);
819 #ifdef HAVE_SERVER_SUPPORT
820 #ifndef HAVE_ONLY_PROCFS_SEQ
821 /* lprocfs_status.c: recovery status */
822 int lprocfs_obd_rd_recovery_status(char *page, char **start, off_t off,
823 int count, int *eof, void *data);
824 /* lprocfs_statuc.c: hash statistics */
825 int lprocfs_obd_rd_hash(char *page, char **start, off_t off,
826 int count, int *eof, void *data);
828 /* lprocfs_status.c: IR factor */
829 int lprocfs_obd_rd_ir_factor(char *page, char **start, off_t off,
830 int count, int *eof, void *data);
831 int lprocfs_obd_wr_ir_factor(struct file *file, const char *buffer,
832 unsigned long count, void *data);
834 /* lprocfs_status.c: recovery status */
835 int lprocfs_recovery_status_seq_show(struct seq_file *m, void *data);
837 /* lprocfs_status.c: hash statistics */
838 int lprocfs_hash_seq_show(struct seq_file *m, void *data);
840 /* lprocfs_status.c: IR factor */
841 int lprocfs_ir_factor_seq_show(struct seq_file *m, void *data);
843 lprocfs_ir_factor_seq_write(struct file *file, const char *buffer,
844 size_t count, loff_t *off);
846 extern int lprocfs_single_release(cfs_inode_t *, struct file *);
847 extern int lprocfs_seq_release(cfs_inode_t *, struct file *);
849 /* You must use these macros when you want to refer to
850 * the import in a client obd_device for a lprocfs entry */
851 #define LPROCFS_CLIMP_CHECK(obd) do { \
852 typecheck(struct obd_device *, obd); \
853 down_read(&(obd)->u.cli.cl_sem); \
854 if ((obd)->u.cli.cl_import == NULL) { \
855 up_read(&(obd)->u.cli.cl_sem); \
859 #define LPROCFS_CLIMP_EXIT(obd) \
860 up_read(&(obd)->u.cli.cl_sem);
862 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
863 proc entries; otherwise, you will define name##_seq_write function also for
864 a read-write proc entry, and then call LPROC_SEQ_SEQ instead. Finally,
865 call lprocfs_obd_seq_create(obd, filename, 0444, &name#_fops, data); */
866 #define __LPROC_SEQ_FOPS(name, custom_seq_write) \
867 static int name##_single_open(cfs_inode_t *inode, struct file *file) \
869 LPROCFS_ENTRY_CHECK(PDE(inode)); \
870 return single_open(file, name##_seq_show, PDE_DATA(inode)); \
872 struct file_operations name##_fops = { \
873 .owner = THIS_MODULE, \
874 .open = name##_single_open, \
876 .write = custom_seq_write, \
877 .llseek = seq_lseek, \
878 .release = lprocfs_single_release, \
881 #define LPROC_SEQ_FOPS_RO(name) __LPROC_SEQ_FOPS(name, NULL)
882 #define LPROC_SEQ_FOPS(name) __LPROC_SEQ_FOPS(name, name##_seq_write)
884 #define LPROC_SEQ_FOPS_RO_TYPE(name, type) \
885 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
887 return lprocfs_##type##_seq_show(m, m->private); \
889 LPROC_SEQ_FOPS_RO(name##_##type)
891 #define LPROC_SEQ_FOPS_RW_TYPE(name, type) \
892 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
894 return lprocfs_##type##_seq_show(m, m->private); \
896 static ssize_t name##_##type##_seq_write(struct file *file, \
897 const char *buffer, size_t count, loff_t *off) \
899 struct seq_file *seq = file->private_data; \
900 return lprocfs_##type##_seq_write(file, buffer, \
901 count, seq->private); \
903 LPROC_SEQ_FOPS(name##_##type);
905 #define LPROC_SEQ_FOPS_WO_TYPE(name, type) \
906 static ssize_t name##_##type##_write(struct file *file, \
907 const char *buffer, size_t count, loff_t *off) \
909 return lprocfs_##type##_seq_write(file, buffer, count, off); \
911 static int name##_##type##_open(cfs_inode_t *inode, struct file *file) \
913 return single_open(file, NULL, PDE_DATA(inode)); \
915 struct file_operations name##_##type##_fops = { \
916 .open = name##_##type##_open, \
917 .write = name##_##type##_write, \
918 .release = lprocfs_single_release, \
922 struct ptlrpc_request;
923 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
925 #ifdef HAVE_SERVER_SUPPORT
926 /* lprocfs_jobstats.c */
927 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
928 int event, long amount);
929 void lprocfs_job_stats_fini(struct obd_device *obd);
930 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
931 cntr_init_callback fn);
932 #ifndef HAVE_ONLY_PROCFS_SEQ
933 int lprocfs_rd_job_interval(char *page, char **start, off_t off,
934 int count, int *eof, void *data);
935 int lprocfs_wr_job_interval(struct file *file, const char *buffer,
936 unsigned long count, void *data);
939 int lprocfs_obd_rd_recovery_time_soft(char *page, char **start, off_t off,
940 int count, int *eof, void *data);
941 int lprocfs_obd_wr_recovery_time_soft(struct file *file,
943 unsigned long count, void *data);
944 int lprocfs_obd_rd_recovery_time_hard(char *page, char **start, off_t off,
945 int count, int *eof, void *data);
946 int lprocfs_obd_wr_recovery_time_hard(struct file *file,
948 unsigned long count, void *data);
949 int lprocfs_target_rd_instance(char *page, char **start, off_t off,
950 int count, int *eof, void *data);
952 int lprocfs_job_interval_seq_show(struct seq_file *m, void *data);
954 lprocfs_job_interval_seq_write(struct file *file, const char *buffer,
955 size_t count, loff_t *off);
957 int lprocfs_recovery_time_soft_seq_show(struct seq_file *m, void *data);
958 ssize_t lprocfs_recovery_time_soft_seq_write(struct file *file,
960 size_t count, loff_t *off);
961 int lprocfs_recovery_time_hard_seq_show(struct seq_file *m, void *data);
963 lprocfs_recovery_time_hard_seq_write(struct file *file, const char *buffer,
964 size_t count, loff_t *off);
965 int lprocfs_target_instance_seq_show(struct seq_file *m, void *data);
967 #ifndef HAVE_ONLY_PROCFS_SEQ
968 int lprocfs_obd_rd_max_pages_per_rpc(char *page, char **start, off_t off,
969 int count, int *eof, void *data);
970 int lprocfs_obd_wr_max_pages_per_rpc(struct file *file, const char *buffer,
971 unsigned long count, void *data);
973 int lprocfs_obd_max_pages_per_rpc_seq_show(struct seq_file *m, void *data);
975 lprocfs_obd_max_pages_per_rpc_seq_write(struct file *file, const char *buffer,
976 size_t count, loff_t *off);
978 /* all quota proc functions */
979 extern int lprocfs_quota_rd_bunit(char *page, char **start,
980 off_t off, int count,
981 int *eof, void *data);
982 extern int lprocfs_quota_wr_bunit(struct file *file, const char *buffer,
983 unsigned long count, void *data);
984 extern int lprocfs_quota_rd_btune(char *page, char **start,
985 off_t off, int count,
986 int *eof, void *data);
987 extern int lprocfs_quota_wr_btune(struct file *file, const char *buffer,
988 unsigned long count, void *data);
989 extern int lprocfs_quota_rd_iunit(char *page, char **start,
990 off_t off, int count,
991 int *eof, void *data);
992 extern int lprocfs_quota_wr_iunit(struct file *file, const char *buffer,
993 unsigned long count, void *data);
994 extern int lprocfs_quota_rd_itune(char *page, char **start,
995 off_t off, int count,
996 int *eof, void *data);
997 extern int lprocfs_quota_wr_itune(struct file *file, const char *buffer,
998 unsigned long count, void *data);
999 extern int lprocfs_quota_rd_type(char *page, char **start, off_t off, int count,
1000 int *eof, void *data);
1001 extern int lprocfs_quota_wr_type(struct file *file, const char *buffer,
1002 unsigned long count, void *data);
1003 extern int lprocfs_quota_rd_switch_seconds(char *page, char **start, off_t off,
1004 int count, int *eof, void *data);
1005 extern int lprocfs_quota_wr_switch_seconds(struct file *file,
1007 unsigned long count, void *data);
1008 extern int lprocfs_quota_rd_sync_blk(char *page, char **start, off_t off,
1009 int count, int *eof, void *data);
1010 extern int lprocfs_quota_wr_sync_blk(struct file *file, const char *buffer,
1011 unsigned long count, void *data);
1012 extern int lprocfs_quota_rd_switch_qs(char *page, char **start, off_t off,
1013 int count, int *eof, void *data);
1014 extern int lprocfs_quota_wr_switch_qs(struct file *file,
1016 unsigned long count, void *data);
1017 extern int lprocfs_quota_rd_boundary_factor(char *page, char **start, off_t off,
1018 int count, int *eof, void *data);
1019 extern int lprocfs_quota_wr_boundary_factor(struct file *file,
1021 unsigned long count, void *data);
1022 extern int lprocfs_quota_rd_least_bunit(char *page, char **start, off_t off,
1023 int count, int *eof, void *data);
1024 extern int lprocfs_quota_wr_least_bunit(struct file *file,
1026 unsigned long count, void *data);
1027 extern int lprocfs_quota_rd_least_iunit(char *page, char **start, off_t off,
1028 int count, int *eof, void *data);
1029 extern int lprocfs_quota_wr_least_iunit(struct file *file,
1031 unsigned long count, void *data);
1032 extern int lprocfs_quota_rd_qs_factor(char *page, char **start, off_t off,
1033 int count, int *eof, void *data);
1034 extern int lprocfs_quota_wr_qs_factor(struct file *file,
1036 unsigned long count, void *data);
1038 /* LPROCFS is not defined */
1040 #define proc_lustre_root NULL
1042 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
1043 int index, long amount)
1045 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
1048 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
1049 int index, long amount)
1051 static inline void lprocfs_counter_decr(struct lprocfs_stats *stats,
1054 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
1055 int index, unsigned conf,
1056 const char *name, const char *units)
1059 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
1060 enum lprocfs_fields_flags field)
1063 /* NB: we return !NULL to satisfy error checker */
1064 static inline struct lprocfs_stats *
1065 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags)
1066 { return (struct lprocfs_stats *)1; }
1067 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
1069 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
1071 static inline int lprocfs_register_stats(cfs_proc_dir_entry_t *root,
1073 struct lprocfs_stats *stats)
1075 static inline void lprocfs_init_ops_stats(int num_private_stats,
1076 struct lprocfs_stats *stats)
1078 static inline void lprocfs_init_mps_stats(int num_private_stats,
1079 struct lprocfs_stats *stats)
1081 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
1083 static inline int lprocfs_alloc_obd_stats(struct obd_device *obddev,
1084 unsigned int num_private_stats)
1086 static inline int lprocfs_alloc_md_stats(struct obd_device *obddev,
1087 unsigned int num_private_stats)
1089 static inline void lprocfs_free_obd_stats(struct obd_device *obddev)
1091 static inline void lprocfs_free_md_stats(struct obd_device *obddev)
1095 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
1097 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
1099 #ifdef HAVE_SERVER_SUPPORT
1100 #ifndef HAVE_ONLY_PROCFS_SEQ
1102 int lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
1103 unsigned long count, void *data)
1106 int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
1107 int count, int *eof, void *data)
1111 ssize_t lprocfs_nid_stats_seq_write(struct file *file, const char *buffer,
1112 size_t count, loff_t *off)
1115 int lprocfs_nid_stats_clear_seq_show(struct seq_file *m, void *data)
1117 static inline int lprocfs_exp_setup(struct obd_export *exp,lnet_nid_t *peer_nid,
1121 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
1123 static inline cfs_proc_dir_entry_t *
1124 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
1125 #ifndef HAVE_ONLY_PROCFS_SEQ
1126 read_proc_t *read_proc, write_proc_t *write_proc,
1128 void *data, struct file_operations *fops)
1130 static inline struct proc_dir_entry *
1131 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
1132 const char *format, ...)
1134 #ifndef HAVE_ONLY_PROCFS_SEQ
1135 static inline cfs_proc_dir_entry_t *
1136 lprocfs_register(const char *name, cfs_proc_dir_entry_t *parent,
1137 struct lprocfs_vars *list, void *data)
1139 static inline int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
1140 struct lprocfs_vars *var,
1144 static inline int lprocfs_seq_add_vars(cfs_proc_dir_entry_t *root,
1145 struct lprocfs_seq_vars *var,
1148 #ifndef HAVE_ONLY_PROCFS_SEQ
1149 static inline cfs_proc_dir_entry_t *
1150 lprocfs_seq_register(const char *name, cfs_proc_dir_entry_t *parent,
1151 struct lprocfs_vars *list, void *data)
1154 static inline void lprocfs_remove(cfs_proc_dir_entry_t **root)
1156 static inline void lprocfs_remove_proc_entry(const char *name,
1157 struct proc_dir_entry *parent)
1159 #ifndef HAVE_ONLY_PROCFS_SEQ
1160 static inline void lprocfs_try_remove_proc_entry(const char *name,
1161 struct proc_dir_entry *parent)
1163 static inline cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *head,
1166 static inline int lprocfs_obd_setup(struct obd_device *dev,
1167 struct lprocfs_vars *list)
1170 static inline int lprocfs_seq_obd_setup(struct obd_device *dev)
1172 static inline int lprocfs_obd_cleanup(struct obd_device *dev)
1174 static inline int lprocfs_rd_u64(char *page, char **start, off_t off,
1175 int count, int *eof, void *data)
1177 #ifndef HAVE_ONLY_PROCFS_SEQ
1178 static inline int lprocfs_rd_uuid(char *page, char **start, off_t off,
1179 int count, int *eof, void *data)
1181 static inline int lprocfs_rd_name(char *page, char **start, off_t off,
1182 int count, int *eof, void *data)
1184 static inline int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
1185 int count, int *eof, void *data)
1187 static inline int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
1188 int count, int *eof, void *data)
1190 static inline int lprocfs_rd_import(char *page, char **start, off_t off,
1191 int count, int *eof, void *data)
1193 static inline int lprocfs_rd_pinger_recov(char *page, char **start, off_t off,
1194 int count, int *eof, void *data)
1196 static inline int lprocfs_rd_state(char *page, char **start, off_t off,
1197 int count, int *eof, void *data)
1199 static inline int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
1200 int count, int *eof, void *data)
1202 static inline int lprocfs_rd_num_exports(char *page, char **start, off_t off,
1203 int count, int *eof, void *data)
1205 static inline int lprocfs_rd_numrefs(struct seq_file *m, void *data)
1207 struct adaptive_timeout;
1208 static inline int lprocfs_at_hist_helper(char *page, int count, int rc,
1209 struct adaptive_timeout *at)
1211 static inline int lprocfs_rd_timeouts(char *page, char **start, off_t off,
1212 int count, int *eof, void *data)
1214 static inline int lprocfs_wr_timeouts(struct file *file,
1216 unsigned long count, void *data)
1218 #ifdef HAVE_SERVER_SUPPORT
1219 static inline int lprocfs_wr_evict_client(struct file *file,
1221 unsigned long count, void *data)
1224 static inline int lprocfs_wr_ping(struct file *file, const char *buffer,
1225 unsigned long count, void *data)
1227 static inline int lprocfs_wr_import(struct file *file, const char *buffer,
1228 unsigned long count, void *data)
1230 static inline int lprocfs_wr_pinger_recov(struct file *file, const char *buffer,
1231 unsigned long count, void *data)
1234 static inline int lprocfs_uuid_seq_show(struct seq_file *m, void *data)
1236 static inline int lprocfs_name_seq_show(struct seq_file *m, void *data)
1238 static inline int lprocfs_server_seq_show(struct seq_file *m, void *data)
1240 static inline int lprocfs_conn_uuid_seq_show(struct seq_file *m, void *data)
1242 static inline int lprocfs_import_seq_show(struct seq_file *m, void *data)
1244 static inline int lprocfs_state_seq_show(struct seq_file *m, void *data)
1246 static inline int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data)
1248 #ifdef HAVE_SERVER_SUPPORT
1249 static inline int lprocfs_num_exports_seq_show(struct seq_file *m, void *data)
1252 struct adaptive_timeout;
1253 static inline int lprocfs_seq_at_hist_helper(struct seq_file *m,
1254 struct adaptive_timeout *at)
1256 static inline int lprocfs_timeouts_seq_show(struct seq_file *m, void *data)
1258 static inline ssize_t
1259 lprocfs_timeouts_seq_write(struct file *file, const char *buffer,
1260 size_t count, loff_t *off)
1262 #ifdef HAVE_SERVER_SUPPORT
1263 static inline ssize_t
1264 lprocfs_evict_client_seq_write(struct file *file, const char *buffer,
1265 size_t count, loff_t *off)
1268 static inline ssize_t
1269 lprocfs_ping_seq_write(struct file *file, const char *buffer,
1270 size_t count, loff_t *off)
1272 static inline ssize_t
1273 lprocfs_import_seq_write(struct file *file, const char *buffer,
1274 size_t count, loff_t *off)
1277 lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data)
1279 static inline ssize_t
1280 lprocfs_pinger_recov_seq_write(struct file *file, const char *buffer,
1281 size_t count, loff_t *off)
1284 /* Statfs helpers */
1285 #ifndef HAVE_ONLY_PROCFS_SEQ
1287 int lprocfs_rd_blksize(char *page, char **start, off_t off,
1288 int count, int *eof, void *data)
1291 int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
1292 int count, int *eof, void *data)
1295 int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
1296 int count, int *eof, void *data)
1299 int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
1300 int count, int *eof, void *data)
1303 int lprocfs_rd_filestotal(char *page, char **start, off_t off,
1304 int count, int *eof, void *data)
1307 int lprocfs_rd_filesfree(char *page, char **start, off_t off,
1308 int count, int *eof, void *data)
1312 int lprocfs_blksize_seq_show(struct seq_file *m, void *data)
1315 int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data)
1318 int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data)
1321 int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data)
1324 int lprocfs_filestotal_seq_show(struct seq_file *m, void *data)
1327 int lprocfs_filesfree_seq_show(struct seq_file *m, void *data)
1330 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value)
1333 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value)
1336 void lprocfs_oh_clear(struct obd_histogram *oh)
1339 unsigned long lprocfs_oh_sum(struct obd_histogram *oh)
1342 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
1343 struct lprocfs_counter *cnt)
1346 __u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
1347 enum lprocfs_fields_flags field)
1348 { return (__u64)0; }
1350 #define LPROC_SEQ_FOPS_RO(name)
1351 #define LPROC_SEQ_FOPS(name)
1352 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)
1353 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)
1354 #define LPROC_SEQ_FOPS_WO_TYPE(name, type)
1356 /* lprocfs_jobstats.c */
1358 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid, int event,
1362 void lprocfs_job_stats_fini(struct obd_device *obd)
1365 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
1366 cntr_init_callback fn)
1370 /* lproc_ptlrpc.c */
1371 #define target_print_req NULL
1373 #endif /* LPROCFS */
1375 #endif /* LPROCFS_SNMP_H */