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, 2015, 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 <linux/debugfs.h>
46 #include <linux/seq_file.h>
47 #include <linux/spinlock.h>
48 #include <linux/types.h>
50 #include "lustre/lustre_idl.h"
54 struct file_operations *fops;
62 struct lprocfs_static_vars {
63 struct lprocfs_vars *obd_vars;
64 struct attribute_group *sysfs_vars;
67 /* if we find more consumers this could be generalized */
68 #define OBD_HIST_MAX 32
69 struct obd_histogram {
71 unsigned long oh_buckets[OBD_HIST_MAX];
93 struct obd_histogram hist[BRW_LAST];
97 RENAME_SAMEDIR_SIZE = 0,
98 RENAME_CROSSDIR_SRC_SIZE,
99 RENAME_CROSSDIR_TGT_SIZE,
103 struct rename_stats {
104 struct obd_histogram hist[RENAME_LAST];
107 /* An lprocfs counter can be configured using the enum bit masks below.
109 * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
110 * protects this counter from concurrent updates. If not specified,
111 * lprocfs an internal per-counter lock variable. External locks are
112 * not used to protect counter increments, but are used to protect
113 * counter readout and resets.
115 * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
116 * (i.e. counter can be incremented by more than "1"). When specified,
117 * the counter maintains min, max and sum in addition to a simple
118 * invocation count. This allows averages to be be computed.
119 * If not specified, the counter is an increment-by-1 counter.
120 * min, max, sum, etc. are not maintained.
122 * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
123 * squares (for multi-valued counter samples only). This allows
124 * external computation of standard deviation, but involves a 64-bit
125 * multiply per counter increment.
129 LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
130 LPROCFS_CNTR_AVGMINMAX = 0x0002,
131 LPROCFS_CNTR_STDDEV = 0x0004,
133 /* counter data type */
134 LPROCFS_TYPE_REGS = 0x0100,
135 LPROCFS_TYPE_BYTES = 0x0200,
136 LPROCFS_TYPE_PAGES = 0x0400,
137 LPROCFS_TYPE_CYCLE = 0x0800,
140 #define LC_MIN_INIT ((~(__u64)0) >> 1)
142 struct lprocfs_counter_header {
143 unsigned int lc_config;
144 const char *lc_name; /* must be static */
145 const char *lc_units; /* must be static */
148 struct lprocfs_counter {
154 * Every counter has lc_array_sum[0], while lc_array_sum[1] is only
155 * for irq context counter, i.e. stats with
156 * LPROCFS_STATS_FLAG_IRQ_SAFE flag, its counter need
159 __s64 lc_array_sum[1];
162 #define lc_sum lc_array_sum[0]
163 #define lc_sum_irq lc_array_sum[1]
165 struct lprocfs_percpu {
169 struct lprocfs_counter lp_cntr[0];
172 #define LPROCFS_GET_NUM_CPU 0x0001
173 #define LPROCFS_GET_SMP_ID 0x0002
175 enum lprocfs_stats_flags {
176 LPROCFS_STATS_FLAG_NONE = 0x0000, /* per cpu counter */
177 LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
178 * area and need locking */
179 LPROCFS_STATS_FLAG_IRQ_SAFE = 0x0002, /* alloc need irq safe */
182 enum lprocfs_fields_flags {
183 LPROCFS_FIELDS_FLAGS_CONFIG = 0x0001,
184 LPROCFS_FIELDS_FLAGS_SUM = 0x0002,
185 LPROCFS_FIELDS_FLAGS_MIN = 0x0003,
186 LPROCFS_FIELDS_FLAGS_MAX = 0x0004,
187 LPROCFS_FIELDS_FLAGS_AVG = 0x0005,
188 LPROCFS_FIELDS_FLAGS_SUMSQUARE = 0x0006,
189 LPROCFS_FIELDS_FLAGS_COUNT = 0x0007,
192 struct lprocfs_stats {
194 unsigned short ls_num;
195 /* 1 + the biggest cpu # whose ls_percpu slot has been allocated */
196 unsigned short ls_biggest_alloc_num;
197 enum lprocfs_stats_flags ls_flags;
198 /* Lock used when there are no percpu stats areas; For percpu stats,
199 * it is used to protect ls_biggest_alloc_num change */
202 /* has ls_num of counter headers */
203 struct lprocfs_counter_header *ls_cnt_header;
204 struct lprocfs_percpu *ls_percpu[0];
207 #define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
209 /* Pack all opcodes down into a single monotonically increasing index */
210 static inline int opcode_offset(__u32 opc)
212 if (opc < OST_LAST_OPC) {
214 return (opc - OST_FIRST_OPC);
215 } else if (opc < MDS_LAST_OPC) {
217 return (opc - MDS_FIRST_OPC +
219 } else if (opc < LDLM_LAST_OPC) {
221 return (opc - LDLM_FIRST_OPC +
224 } else if (opc < MGS_LAST_OPC) {
226 return (opc - MGS_FIRST_OPC +
230 } else if (opc < OBD_LAST_OPC) {
232 return (opc - OBD_FIRST_OPC +
237 } else if (opc < LLOG_LAST_OPC) {
239 return (opc - LLOG_FIRST_OPC +
245 } else if (opc < QUOTA_LAST_OPC) {
247 return (opc - QUOTA_FIRST_OPC +
254 } else if (opc < SEQ_LAST_OPC) {
256 return (opc - SEQ_FIRST_OPC +
264 } else if (opc < SEC_LAST_OPC) {
266 return (opc - SEC_FIRST_OPC +
275 } else if (opc < FLD_LAST_OPC) {
277 return (opc - FLD_FIRST_OPC +
287 } else if (opc < UPDATE_LAST_OPC) {
289 return (opc - UPDATE_FIRST_OPC +
306 #define LUSTRE_MAX_OPCODES (OPC_RANGE(OST) + \
318 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR) + \
322 PTLRPC_REQWAIT_CNTR = 0,
323 PTLRPC_REQQDEPTH_CNTR,
324 PTLRPC_REQACTIVE_CNTR,
326 PTLRPC_REQBUF_AVAIL_CNTR,
330 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
333 LDLM_GLIMPSE_ENQUEUE = 0,
350 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
352 extern struct dentry *debugfs_lustre_root;
353 extern struct kobject *lustre_kobj;
356 struct obd_histogram;
358 /* Days / hours / mins / seconds format */
363 static inline void s2dhms(struct dhms *ts, time64_t secs64)
367 ts->d = div_u64_rem(secs64, 86400, &secs);
374 #define DHMS_FMT "%dd%dh%02dm%02ds"
375 #define DHMS_VARS(x) (x)->d, (x)->h, (x)->m, (x)->s
377 #define JOBSTATS_JOBID_VAR_MAX_LEN 20
378 #define JOBSTATS_DISABLE "disable"
379 #define JOBSTATS_PROCNAME_UID "procname_uid"
380 #define JOBSTATS_NODELOCAL "nodelocal"
382 int lprocfs_write_frac_helper(const char __user *buffer,
383 unsigned long count, int *val, int mult);
384 int lprocfs_read_frac_helper(char *buffer, unsigned long count,
386 int lprocfs_stats_alloc_one(struct lprocfs_stats *stats, unsigned int cpuid);
389 * < 0 : on error (only possible for opc as LPROCFS_GET_SMP_ID)
391 static inline int lprocfs_stats_lock(struct lprocfs_stats *stats, int opc,
392 unsigned long *flags)
400 case LPROCFS_GET_SMP_ID:
401 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
402 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE)
403 spin_lock_irqsave(&stats->ls_lock, *flags);
405 spin_lock(&stats->ls_lock);
408 unsigned int cpuid = get_cpu();
410 if (unlikely(stats->ls_percpu[cpuid] == NULL)) {
411 rc = lprocfs_stats_alloc_one(stats, cpuid);
420 case LPROCFS_GET_NUM_CPU:
421 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
422 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE)
423 spin_lock_irqsave(&stats->ls_lock, *flags);
425 spin_lock(&stats->ls_lock);
428 return stats->ls_biggest_alloc_num;
432 static inline void lprocfs_stats_unlock(struct lprocfs_stats *stats, int opc,
433 unsigned long *flags)
439 case LPROCFS_GET_SMP_ID:
440 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
441 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) {
442 spin_unlock_irqrestore(&stats->ls_lock,
445 spin_unlock(&stats->ls_lock);
452 case LPROCFS_GET_NUM_CPU:
453 if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
454 if (stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) {
455 spin_unlock_irqrestore(&stats->ls_lock,
458 spin_unlock(&stats->ls_lock);
465 static inline unsigned int
466 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
468 unsigned int percpusize;
470 percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
472 /* irq safe stats need lc_array_sum[1] */
473 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
474 percpusize += stats->ls_num * sizeof(__s64);
476 if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
477 percpusize = L1_CACHE_ALIGN(percpusize);
482 static inline struct lprocfs_counter *
483 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
486 struct lprocfs_counter *cntr;
488 cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
490 if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
491 cntr = (void *)cntr + index * sizeof(__s64);
496 /* Two optimized LPROCFS counter increment functions are provided:
497 * lprocfs_counter_incr(cntr, value) - optimized for by-one counters
498 * lprocfs_counter_add(cntr) - use for multi-valued counters
499 * Counter data layout allows config flag, counter lock and the
500 * count itself to reside within a single cache line.
503 void lprocfs_counter_add(struct lprocfs_stats *stats, int idx, long amount);
504 void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx, long amount);
506 #define lprocfs_counter_incr(stats, idx) \
507 lprocfs_counter_add(stats, idx, 1)
508 #define lprocfs_counter_decr(stats, idx) \
509 lprocfs_counter_sub(stats, idx, 1)
511 __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
512 struct lprocfs_counter_header *header,
513 enum lprocfs_stats_flags flags,
514 enum lprocfs_fields_flags field);
515 static inline __u64 lprocfs_stats_collector(struct lprocfs_stats *stats,
517 enum lprocfs_fields_flags field)
520 unsigned int num_cpu;
521 unsigned long flags = 0;
524 LASSERT(stats != NULL);
526 num_cpu = lprocfs_stats_lock(stats, LPROCFS_GET_NUM_CPU, &flags);
527 for (i = 0; i < num_cpu; i++) {
528 if (stats->ls_percpu[i] == NULL)
530 ret += lprocfs_read_helper(
531 lprocfs_stats_counter_get(stats, i, idx),
532 &stats->ls_cnt_header[idx], stats->ls_flags,
535 lprocfs_stats_unlock(stats, LPROCFS_GET_NUM_CPU, &flags);
539 extern struct lprocfs_stats *
540 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags);
541 void lprocfs_clear_stats(struct lprocfs_stats *stats);
542 void lprocfs_free_stats(struct lprocfs_stats **stats);
543 void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
544 unsigned conf, const char *name, const char *units);
546 int lprocfs_exp_cleanup(struct obd_export *exp);
547 struct dentry *ldebugfs_add_simple(struct dentry *root,
550 struct file_operations *fops);
552 int ldebugfs_register_stats(struct dentry *parent,
554 struct lprocfs_stats *stats);
556 /* lprocfs_status.c */
557 int ldebugfs_add_vars(struct dentry *parent,
558 struct lprocfs_vars *var,
561 struct dentry *ldebugfs_register(const char *name,
562 struct dentry *parent,
563 struct lprocfs_vars *list,
566 void ldebugfs_remove(struct dentry **entryp);
568 int lprocfs_obd_setup(struct obd_device *obd, struct lprocfs_vars *list,
569 struct attribute_group *attrs);
570 int lprocfs_obd_cleanup(struct obd_device *obd);
572 int ldebugfs_seq_create(struct dentry *parent,
575 const struct file_operations *seq_fops,
577 int ldebugfs_obd_seq_create(struct obd_device *dev,
580 const struct file_operations *seq_fops,
583 /* Generic callbacks */
585 int lprocfs_rd_uint(struct seq_file *m, void *data);
586 int lprocfs_wr_uint(struct file *file, const char __user *buffer,
587 unsigned long count, void *data);
588 int lprocfs_rd_server_uuid(struct seq_file *m, void *data);
589 int lprocfs_rd_conn_uuid(struct seq_file *m, void *data);
590 int lprocfs_rd_import(struct seq_file *m, void *data);
591 int lprocfs_rd_state(struct seq_file *m, void *data);
592 int lprocfs_rd_connect_flags(struct seq_file *m, void *data);
594 struct adaptive_timeout;
595 int lprocfs_at_hist_helper(struct seq_file *m, struct adaptive_timeout *at);
596 int lprocfs_rd_timeouts(struct seq_file *m, void *data);
597 int lprocfs_wr_ping(struct file *file, const char __user *buffer,
598 size_t count, loff_t *off);
599 int lprocfs_wr_import(struct file *file, const char __user *buffer,
600 size_t count, loff_t *off);
601 int lprocfs_rd_pinger_recov(struct seq_file *m, void *n);
602 int lprocfs_wr_pinger_recov(struct file *file, const char __user *buffer,
603 size_t count, loff_t *off);
607 int lprocfs_write_helper(const char __user *buffer, unsigned long count,
609 int lprocfs_write_u64_helper(const char __user *buffer,
610 unsigned long count, __u64 *val);
611 int lprocfs_write_frac_u64_helper(const char __user *buffer,
613 __u64 *val, int mult);
614 char *lprocfs_find_named_value(const char *buffer, const char *name,
616 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
617 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
618 void lprocfs_oh_clear(struct obd_histogram *oh);
619 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
621 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
622 struct lprocfs_counter *cnt);
624 int lprocfs_single_release(struct inode *, struct file *);
625 int lprocfs_seq_release(struct inode *, struct file *);
627 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
628 proc entries; otherwise, you will define name##_seq_write function also for
629 a read-write proc entry, and then call LPROC_SEQ_SEQ instead. Finally,
630 call ldebugfs_obd_seq_create(obd, filename, 0444, &name#_fops, data); */
631 #define __LPROC_SEQ_FOPS(name, custom_seq_write) \
632 static int name##_single_open(struct inode *inode, struct file *file) \
634 return single_open(file, name##_seq_show, inode->i_private); \
636 static struct file_operations name##_fops = { \
637 .owner = THIS_MODULE, \
638 .open = name##_single_open, \
640 .write = custom_seq_write, \
641 .llseek = seq_lseek, \
642 .release = lprocfs_single_release, \
645 #define LPROC_SEQ_FOPS_RO(name) __LPROC_SEQ_FOPS(name, NULL)
646 #define LPROC_SEQ_FOPS(name) __LPROC_SEQ_FOPS(name, name##_seq_write)
648 #define LPROC_SEQ_FOPS_RO_TYPE(name, type) \
649 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
651 return lprocfs_rd_##type(m, m->private); \
653 LPROC_SEQ_FOPS_RO(name##_##type)
655 #define LPROC_SEQ_FOPS_RW_TYPE(name, type) \
656 static int name##_##type##_seq_show(struct seq_file *m, void *v)\
658 return lprocfs_rd_##type(m, m->private); \
660 static ssize_t name##_##type##_seq_write(struct file *file, \
661 const char __user *buffer, size_t count, \
664 struct seq_file *seq = file->private_data; \
665 return lprocfs_wr_##type(file, buffer, \
666 count, seq->private); \
668 LPROC_SEQ_FOPS(name##_##type)
670 #define LPROC_SEQ_FOPS_WR_ONLY(name, type) \
671 static ssize_t name##_##type##_write(struct file *file, \
672 const char __user *buffer, size_t count, \
675 return lprocfs_wr_##type(file, buffer, count, off); \
677 static int name##_##type##_open(struct inode *inode, struct file *file) \
679 return single_open(file, NULL, inode->i_private); \
681 static struct file_operations name##_##type##_fops = { \
682 .open = name##_##type##_open, \
683 .write = name##_##type##_write, \
684 .release = lprocfs_single_release, \
688 struct attribute attr;
689 ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
691 ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
692 const char *buf, size_t len);
695 #define LUSTRE_ATTR(name, mode, show, store) \
696 static struct lustre_attr lustre_attr_##name = __ATTR(name, mode, show, store)
698 #define LUSTRE_RO_ATTR(name) LUSTRE_ATTR(name, 0444, name##_show, NULL)
699 #define LUSTRE_RW_ATTR(name) LUSTRE_ATTR(name, 0644, name##_show, name##_store)
701 extern const struct sysfs_ops lustre_sysfs_ops;
703 /* all quota proc functions */
704 int lprocfs_quota_rd_bunit(char *page, char **start,
705 loff_t off, int count,
706 int *eof, void *data);
707 int lprocfs_quota_wr_bunit(struct file *file, const char *buffer,
708 unsigned long count, void *data);
709 int lprocfs_quota_rd_btune(char *page, char **start,
710 loff_t off, int count,
711 int *eof, void *data);
712 int lprocfs_quota_wr_btune(struct file *file, const char *buffer,
713 unsigned long count, void *data);
714 int lprocfs_quota_rd_iunit(char *page, char **start,
715 loff_t off, int count,
716 int *eof, void *data);
717 int lprocfs_quota_wr_iunit(struct file *file, const char *buffer,
718 unsigned long count, void *data);
719 int lprocfs_quota_rd_itune(char *page, char **start,
720 loff_t off, int count,
721 int *eof, void *data);
722 int lprocfs_quota_wr_itune(struct file *file, const char *buffer,
723 unsigned long count, void *data);
724 int lprocfs_quota_rd_type(char *page, char **start, loff_t off, int count,
725 int *eof, void *data);
726 int lprocfs_quota_wr_type(struct file *file, const char *buffer,
727 unsigned long count, void *data);
728 int lprocfs_quota_rd_switch_seconds(char *page, char **start, loff_t off,
729 int count, int *eof, void *data);
730 int lprocfs_quota_wr_switch_seconds(struct file *file,
732 unsigned long count, void *data);
733 int lprocfs_quota_rd_sync_blk(char *page, char **start, loff_t off,
734 int count, int *eof, void *data);
735 int lprocfs_quota_wr_sync_blk(struct file *file, const char *buffer,
736 unsigned long count, void *data);
737 int lprocfs_quota_rd_switch_qs(char *page, char **start, loff_t off,
738 int count, int *eof, void *data);
739 int lprocfs_quota_wr_switch_qs(struct file *file,
740 const char *buffer, unsigned long count,
742 int lprocfs_quota_rd_boundary_factor(char *page, char **start, loff_t off,
743 int count, int *eof, void *data);
744 int lprocfs_quota_wr_boundary_factor(struct file *file,
745 const char *buffer, unsigned long count,
747 int lprocfs_quota_rd_least_bunit(char *page, char **start, loff_t off,
748 int count, int *eof, void *data);
749 int lprocfs_quota_wr_least_bunit(struct file *file,
750 const char *buffer, unsigned long count,
752 int lprocfs_quota_rd_least_iunit(char *page, char **start, loff_t off,
753 int count, int *eof, void *data);
754 int lprocfs_quota_wr_least_iunit(struct file *file,
755 const char *buffer, unsigned long count,
757 int lprocfs_quota_rd_qs_factor(char *page, char **start, loff_t off,
758 int count, int *eof, void *data);
759 int lprocfs_quota_wr_qs_factor(struct file *file,
760 const char *buffer, unsigned long count,
762 #endif /* LPROCFS_SNMP_H */