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, 2014, 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 #include <lustre/lustre_idl.h>
46 #include <libcfs/params_tree.h>
48 #ifndef HAVE_ONLY_PROCFS_SEQ
51 read_proc_t *read_fptr;
52 write_proc_t *write_fptr;
54 const struct file_operations *fops;
61 struct lprocfs_static_vars {
62 struct lprocfs_vars *module_vars;
63 struct lprocfs_vars *obd_vars;
68 struct lprocfs_seq_vars {
70 const struct file_operations *fops;
78 /* if we find more consumers this could be generalized */
79 #define OBD_HIST_MAX 32
80 struct obd_histogram {
82 unsigned long oh_buckets[OBD_HIST_MAX];
104 struct obd_histogram hist[BRW_LAST];
108 RENAME_SAMEDIR_SIZE = 0,
109 RENAME_CROSSDIR_SRC_SIZE,
110 RENAME_CROSSDIR_TGT_SIZE,
114 struct rename_stats {
115 struct obd_histogram hist[RENAME_LAST];
118 /* An lprocfs counter can be configured using the enum bit masks below.
120 * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
121 * protects this counter from concurrent updates. If not specified,
122 * lprocfs an internal per-counter lock variable. External locks are
123 * not used to protect counter increments, but are used to protect
124 * counter readout and resets.
126 * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
127 * (i.e. counter can be incremented by more than "1"). When specified,
128 * the counter maintains min, max and sum in addition to a simple
129 * invocation count. This allows averages to be be computed.
130 * If not specified, the counter is an increment-by-1 counter.
131 * min, max, sum, etc. are not maintained.
133 * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
134 * squares (for multi-valued counter samples only). This allows
135 * external computation of standard deviation, but involves a 64-bit
136 * multiply per counter increment.
140 LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
141 LPROCFS_CNTR_AVGMINMAX = 0x0002,
142 LPROCFS_CNTR_STDDEV = 0x0004,
144 /* counter data type */
145 LPROCFS_TYPE_REGS = 0x0100,
146 LPROCFS_TYPE_BYTES = 0x0200,
147 LPROCFS_TYPE_PAGES = 0x0400,
148 LPROCFS_TYPE_CYCLE = 0x0800,
151 #define LC_MIN_INIT ((~(__u64)0) >> 1)
153 struct lprocfs_counter_header {
154 unsigned int lc_config;
155 const char *lc_name; /* must be static */
156 const char *lc_units; /* must be static */
159 struct lprocfs_counter {
165 * Every counter has lc_array_sum[0], while lc_array_sum[1] is only
166 * for irq context counter, i.e. stats with
167 * LPROCFS_STATS_FLAG_IRQ_SAFE flag, its counter need
170 __s64 lc_array_sum[1];
172 #define lc_sum lc_array_sum[0]
173 #define lc_sum_irq lc_array_sum[1]
175 struct lprocfs_percpu {
176 struct lprocfs_counter lp_cntr[0];
179 enum lprocfs_stats_lock_ops {
180 LPROCFS_GET_NUM_CPU = 0x0001, /* number allocated per-CPU stats */
181 LPROCFS_GET_SMP_ID = 0x0002, /* current stat to be updated */
184 enum lprocfs_stats_flags {
185 LPROCFS_STATS_FLAG_NONE = 0x0000, /* per cpu counter */
186 LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
187 * area and need locking */
188 LPROCFS_STATS_FLAG_IRQ_SAFE = 0x0002, /* alloc need irq safe */
191 enum lprocfs_fields_flags {
192 LPROCFS_FIELDS_FLAGS_CONFIG = 0x0001,
193 LPROCFS_FIELDS_FLAGS_SUM = 0x0002,
194 LPROCFS_FIELDS_FLAGS_MIN = 0x0003,
195 LPROCFS_FIELDS_FLAGS_MAX = 0x0004,
196 LPROCFS_FIELDS_FLAGS_AVG = 0x0005,
197 LPROCFS_FIELDS_FLAGS_SUMSQUARE = 0x0006,
198 LPROCFS_FIELDS_FLAGS_COUNT = 0x0007,
201 struct lprocfs_stats {
203 unsigned short ls_num;
204 /* 1 + the biggest cpu # whose ls_percpu slot has been allocated */
205 unsigned short ls_biggest_alloc_num;
206 enum lprocfs_stats_flags ls_flags;
207 /* Lock used when there are no percpu stats areas; For percpu stats,
208 * it is used to protect ls_biggest_alloc_num change */
211 /* has ls_num of counter headers */
212 struct lprocfs_counter_header *ls_cnt_header;
213 struct lprocfs_percpu *ls_percpu[0];
216 #define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
218 /* Pack all opcodes down into a single monotonically increasing index */
219 static inline int opcode_offset(__u32 opc) {
220 if (opc < OST_LAST_OPC) {
222 return (opc - OST_FIRST_OPC);
223 } else if (opc < MDS_LAST_OPC) {
225 return (opc - MDS_FIRST_OPC +
227 } else if (opc < LDLM_LAST_OPC) {
229 return (opc - LDLM_FIRST_OPC +
232 } else if (opc < MGS_LAST_OPC) {
234 return (opc - MGS_FIRST_OPC +
238 } else if (opc < OBD_LAST_OPC) {
240 return (opc - OBD_FIRST_OPC +
245 } else if (opc < LLOG_LAST_OPC) {
247 return (opc - LLOG_FIRST_OPC +
253 } else if (opc < QUOTA_LAST_OPC) {
255 return (opc - QUOTA_FIRST_OPC +
262 } else if (opc < SEQ_LAST_OPC) {
264 return (opc - SEQ_FIRST_OPC +
272 } else if (opc < SEC_LAST_OPC) {
274 return (opc - SEC_FIRST_OPC +
283 } else if (opc < FLD_LAST_OPC) {
285 return (opc - FLD_FIRST_OPC +
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) +
329 #define LUSTRE_MAX_OPCODES (OPC_RANGE(OST) + \
339 OPC_RANGE(OUT_UPDATE) + \
342 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR) + \
346 PTLRPC_REQWAIT_CNTR = 0,
347 PTLRPC_REQQDEPTH_CNTR,
348 PTLRPC_REQACTIVE_CNTR,
350 PTLRPC_REQBUF_AVAIL_CNTR,
354 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
356 enum lprocfs_extra_opc {
357 LDLM_GLIMPSE_ENQUEUE = 0,
374 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
376 extern struct proc_dir_entry *proc_lustre_root;
379 struct obd_histogram;
381 /* Days / hours / mins / seconds format */
385 static inline void s2dhms(struct dhms *ts, time_t secs)
387 ts->d = secs / 86400;
394 #define DHMS_FMT "%dd%dh%02dm%02ds"
395 #define DHMS_VARS(x) (x)->d, (x)->h, (x)->m, (x)->s
397 #define JOBSTATS_JOBID_VAR_MAX_LEN 20
398 #define JOBSTATS_DISABLE "disable"
399 #define JOBSTATS_PROCNAME_UID "procname_uid"
401 typedef void (*cntr_init_callback)(struct lprocfs_stats *stats);
403 struct obd_job_stats {
404 cfs_hash_t *ojs_hash;
405 struct list_head ojs_list;
406 rwlock_t ojs_lock; /* protect the obj_list */
407 cntr_init_callback ojs_cntr_init_fn;
409 int ojs_cleanup_interval;
410 time_t ojs_last_cleanup;
415 extern int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
419 * Lock statistics structure for access, possibly only on this CPU.
421 * The statistics struct may be allocated with per-CPU structures for
422 * efficient concurrent update (usually only on server-wide stats), or
423 * as a single global struct (e.g. for per-client or per-job statistics),
424 * so the required locking depends on the type of structure allocated.
426 * For per-CPU statistics, pin the thread to the current cpuid so that
427 * will only access the statistics for that CPU. If the stats structure
428 * for the current CPU has not been allocated (or previously freed),
429 * allocate it now. The per-CPU statistics do not need locking since
430 * the thread is pinned to the CPU during update.
432 * For global statistics, lock the stats structure to prevent concurrent update.
434 * \param[in] stats statistics structure to lock
435 * \param[in] opc type of operation:
436 * LPROCFS_GET_SMP_ID: "lock" and return current CPU index
437 * for incrementing statistics for that CPU
438 * LPROCFS_GET_NUM_CPU: "lock" and return number of used
439 * CPU indices to iterate over all indices
440 * \param[out] flags CPU interrupt saved state for IRQ-safe locking
442 * \retval cpuid of current thread or number of allocated structs
443 * \retval negative on error (only for opc LPROCFS_GET_SMP_ID + per-CPU stats)
445 static inline int lprocfs_stats_lock(struct lprocfs_stats *stats,
446 enum lprocfs_stats_lock_ops opc,
447 unsigned long *flags)
449 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
450 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE)
451 spin_lock_irqsave(&stats->ls_lock, *flags);
453 spin_lock(&stats->ls_lock);
454 return opc == LPROCFS_GET_NUM_CPU ? 1 : 0;
458 case LPROCFS_GET_SMP_ID: {
459 unsigned int cpuid = get_cpu();
461 if (unlikely(stats->ls_percpu[cpuid] == NULL)) {
462 int rc = lprocfs_stats_alloc_one(stats, cpuid);
470 case LPROCFS_GET_NUM_CPU:
471 return stats->ls_biggest_alloc_num;
478 * Unlock statistics structure after access.
480 * Unlock the lock acquired via lprocfs_stats_lock() for global statistics,
481 * or unpin this thread from the current cpuid for per-CPU statistics.
483 * This function must be called using the same arguments as used when calling
484 * lprocfs_stats_lock() so that the correct operation can be performed.
486 * \param[in] stats statistics structure to unlock
487 * \param[in] opc type of operation (current cpuid or number of structs)
488 * \param[in] flags CPU interrupt saved state for IRQ-safe locking
490 static inline void lprocfs_stats_unlock(struct lprocfs_stats *stats,
491 enum lprocfs_stats_lock_ops opc,
492 unsigned long *flags)
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, *flags);
498 spin_unlock(&stats->ls_lock);
499 } else if (opc == LPROCFS_GET_SMP_ID) {
504 static inline unsigned int
505 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
507 unsigned int percpusize;
509 percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
511 /* irq safe stats need lc_array_sum[1] */
512 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
513 percpusize += stats->ls_num * sizeof(__s64);
515 if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
516 percpusize = L1_CACHE_ALIGN(percpusize);
521 static inline struct lprocfs_counter *
522 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
525 struct lprocfs_counter *cntr;
527 cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
529 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
530 cntr = (void *)cntr + index * sizeof(__s64);
535 /* Two optimized LPROCFS counter increment functions are provided:
536 * lprocfs_counter_incr(cntr, value) - optimized for by-one counters
537 * lprocfs_counter_add(cntr) - use for multi-valued counters
538 * Counter data layout allows config flag, counter lock and the
539 * count itself to reside within a single cache line.
542 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
544 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
547 #define lprocfs_counter_incr(stats, idx) \
548 lprocfs_counter_add(stats, idx, 1)
549 #define lprocfs_counter_decr(stats, idx) \
550 lprocfs_counter_sub(stats, idx, 1)
552 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
553 struct lprocfs_counter_header *header,
554 enum lprocfs_stats_flags flags,
555 enum lprocfs_fields_flags field);
556 static inline __u64 lprocfs_stats_collector(struct lprocfs_stats *stats,
558 enum lprocfs_fields_flags field)
561 unsigned int num_cpu;
562 unsigned long flags = 0;
565 LASSERT(stats != NULL);
567 num_cpu = lprocfs_stats_lock(stats, LPROCFS_GET_NUM_CPU, &flags);
568 for (i = 0; i < num_cpu; i++) {
569 if (stats->ls_percpu[i] == NULL)
571 ret += lprocfs_read_helper(
572 lprocfs_stats_counter_get(stats, i, idx),
573 &stats->ls_cnt_header[idx], stats->ls_flags,
576 lprocfs_stats_unlock(stats, LPROCFS_GET_NUM_CPU, &flags);
580 extern struct lprocfs_stats *
581 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags);
582 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
583 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
584 extern void lprocfs_init_ops_stats(int num_private_stats,
585 struct lprocfs_stats *stats);
586 extern void lprocfs_init_mps_stats(int num_private_stats,
587 struct lprocfs_stats *stats);
588 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
589 extern int lprocfs_alloc_obd_stats(struct obd_device *obddev,
590 unsigned int num_private_stats);
591 extern int lprocfs_alloc_md_stats(struct obd_device *obddev,
592 unsigned int num_private_stats);
593 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
594 unsigned conf, const char *name,
596 extern void lprocfs_free_obd_stats(struct obd_device *obddev);
597 extern void lprocfs_free_md_stats(struct obd_device *obddev);
600 extern int lprocfs_add_clear_entry(struct obd_device * obd,
601 struct proc_dir_entry *entry);
602 #ifdef HAVE_SERVER_SUPPORT
603 extern int lprocfs_exp_setup(struct obd_export *exp, lnet_nid_t *peer_nid);
604 extern int lprocfs_exp_cleanup(struct obd_export *exp);
606 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
609 extern struct proc_dir_entry *
610 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
611 void *data, const struct file_operations *fops);
612 extern struct proc_dir_entry *
613 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
614 const char *format, ...);
615 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
616 #ifdef HAVE_SERVER_SUPPORT
618 lprocfs_nid_stats_clear_seq_write(struct file *file, const char *buffer,
619 size_t count, loff_t *off);
620 extern int lprocfs_nid_stats_clear_seq_show(struct seq_file *file, void *data);
622 extern int lprocfs_register_stats(struct proc_dir_entry *root, const char *name,
623 struct lprocfs_stats *stats);
625 /* lprocfs_status.c */
626 #ifndef HAVE_ONLY_PROCFS_SEQ
627 extern int lprocfs_add_vars(struct proc_dir_entry *root,
628 struct lprocfs_vars *var,
631 extern struct proc_dir_entry *lprocfs_register(const char *name,
632 struct proc_dir_entry *parent,
633 struct lprocfs_vars *list,
636 extern int lprocfs_seq_add_vars(struct proc_dir_entry *root,
637 struct lprocfs_seq_vars *var,
640 extern struct proc_dir_entry *
641 lprocfs_seq_register(const char *name, struct proc_dir_entry *parent,
642 struct lprocfs_seq_vars *list, void *data);
643 extern void lprocfs_remove(struct proc_dir_entry **root);
644 extern void lprocfs_remove_proc_entry(const char *name,
645 struct proc_dir_entry *parent);
646 #ifndef HAVE_ONLY_PROCFS_SEQ
647 extern void lprocfs_try_remove_proc_entry(const char *name,
648 struct proc_dir_entry *parent);
650 extern struct proc_dir_entry *lprocfs_srch(struct proc_dir_entry *root,
653 extern int lprocfs_obd_setup(struct obd_device *dev);
654 extern int lprocfs_obd_cleanup(struct obd_device *obd);
655 #ifdef HAVE_SERVER_SUPPORT
656 extern const struct file_operations lprocfs_evict_client_fops;
658 extern int lprocfs_seq_create(struct proc_dir_entry *parent, const char *name,
660 const struct file_operations *seq_fops,
662 extern int lprocfs_obd_seq_create(struct obd_device *dev, const char *name,
664 const struct file_operations *seq_fops,
667 /* Generic callbacks */
668 extern int lprocfs_u64_seq_show(struct seq_file *m, void *data);
669 extern int lprocfs_atomic_seq_show(struct seq_file *m, void *data);
670 extern ssize_t lprocfs_atomic_seq_write(struct file *file,
671 const char __user *buffer,
672 size_t count, loff_t *off);
673 extern int lprocfs_uint_seq_show(struct seq_file *m, void *data);
674 extern ssize_t lprocfs_uint_seq_write(struct file *file,
675 const char __user *buffer,
676 size_t count, loff_t *off);
677 extern int lprocfs_wr_uint(struct file *file, const char __user *buffer,
678 unsigned long count, void *data);
679 extern int lprocfs_uuid_seq_show(struct seq_file *m, void *data);
680 extern int lprocfs_name_seq_show(struct seq_file *m, void *data);
681 extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
682 extern int lprocfs_conn_uuid_seq_show(struct seq_file *m, void *data);
683 extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
684 extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
685 extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
686 #ifdef HAVE_SERVER_SUPPORT
687 extern int lprocfs_num_exports_seq_show(struct seq_file *m, void *data);
689 struct adaptive_timeout;
690 extern int lprocfs_seq_at_hist_helper(struct seq_file *m,
691 struct adaptive_timeout *at);
692 extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
694 lprocfs_timeouts_seq_write(struct file *file, const char *buffer,
695 size_t count, loff_t *off);
696 #ifdef HAVE_SERVER_SUPPORT
697 #ifndef HAVE_ONLY_PROCFS_SEQ
698 extern ssize_t lprocfs_fops_read(struct file *f, char __user *buf,
699 size_t size, loff_t *ppos);
700 extern ssize_t lprocfs_fops_write(struct file *f, const char __user *buf,
701 size_t size, loff_t *ppos);
704 lprocfs_evict_client_seq_write(struct file *file, const char *buffer,
705 size_t count, loff_t *off);
708 lprocfs_ping_seq_write(struct file *file, const char *buffer,
709 size_t count, loff_t *off);
711 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
712 size_t count, loff_t *off);
713 extern int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data);
715 lprocfs_pinger_recov_seq_write(struct file *file, const char *buffer,
716 size_t count, loff_t *off);
719 extern int lprocfs_blksize_seq_show(struct seq_file *m, void *data);
720 extern int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data);
721 extern int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data);
722 extern int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data);
723 extern int lprocfs_filestotal_seq_show(struct seq_file *m, void *data);
724 extern int lprocfs_filesfree_seq_show(struct seq_file *m, void *data);
726 extern int lprocfs_write_helper(const char __user *buffer, unsigned long count,
728 extern int lprocfs_write_frac_helper(const char __user *buffer,
731 extern int lprocfs_seq_read_frac_helper(struct seq_file *m, long val, int mult);
732 extern int lprocfs_read_frac_helper(char *buffer, unsigned long count,
734 extern int lprocfs_write_u64_helper(const char __user *buffer,
735 unsigned long count, __u64 *val);
736 extern int lprocfs_write_frac_u64_helper(const char __user *buffer,
738 __u64 *val, int mult);
739 char *lprocfs_find_named_value(const char *buffer, const char *name,
741 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
742 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
743 void lprocfs_oh_clear(struct obd_histogram *oh);
744 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
746 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
747 struct lprocfs_counter *cnt);
749 #ifdef HAVE_SERVER_SUPPORT
750 /* lprocfs_status.c: recovery status */
751 int lprocfs_recovery_status_seq_show(struct seq_file *m, void *data);
753 /* lprocfs_status.c: hash statistics */
754 int lprocfs_hash_seq_show(struct seq_file *m, void *data);
756 /* lprocfs_status.c: IR factor */
757 int lprocfs_ir_factor_seq_show(struct seq_file *m, void *data);
759 lprocfs_ir_factor_seq_write(struct file *file, const char *buffer,
760 size_t count, loff_t *off);
762 extern int lprocfs_single_release(struct inode *, struct file *);
763 extern int lprocfs_seq_release(struct inode *, struct file *);
765 /* You must use these macros when you want to refer to
766 * the import in a client obd_device for a lprocfs entry */
767 #define LPROCFS_CLIMP_CHECK(obd) do { \
768 typecheck(struct obd_device *, obd); \
769 down_read(&(obd)->u.cli.cl_sem); \
770 if ((obd)->u.cli.cl_import == NULL) { \
771 up_read(&(obd)->u.cli.cl_sem); \
775 #define LPROCFS_CLIMP_EXIT(obd) \
776 up_read(&(obd)->u.cli.cl_sem);
778 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
779 proc entries; otherwise, you will define name##_seq_write function also for
780 a read-write proc entry, and then call LPROC_SEQ_SEQ instead. Finally,
781 call lprocfs_obd_seq_create(obd, filename, 0444, &name#_fops, data); */
782 #define __LPROC_SEQ_FOPS(name, custom_seq_write) \
783 static int name##_single_open(struct inode *inode, struct file *file) \
785 LPROCFS_ENTRY_CHECK(PDE(inode)); \
786 return single_open(file, name##_seq_show, PDE_DATA(inode)); \
788 static const struct file_operations name##_fops = { \
789 .owner = THIS_MODULE, \
790 .open = name##_single_open, \
792 .write = custom_seq_write, \
793 .llseek = seq_lseek, \
794 .release = lprocfs_single_release, \
797 #define LPROC_SEQ_FOPS_RO(name) __LPROC_SEQ_FOPS(name, NULL)
798 #define LPROC_SEQ_FOPS(name) __LPROC_SEQ_FOPS(name, name##_seq_write)
800 #define LPROC_SEQ_FOPS_RO_TYPE(name, type) \
801 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
803 return lprocfs_##type##_seq_show(m, m->private); \
805 LPROC_SEQ_FOPS_RO(name##_##type)
807 #define LPROC_SEQ_FOPS_RW_TYPE(name, type) \
808 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
810 return lprocfs_##type##_seq_show(m, m->private); \
812 static ssize_t name##_##type##_seq_write(struct file *file, \
813 const char __user *buffer, size_t count, \
816 struct seq_file *seq = file->private_data; \
817 return lprocfs_##type##_seq_write(file, buffer, \
818 count, seq->private); \
820 LPROC_SEQ_FOPS(name##_##type);
822 #define LPROC_SEQ_FOPS_WO_TYPE(name, type) \
823 static ssize_t name##_##type##_write(struct file *file, \
824 const char __user *buffer, size_t count, \
827 return lprocfs_##type##_seq_write(file, buffer, count, off);\
829 static int name##_##type##_open(struct inode *inode, struct file *file)\
831 return single_open(file, NULL, PDE_DATA(inode)); \
833 static const struct file_operations name##_##type##_fops = { \
834 .open = name##_##type##_open, \
835 .write = name##_##type##_write, \
836 .release = lprocfs_single_release, \
840 struct ptlrpc_request;
841 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
843 #ifdef HAVE_SERVER_SUPPORT
844 /* lprocfs_jobstats.c */
845 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
846 int event, long amount);
847 void lprocfs_job_stats_fini(struct obd_device *obd);
848 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
849 cntr_init_callback fn);
850 int lprocfs_job_interval_seq_show(struct seq_file *m, void *data);
852 lprocfs_job_interval_seq_write(struct file *file, const char *buffer,
853 size_t count, loff_t *off);
855 int lprocfs_recovery_time_soft_seq_show(struct seq_file *m, void *data);
856 ssize_t lprocfs_recovery_time_soft_seq_write(struct file *file,
858 size_t count, loff_t *off);
859 int lprocfs_recovery_time_hard_seq_show(struct seq_file *m, void *data);
861 lprocfs_recovery_time_hard_seq_write(struct file *file, const char *buffer,
862 size_t count, loff_t *off);
863 int lprocfs_target_instance_seq_show(struct seq_file *m, void *data);
865 int lprocfs_obd_max_pages_per_rpc_seq_show(struct seq_file *m, void *data);
867 lprocfs_obd_max_pages_per_rpc_seq_write(struct file *file, const char *buffer,
868 size_t count, loff_t *off);
870 struct root_squash_info;
871 int lprocfs_wr_root_squash(const char __user *buffer, unsigned long count,
872 struct root_squash_info *squash, char *name);
873 int lprocfs_wr_nosquash_nids(const char __user *buffer, unsigned long count,
874 struct root_squash_info *squash, char *name);
876 /* all quota proc functions */
877 extern int lprocfs_quota_rd_bunit(char *page, char **start,
878 off_t off, int count,
879 int *eof, void *data);
880 extern int lprocfs_quota_wr_bunit(struct file *file, const char *buffer,
881 unsigned long count, void *data);
882 extern int lprocfs_quota_rd_btune(char *page, char **start,
883 off_t off, int count,
884 int *eof, void *data);
885 extern int lprocfs_quota_wr_btune(struct file *file, const char *buffer,
886 unsigned long count, void *data);
887 extern int lprocfs_quota_rd_iunit(char *page, char **start,
888 off_t off, int count,
889 int *eof, void *data);
890 extern int lprocfs_quota_wr_iunit(struct file *file, const char *buffer,
891 unsigned long count, void *data);
892 extern int lprocfs_quota_rd_itune(char *page, char **start,
893 off_t off, int count,
894 int *eof, void *data);
895 extern int lprocfs_quota_wr_itune(struct file *file, const char *buffer,
896 unsigned long count, void *data);
897 extern int lprocfs_quota_rd_type(char *page, char **start, off_t off, int count,
898 int *eof, void *data);
899 extern int lprocfs_quota_wr_type(struct file *file, const char *buffer,
900 unsigned long count, void *data);
901 extern int lprocfs_quota_rd_switch_seconds(char *page, char **start, off_t off,
902 int count, int *eof, void *data);
903 extern int lprocfs_quota_wr_switch_seconds(struct file *file,
905 unsigned long count, void *data);
906 extern int lprocfs_quota_rd_sync_blk(char *page, char **start, off_t off,
907 int count, int *eof, void *data);
908 extern int lprocfs_quota_wr_sync_blk(struct file *file, const char *buffer,
909 unsigned long count, void *data);
910 extern int lprocfs_quota_rd_switch_qs(char *page, char **start, off_t off,
911 int count, int *eof, void *data);
912 extern int lprocfs_quota_wr_switch_qs(struct file *file,
914 unsigned long count, void *data);
915 extern int lprocfs_quota_rd_boundary_factor(char *page, char **start, off_t off,
916 int count, int *eof, void *data);
917 extern int lprocfs_quota_wr_boundary_factor(struct file *file,
919 unsigned long count, void *data);
920 extern int lprocfs_quota_rd_least_bunit(char *page, char **start, off_t off,
921 int count, int *eof, void *data);
922 extern int lprocfs_quota_wr_least_bunit(struct file *file,
924 unsigned long count, void *data);
925 extern int lprocfs_quota_rd_least_iunit(char *page, char **start, off_t off,
926 int count, int *eof, void *data);
927 extern int lprocfs_quota_wr_least_iunit(struct file *file,
929 unsigned long count, void *data);
930 extern int lprocfs_quota_rd_qs_factor(char *page, char **start, off_t off,
931 int count, int *eof, void *data);
932 extern int lprocfs_quota_wr_qs_factor(struct file *file,
934 unsigned long count, void *data);
936 /* LPROCFS is not defined */
938 #define proc_lustre_root NULL
940 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
941 int index, long amount)
943 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
946 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
947 int index, long amount)
949 static inline void lprocfs_counter_decr(struct lprocfs_stats *stats,
952 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
953 int index, unsigned conf,
954 const char *name, const char *units)
957 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
958 enum lprocfs_fields_flags field)
961 /* NB: we return !NULL to satisfy error checker */
962 static inline struct lprocfs_stats *
963 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags)
964 { return (struct lprocfs_stats *)1; }
965 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
967 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
969 static inline int lprocfs_register_stats(struct proc_dir_entry *root,
971 struct lprocfs_stats *stats)
973 static inline void lprocfs_init_ops_stats(int num_private_stats,
974 struct lprocfs_stats *stats)
976 static inline void lprocfs_init_mps_stats(int num_private_stats,
977 struct lprocfs_stats *stats)
979 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
981 static inline int lprocfs_alloc_obd_stats(struct obd_device *obddev,
982 unsigned int num_private_stats)
984 static inline int lprocfs_alloc_md_stats(struct obd_device *obddev,
985 unsigned int num_private_stats)
987 static inline void lprocfs_free_obd_stats(struct obd_device *obddev)
989 static inline void lprocfs_free_md_stats(struct obd_device *obddev)
993 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
995 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
997 #ifdef HAVE_SERVER_SUPPORT
999 ssize_t lprocfs_nid_stats_seq_write(struct file *file, const char *buffer,
1000 size_t count, loff_t *off)
1003 int lprocfs_nid_stats_clear_seq_show(struct seq_file *m, void *data)
1005 static inline int lprocfs_exp_setup(struct obd_export *exp,lnet_nid_t *peer_nid)
1008 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
1010 static inline struct proc_dir_entry *
1011 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
1012 void *data, const struct file_operations *fops)
1014 static inline struct proc_dir_entry *
1015 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
1016 const char *format, ...)
1018 #ifndef HAVE_ONLY_PROCFS_SEQ
1019 static inline struct proc_dir_entry *
1020 lprocfs_register(const char *name, struct proc_dir_entry *parent,
1021 struct lprocfs_vars *list, void *data)
1023 static inline int lprocfs_add_vars(struct proc_dir_entry *root,
1024 struct lprocfs_vars *var,
1028 static inline int lprocfs_seq_add_vars(struct proc_dir_entry *root,
1029 struct lprocfs_seq_vars *var,
1032 static inline struct proc_dir_entry *
1033 lprocfs_seq_register(const char *name, struct proc_dir_entry *parent,
1034 struct lprocfs_seq_vars *list, void *data)
1036 static inline void lprocfs_remove(struct proc_dir_entry **root)
1038 static inline void lprocfs_remove_proc_entry(const char *name,
1039 struct proc_dir_entry *parent)
1041 #ifndef HAVE_ONLY_PROCFS_SEQ
1042 static inline void lprocfs_try_remove_proc_entry(const char *name,
1043 struct proc_dir_entry *parent)
1045 static inline struct proc_dir_entry *lprocfs_srch(struct proc_dir_entry *head,
1049 static inline int lprocfs_obd_setup(struct obd_device *dev)
1051 static inline int lprocfs_obd_cleanup(struct obd_device *dev)
1053 static inline int lprocfs_uuid_seq_show(struct seq_file *m, void *data)
1055 static inline int lprocfs_name_seq_show(struct seq_file *m, void *data)
1057 static inline int lprocfs_server_seq_show(struct seq_file *m, void *data)
1059 static inline int lprocfs_conn_uuid_seq_show(struct seq_file *m, void *data)
1061 static inline int lprocfs_import_seq_show(struct seq_file *m, void *data)
1063 static inline int lprocfs_state_seq_show(struct seq_file *m, void *data)
1065 static inline int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data)
1067 #ifdef HAVE_SERVER_SUPPORT
1068 static inline int lprocfs_num_exports_seq_show(struct seq_file *m, void *data)
1071 struct adaptive_timeout;
1072 static inline int lprocfs_seq_at_hist_helper(struct seq_file *m,
1073 struct adaptive_timeout *at)
1075 static inline int lprocfs_timeouts_seq_show(struct seq_file *m, void *data)
1077 static inline ssize_t
1078 lprocfs_timeouts_seq_write(struct file *file, const char *buffer,
1079 size_t count, loff_t *off)
1081 #ifdef HAVE_SERVER_SUPPORT
1082 static inline ssize_t
1083 lprocfs_evict_client_seq_write(struct file *file, const char *buffer,
1084 size_t count, loff_t *off)
1087 static inline ssize_t
1088 lprocfs_ping_seq_write(struct file *file, const char __user *buffer,
1089 size_t count, loff_t *off)
1091 static inline ssize_t
1092 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
1093 size_t count, loff_t *off)
1096 lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data)
1098 static inline ssize_t
1099 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
1100 size_t count, loff_t *off)
1103 /* Statfs helpers */
1105 int lprocfs_blksize_seq_show(struct seq_file *m, void *data)
1108 int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data)
1111 int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data)
1114 int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data)
1117 int lprocfs_filestotal_seq_show(struct seq_file *m, void *data)
1120 int lprocfs_filesfree_seq_show(struct seq_file *m, void *data)
1123 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value)
1126 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value)
1129 void lprocfs_oh_clear(struct obd_histogram *oh)
1132 unsigned long lprocfs_oh_sum(struct obd_histogram *oh)
1135 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
1136 struct lprocfs_counter *cnt)
1139 __u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
1140 enum lprocfs_fields_flags field)
1141 { return (__u64)0; }
1143 #define LPROC_SEQ_FOPS_RO(name)
1144 #define LPROC_SEQ_FOPS(name)
1145 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)
1146 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)
1147 #define LPROC_SEQ_FOPS_WO_TYPE(name, type)
1149 /* lprocfs_jobstats.c */
1151 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid, int event,
1155 void lprocfs_job_stats_fini(struct obd_device *obd)
1158 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
1159 cntr_init_callback fn)
1163 /* lproc_ptlrpc.c */
1164 #define target_print_req NULL
1166 #endif /* LPROCFS */
1168 #endif /* LPROCFS_SNMP_H */