lustre/include/linux/lprocfs_status.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2002 Cluster File Systems, Inc.
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  *   Top level header file for LProc SNMP
  22  *   Author: Hariharan Thantry thantry@users.sourceforge.net
  23  */
  24 #ifndef _LPROCFS_SNMP_H
  25 #define _LPROCFS_SNMP_H
  26
  27
  28 #ifdef __KERNEL__
  29 #include <linux/config.h>
  30 #include <linux/autoconf.h>
  31 #include <linux/proc_fs.h>
  32 #include <linux/version.h>
  33 #include <linux/smp.h>
  34 #include <linux/kp30.h>
  35
  36 # if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
  37 #  include <linux/statfs.h>
  38 # else
  39 #  define kstatfs statfs
  40 # endif
  41
  42 #else
  43 #  define kstatfs statfs
  44 #endif
  45
  46
  47 #undef LPROCFS
  48 #if (defined(__KERNEL__) && defined(CONFIG_PROC_FS))
  49 # define LPROCFS
  50 #endif
  51
  52 struct lprocfs_vars {
  53         const char   *name;
  54         read_proc_t *read_fptr;
  55         write_proc_t *write_fptr;
  56         void *data;
  57 };
  58
  59 struct lprocfs_static_vars {
  60         struct lprocfs_vars *module_vars;
  61         struct lprocfs_vars *obd_vars;
  62 };
  63
  64 /* An lprocfs counter can be configured using the enum bit masks below.
  65  *
  66  * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
  67  * protects this counter from concurrent updates. If not specified,
  68  * lprocfs an internal per-counter lock variable. External locks are
  69  * not used to protect counter increments, but are used to protect
  70  * counter readout and resets.
  71  *
  72  * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
  73  * (i.e. counter can be incremented by more than "1"). When specified,
  74  * the counter maintains min, max and sum in addition to a simple
  75  * invocation count. This allows averages to be be computed.
  76  * If not specified, the counter is an increment-by-1 counter.
  77  * min, max, sum, etc. are not maintained.
  78  *
  79  * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
  80  * squares (for multi-valued counter samples only). This allows
  81  * external computation of standard deviation, but involves a 64-bit
  82  * multiply per counter increment.
  83  */
  84
  85 enum {
  86         LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
  87         LPROCFS_CNTR_AVGMINMAX    = 0x0002,
  88         LPROCFS_CNTR_STDDEV       = 0x0004,
  89
  90         /* counter data type */
  91         LPROCFS_TYPE_REGS         = 0x0100,
  92         LPROCFS_TYPE_BYTES        = 0x0200,
  93         LPROCFS_TYPE_PAGES        = 0x0400,
  94         LPROCFS_TYPE_CYCLE        = 0x0800,
  95 };
  96
  97 struct lprocfs_atomic {
  98         atomic_t               la_entry;
  99         atomic_t               la_exit;
 100 };
 101
 102 struct lprocfs_counter {
 103         struct lprocfs_atomic  lc_cntl;  /* may need to move to per set */
 104         unsigned int           lc_config;
 105         __u64                  lc_count;
 106         __u64                  lc_sum;
 107         __u64                  lc_min;
 108         __u64                  lc_max;
 109         __u64                  lc_sumsquare;
 110         const char            *lc_name;   /* must be static */
 111         const char            *lc_units;  /* must be static */
 112 };
 113
 114 struct lprocfs_percpu {
 115         struct lprocfs_counter lp_cntr[0];
 116 };
 117
 118
 119 struct lprocfs_stats {
 120         unsigned int           ls_num;     /* # of counters */
 121         unsigned int           ls_percpu_size;
 122         struct lprocfs_percpu *ls_percpu[0];
 123 };
 124
 125
 126 /* class_obd.c */
 127 extern struct proc_dir_entry *proc_lustre_root;
 128
 129 struct obd_device;
 130 struct file;
 131
 132 #ifdef LPROCFS
 133
 134 /* Two optimized LPROCFS counter increment functions are provided:
 135  *     lprocfs_counter_incr(cntr, value) - optimized for by-one counters
 136  *     lprocfs_counter_add(cntr) - use for multi-valued counters
 137  * Counter data layout allows config flag, counter lock and the
 138  * count itself to reside within a single cache line.
 139  */
 140
 141 static inline void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
 142                                        long amount)
 143 {
 144         struct lprocfs_counter *percpu_cntr;
 145
 146         LASSERT(stats != NULL);
 147         percpu_cntr = &(stats->ls_percpu[smp_processor_id()]->lp_cntr[idx]);
 148         atomic_inc(&percpu_cntr->lc_cntl.la_entry);
 149         percpu_cntr->lc_count++;
 150
 151         if (percpu_cntr->lc_config & LPROCFS_CNTR_AVGMINMAX) {
 152                 percpu_cntr->lc_sum += amount;
 153                 if (percpu_cntr->lc_config & LPROCFS_CNTR_STDDEV)
 154                         percpu_cntr->lc_sumsquare += (__u64)amount * amount;
 155                 if (amount < percpu_cntr->lc_min)
 156                         percpu_cntr->lc_min = amount;
 157                 if (amount > percpu_cntr->lc_max)
 158                         percpu_cntr->lc_max = amount;
 159         }
 160         atomic_inc(&percpu_cntr->lc_cntl.la_exit);
 161 }
 162
 163 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats, int idx)
 164 {
 165         struct lprocfs_counter *percpu_cntr;
 166
 167         LASSERT(stats != NULL);
 168         percpu_cntr = &(stats->ls_percpu[smp_processor_id()]->lp_cntr[idx]);
 169         atomic_inc(&percpu_cntr->lc_cntl.la_entry);
 170         percpu_cntr->lc_count++;
 171         atomic_inc(&percpu_cntr->lc_cntl.la_exit);
 172 }
 173
 174 extern struct lprocfs_stats *lprocfs_alloc_stats(unsigned int num);
 175 extern void lprocfs_free_stats(struct lprocfs_stats *stats);
 176 extern int lprocfs_alloc_obd_stats(struct obd_device *obddev,
 177                                    unsigned int num_private_stats);
 178 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
 179                                  unsigned conf, const char *name,
 180                                  const char *units);
 181 extern void lprocfs_free_obd_stats(struct obd_device *obddev);
 182 extern int lprocfs_register_stats(struct proc_dir_entry *root, const char *name,
 183                                   struct lprocfs_stats *stats);
 184
 185 #define LPROCFS_INIT_MULTI_VARS(array, size)                              \
 186 void lprocfs_init_multi_vars(unsigned int idx,                            \
 187                              struct lprocfs_static_vars *x)               \
 188 {                                                                         \
 189    struct lprocfs_static_vars *glob = (struct lprocfs_static_vars*)array; \
 190    LASSERT(glob != 0);                                                    \
 191    LASSERT(idx < (unsigned int)(size));                                   \
 192    x->module_vars = glob[idx].module_vars;                                \
 193    x->obd_vars = glob[idx].obd_vars;                                      \
 194 }                                                                         \
 195
 196 #define LPROCFS_INIT_VARS(name, vclass, vinstance)           \
 197 void lprocfs_##name##_init_vars(struct lprocfs_static_vars *x)  \
 198 {                                                      \
 199         x->module_vars = vclass;                       \
 200         x->obd_vars = vinstance;                       \
 201 }                                                      \
 202
 203 #define lprocfs_init_vars(NAME, VAR)     \
 204 do {      \
 205         extern void lprocfs_##NAME##_init_vars(struct lprocfs_static_vars *);  \
 206         lprocfs_##NAME##_init_vars(VAR);                                       \
 207 } while (0)
 208 extern void lprocfs_init_multi_vars(unsigned int idx,
 209                                     struct lprocfs_static_vars *var);
 210 /* lprocfs_status.c */
 211 extern int lprocfs_add_vars(struct proc_dir_entry *root,
 212                             struct lprocfs_vars *var,
 213                             void *data);
 214
 215 extern struct proc_dir_entry *lprocfs_register(const char *name,
 216                                                struct proc_dir_entry *parent,
 217                                                struct lprocfs_vars *list,
 218                                                void *data);
 219
 220 extern void lprocfs_remove(struct proc_dir_entry *root);
 221
 222 extern struct proc_dir_entry *lprocfs_srch(struct proc_dir_entry *root,
 223                                            const char *name);
 224
 225 extern int lprocfs_obd_attach(struct obd_device *dev, struct lprocfs_vars *list);
 226 extern int lprocfs_obd_detach(struct obd_device *dev);
 227
 228 /* Generic callbacks */
 229
 230 extern int lprocfs_rd_u64(char *page, char **start, off_t off,
 231                           int count, int *eof, void *data);
 232 extern int lprocfs_rd_uuid(char *page, char **start, off_t off,
 233                            int count, int *eof, void *data);
 234 extern int lprocfs_rd_name(char *page, char **start, off_t off,
 235                            int count, int *eof, void *data);
 236 extern int lprocfs_rd_fstype(char *page, char **start, off_t off,
 237                              int count, int *eof, void *data);
 238 extern int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
 239                                   int count, int *eof, void *data);
 240 extern int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
 241                                 int count, int *eof, void *data);
 242 extern int lprocfs_rd_numrefs(char *page, char **start, off_t off,
 243                               int count, int *eof, void *data);
 244
 245 /* Statfs helpers */
 246 extern int lprocfs_rd_blksize(char *page, char **start, off_t off,
 247                               int count, int *eof, void *data);
 248 extern int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
 249                                   int count, int *eof, void *data);
 250 extern int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
 251                                  int count, int *eof, void *data);
 252 extern int lprocfs_rd_filestotal(char *page, char **start, off_t off,
 253                                  int count, int *eof, void *data);
 254 extern int lprocfs_rd_filesfree(char *page, char **start, off_t off,
 255                                 int count, int *eof, void *data);
 256 extern int lprocfs_rd_filegroups(char *page, char **start, off_t off,
 257                                  int count, int *eof, void *data);
 258
 259 extern int lprocfs_write_helper(const char *buffer, unsigned long count,
 260                                 int *val);
 261
 262 /* lprocfs_status.c: counter read/write functions */
 263 extern int lprocfs_counter_read(char *page, char **start, off_t off,
 264                                 int count, int *eof, void *data);
 265 extern int lprocfs_counter_write(struct file *file, const char *buffer,
 266                                  unsigned long count, void *data);
 267 #else
 268 /* LPROCFS is not defined */
 269 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
 270                                        int index, long amount) { return; }
 271 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
 272                                         int index) { return; }
 273 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
 274                                         int index, unsigned conf,
 275                                         const char *name, const char *units)
 276 { return; }
 277
 278 static inline struct lprocfs_stats* lprocfs_alloc_stats(unsigned int num)
 279 { return NULL; }
 280 static inline void lprocfs_free_stats(struct lprocfs_stats *stats)
 281 { return; }
 282
 283 static inline int lprocfs_register_stats(struct proc_dir_entry *root,
 284                                             const char *name,
 285                                             struct lprocfs_stats *stats)
 286 { return 0; }
 287 static inline int lprocfs_alloc_obd_stats(struct obd_device *obddev,
 288                                              unsigned int num_private_stats)
 289 { return 0; }
 290 static inline void lprocfs_free_obd_stats(struct obd_device *obddev)
 291 { return; }
 292
 293 static inline struct proc_dir_entry *
 294 lprocfs_register(const char *name, struct proc_dir_entry *parent,
 295                  struct lprocfs_vars *list, void *data) { return NULL; }
 296 #define LPROCFS_INIT_MULTI_VARS(array, size) do {} while (0)
 297 static inline void lprocfs_init_multi_vars(unsigned int idx,
 298                                            struct lprocfs_static_vars *x) { return; }
 299 #define LPROCFS_INIT_VARS(name, vclass, vinstance) do {} while (0)
 300 #define lprocfs_init_vars(...) do {} while (0)
 301 static inline int lprocfs_add_vars(struct proc_dir_entry *root,
 302                                    struct lprocfs_vars *var,
 303                                    void *data) { return 0; }
 304 static inline void lprocfs_remove(struct proc_dir_entry *root) {};
 305 static inline struct proc_dir_entry *lprocfs_srch(struct proc_dir_entry *head,
 306                                     const char *name) {return 0;}
 307 static inline int lprocfs_obd_attach(struct obd_device *dev,
 308                                      struct lprocfs_vars *list) { return 0; }
 309 static inline int lprocfs_obd_detach(struct obd_device *dev)  { return 0; }
 310 static inline int lprocfs_rd_u64(char *page, char **start, off_t off,
 311                                  int count, int *eof, void *data) { return 0; }
 312 static inline int lprocfs_rd_uuid(char *page, char **start, off_t off,
 313                                   int count, int *eof, void *data) { return 0; }
 314 static inline int lprocfs_rd_name(char *page, char **start, off_t off,
 315                                   int count, int *eof, void *data) { return 0; }
 316 static inline int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
 317                                          int count, int *eof, void *data) { return 0; }
 318 static inline int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
 319                                        int count, int *eof, void *data) { return 0; }
 320 static inline int lprocfs_rd_numrefs(char *page, char **start, off_t off,
 321                                      int count, int *eof, void *data) { return 0; }
 322
 323 /* Statfs helpers */
 324 static inline
 325 int lprocfs_rd_blksize(char *page, char **start, off_t off,
 326                        int count, int *eof, void *data) { return 0; }
 327 static inline
 328 int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
 329                            int count, int *eof, void *data) { return 0; }
 330 static inline
 331 int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
 332                           int count, int *eof, void *data) { return 0; }
 333 static inline
 334 int lprocfs_rd_filestotal(char *page, char **start, off_t off,
 335                           int count, int *eof, void *data) { return 0; }
 336 static inline
 337 int lprocfs_rd_filesfree(char *page, char **start, off_t off,
 338                          int count, int *eof, void *data)  { return 0; }
 339 static inline
 340 int lprocfs_rd_filegroups(char *page, char **start, off_t off,
 341                           int count, int *eof, void *data) { return 0; }
 342 static inline
 343 int lprocfs_counter_read(char *page, char **start, off_t off,
 344                          int count, int *eof, void *data) { return 0; }
 345 static inline
 346 int lprocfs_counter_write(struct file *file, const char *buffer,
 347                           unsigned long count, void *data) { return 0; }
 348 #endif /* LPROCFS */
 349
 350 #endif /* LPROCFS_SNMP_H */