lustre/include/lprocfs_status.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/include/lprocfs_status.h
  37  *
  38  * Top level header file for LProc SNMP
  39  *
  40  * Author: Hariharan Thantry thantry@users.sourceforge.net
  41  */
  42 #ifndef _LPROCFS_SNMP_H
  43 #define _LPROCFS_SNMP_H
  44
  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>
  51 #else
  52 #error Unsupported operating system.
  53 #endif
  54 #include <lustre/lustre_idl.h>
  55
  56 #undef LPROCFS
  57 #if (defined(__KERNEL__) && defined(CONFIG_PROC_FS))
  58 # define LPROCFS
  59 #endif
  60
  61 struct lprocfs_vars {
  62         const char   *name;
  63         cfs_read_proc_t *read_fptr;
  64         cfs_write_proc_t *write_fptr;
  65         void *data;
  66         struct file_operations *fops;
  67         /**
  68          * /proc file mode.
  69          */
  70         mode_t proc_mode;
  71 };
  72
  73 struct lprocfs_static_vars {
  74         struct lprocfs_vars *module_vars;
  75         struct lprocfs_vars *obd_vars;
  76 };
  77
  78 /* if we find more consumers this could be generalized */
  79 #define OBD_HIST_MAX 32
  80 struct obd_histogram {
  81         spinlock_t      oh_lock;
  82         unsigned long   oh_buckets[OBD_HIST_MAX];
  83 };
  84
  85 enum {
  86         BRW_R_PAGES = 0,
  87         BRW_W_PAGES,
  88         BRW_R_RPC_HIST,
  89         BRW_W_RPC_HIST,
  90         BRW_R_IO_TIME,
  91         BRW_W_IO_TIME,
  92         BRW_R_DISCONT_PAGES,
  93         BRW_W_DISCONT_PAGES,
  94         BRW_R_DISCONT_BLOCKS,
  95         BRW_W_DISCONT_BLOCKS,
  96         BRW_R_DISK_IOSIZE,
  97         BRW_W_DISK_IOSIZE,
  98         BRW_R_DIO_FRAGS,
  99         BRW_W_DIO_FRAGS,
 100         BRW_LAST,
 101 };
 102
 103 struct brw_stats {
 104         struct obd_histogram hist[BRW_LAST];
 105 };
 106
 107
 108 /* An lprocfs counter can be configured using the enum bit masks below.
 109  *
 110  * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
 111  * protects this counter from concurrent updates. If not specified,
 112  * lprocfs an internal per-counter lock variable. External locks are
 113  * not used to protect counter increments, but are used to protect
 114  * counter readout and resets.
 115  *
 116  * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
 117  * (i.e. counter can be incremented by more than "1"). When specified,
 118  * the counter maintains min, max and sum in addition to a simple
 119  * invocation count. This allows averages to be be computed.
 120  * If not specified, the counter is an increment-by-1 counter.
 121  * min, max, sum, etc. are not maintained.
 122  *
 123  * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
 124  * squares (for multi-valued counter samples only). This allows
 125  * external computation of standard deviation, but involves a 64-bit
 126  * multiply per counter increment.
 127  */
 128
 129 enum {
 130         LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
 131         LPROCFS_CNTR_AVGMINMAX    = 0x0002,
 132         LPROCFS_CNTR_STDDEV       = 0x0004,
 133
 134         /* counter data type */
 135         LPROCFS_TYPE_REGS         = 0x0100,
 136         LPROCFS_TYPE_BYTES        = 0x0200,
 137         LPROCFS_TYPE_PAGES        = 0x0400,
 138         LPROCFS_TYPE_CYCLE        = 0x0800,
 139 };
 140
 141 struct lprocfs_atomic {
 142         atomic_t               la_entry;
 143         atomic_t               la_exit;
 144 };
 145
 146 #define LC_MIN_INIT ((~(__u64)0) >> 1)
 147
 148 struct lprocfs_counter {
 149         struct lprocfs_atomic  lc_cntl;  /* may need to move to per set */
 150         unsigned int           lc_config;
 151         __s64                  lc_count;
 152         __s64                  lc_sum;
 153         __s64                  lc_sum_irq;
 154         __s64                  lc_min;
 155         __s64                  lc_max;
 156         __s64                  lc_sumsquare;
 157         const char            *lc_name;   /* must be static */
 158         const char            *lc_units;  /* must be static */
 159 };
 160
 161 struct lprocfs_percpu {
 162         struct lprocfs_counter lp_cntr[0];
 163 };
 164
 165 #define LPROCFS_GET_NUM_CPU 0x0001
 166 #define LPROCFS_GET_SMP_ID  0x0002
 167
 168 enum lprocfs_stats_flags {
 169         LPROCFS_STATS_FLAG_NONE     = 0x0000, /* per cpu counter */
 170         LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
 171                                                * area and need locking */
 172         LPROCFS_STATS_GET_SMP_ID    = 0x0002, /* just record locking with
 173                                                * LPROCFS_GET_SMP_ID flag */
 174 };
 175
 176 enum lprocfs_fields_flags {
 177         LPROCFS_FIELDS_FLAGS_CONFIG = 0x0001,
 178         LPROCFS_FIELDS_FLAGS_SUM    = 0x0002,
 179         LPROCFS_FIELDS_FLAGS_MIN    = 0x0003,
 180         LPROCFS_FIELDS_FLAGS_MAX    = 0x0004,
 181         LPROCFS_FIELDS_FLAGS_AVG    = 0x0005,
 182         LPROCFS_FIELDS_FLAGS_SUMSQUARE = 0x0006,
 183         LPROCFS_FIELDS_FLAGS_COUNT  = 0x0007,
 184 };
 185
 186 struct lprocfs_stats {
 187         unsigned int           ls_num;     /* # of counters */
 188         int                    ls_flags; /* See LPROCFS_STATS_FLAG_* */
 189         spinlock_t             ls_lock;  /* Lock used only when there are
 190                                           * no percpu stats areas */
 191         struct lprocfs_percpu *ls_percpu[0];
 192 };
 193
 194 static inline int opcode_offset(__u32 opc) {
 195         if (opc < OST_LAST_OPC) {
 196                  /* OST opcode */
 197                 return (opc - OST_FIRST_OPC);
 198         } else if (opc < MDS_LAST_OPC) {
 199                 /* MDS opcode */
 200                 return (opc - MDS_FIRST_OPC +
 201                         (OST_LAST_OPC - OST_FIRST_OPC));
 202         } else if (opc < LDLM_LAST_OPC) {
 203                 /* LDLM Opcode */
 204                 return (opc - LDLM_FIRST_OPC +
 205                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 206                         (OST_LAST_OPC - OST_FIRST_OPC));
 207         } else if (opc < MGS_LAST_OPC) {
 208                 /* MGS Opcode */
 209                 return (opc - MGS_FIRST_OPC +
 210                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 211                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 212                         (OST_LAST_OPC - OST_FIRST_OPC));
 213         } else if (opc < OBD_LAST_OPC) {
 214                 /* OBD Ping */
 215                 return (opc - OBD_FIRST_OPC +
 216                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 217                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 218                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 219                         (OST_LAST_OPC - OST_FIRST_OPC));
 220         } else if (opc < LLOG_LAST_OPC) {
 221                 /* LLOG Opcode */
 222                 return (opc - LLOG_FIRST_OPC +
 223                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 224                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 225                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 226                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 227                         (OST_LAST_OPC - OST_FIRST_OPC));
 228        } else if (opc < QUOTA_LAST_OPC) {
 229                 /* LQUOTA Opcode */
 230                 return (opc - QUOTA_FIRST_OPC +
 231                         (LLOG_LAST_OPC - LLOG_FIRST_OPC) +
 232                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 233                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 234                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 235                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 236                         (OST_LAST_OPC - OST_FIRST_OPC));
 237         } else if (opc < SEQ_LAST_OPC) {
 238                 /* SEQ opcode */
 239                 return (opc - SEQ_FIRST_OPC +
 240                         (QUOTA_LAST_OPC - QUOTA_FIRST_OPC) +
 241                         (LLOG_LAST_OPC - LLOG_FIRST_OPC) +
 242                         (OBD_LAST_OPC - OBD_FIRST_OPC) +
 243                         (MGS_LAST_OPC - MGS_FIRST_OPC) +
 244                         (LDLM_LAST_OPC - LDLM_FIRST_OPC) +
 245                         (MDS_LAST_OPC - MDS_FIRST_OPC) +
 246                         (OST_LAST_OPC - OST_FIRST_OPC));
 247         } else {
 248                 /* Unknown Opcode */
 249                 return -1;
 250         }
 251 }
 252
 253 #define LUSTRE_MAX_OPCODES ((OST_LAST_OPC - OST_FIRST_OPC)     + \
 254                             (MDS_LAST_OPC - MDS_FIRST_OPC)     + \
 255                             (LDLM_LAST_OPC - LDLM_FIRST_OPC)   + \
 256                             (MGS_LAST_OPC - MGS_FIRST_OPC)     + \
 257                             (OBD_LAST_OPC - OBD_FIRST_OPC)     + \
 258                             (LLOG_LAST_OPC - LLOG_FIRST_OPC)   + \
 259                             (QUOTA_LAST_OPC - QUOTA_FIRST_OPC) + \
 260                             (SEQ_LAST_OPC - SEQ_FIRST_OPC))
 261
 262 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR)  + \
 263                            (EXTRA_LAST_OPC - EXTRA_FIRST_OPC))
 264
 265 enum {
 266         PTLRPC_REQWAIT_CNTR = 0,
 267         PTLRPC_REQQDEPTH_CNTR,
 268         PTLRPC_REQACTIVE_CNTR,
 269         PTLRPC_TIMEOUT,
 270         PTLRPC_REQBUF_AVAIL_CNTR,
 271         PTLRPC_LAST_CNTR
 272 };
 273
 274 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
 275
 276 enum {
 277         LDLM_GLIMPSE_ENQUEUE = 0,
 278         LDLM_PLAIN_ENQUEUE,
 279         LDLM_EXTENT_ENQUEUE,
 280         LDLM_FLOCK_ENQUEUE,
 281         LDLM_IBITS_ENQUEUE,
 282         MDS_REINT_SETATTR,
 283         MDS_REINT_CREATE,
 284         MDS_REINT_LINK,
 285         MDS_REINT_UNLINK,
 286         MDS_REINT_RENAME,
 287         MDS_REINT_OPEN,
 288         BRW_READ_BYTES,
 289         BRW_WRITE_BYTES,
 290         EXTRA_LAST_OPC
 291 };
 292
 293 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
 294 /* class_obd.c */
 295 extern cfs_proc_dir_entry_t *proc_lustre_root;
 296
 297 struct obd_device;
 298 struct file;
 299 struct obd_histogram;
 300
 301 /* Days / hours / mins / seconds format */
 302 struct dhms {
 303         int d,h,m,s;
 304 };
 305 static inline void s2dhms(struct dhms *ts, time_t secs)
 306 {
 307         ts->d = secs / 86400;
 308         secs = secs % 86400;
 309         ts->h = secs / 3600;
 310         secs = secs % 3600;
 311         ts->m = secs / 60;
 312         ts->s = secs % 60;
 313 }
 314 #define DHMS_FMT "%dd%dh%02dm%02ds"
 315 #define DHMS_VARS(x) (x)->d, (x)->h, (x)->m, (x)->s
 316
 317
 318 #ifdef LPROCFS
 319
 320 static inline int lprocfs_stats_lock(struct lprocfs_stats *stats, int type)
 321 {
 322         int rc = 0;
 323
 324         if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) {
 325                 if (type & LPROCFS_GET_NUM_CPU)
 326                         rc = 1;
 327                 if (type & LPROCFS_GET_SMP_ID)
 328                         rc = 0;
 329                 spin_lock(&stats->ls_lock);
 330         } else {
 331                 if (type & LPROCFS_GET_NUM_CPU)
 332                         rc = num_possible_cpus();
 333                 if (type & LPROCFS_GET_SMP_ID) {
 334                         stats->ls_flags |= LPROCFS_STATS_GET_SMP_ID;
 335                         rc = cfs_get_cpu();
 336                 }
 337         }
 338         return rc;
 339 }
 340
 341 static inline void lprocfs_stats_unlock(struct lprocfs_stats *stats)
 342 {
 343         if (stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU)
 344                 spin_unlock(&stats->ls_lock);
 345         else if (stats->ls_flags & LPROCFS_STATS_GET_SMP_ID)
 346                 cfs_put_cpu();
 347 }
 348
 349 /* Two optimized LPROCFS counter increment functions are provided:
 350  *     lprocfs_counter_incr(cntr, value) - optimized for by-one counters
 351  *     lprocfs_counter_add(cntr) - use for multi-valued counters
 352  * Counter data layout allows config flag, counter lock and the
 353  * count itself to reside within a single cache line.
 354  */
 355
 356 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
 357                                 long amount);
 358 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
 359                                 long amount);
 360
 361 #define lprocfs_counter_incr(stats, idx) \
 362         lprocfs_counter_add(stats, idx, 1)
 363 #define lprocfs_counter_decr(stats, idx) \
 364         lprocfs_counter_sub(stats, idx, 1)
 365
 366 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
 367                                  enum lprocfs_fields_flags field);
 368
 369 static inline __u64 lprocfs_stats_collector(struct lprocfs_stats *stats,
 370                                             int idx,
 371                                             enum lprocfs_fields_flags field)
 372 {
 373         __u64 ret = 0;
 374         int i;
 375
 376         LASSERT(stats != NULL);
 377         for (i = 0; i < num_possible_cpus(); i++)
 378                 ret += lprocfs_read_helper(&(stats->ls_percpu[i]->lp_cntr[idx]),
 379                                            field);
 380         return ret;
 381 }
 382
 383 extern struct lprocfs_stats *lprocfs_alloc_stats(unsigned int num,
 384                                                  enum lprocfs_stats_flags flags);
 385 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
 386 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
 387 extern void lprocfs_init_ops_stats(int num_private_stats,
 388                                    struct lprocfs_stats *stats);
 389 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
 390 extern int lprocfs_alloc_obd_stats(struct obd_device *obddev,
 391                                    unsigned int num_private_stats);
 392 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
 393                                  unsigned conf, const char *name,
 394                                  const char *units);
 395 extern void lprocfs_free_obd_stats(struct obd_device *obddev);
 396 struct obd_export;
 397 extern int lprocfs_add_clear_entry(struct obd_device * obd,
 398                                    cfs_proc_dir_entry_t *entry);
 399 extern int lprocfs_exp_setup(struct obd_export *exp,
 400                              lnet_nid_t *peer_nid, int reconnect, int *newnid);
 401 extern int lprocfs_exp_cleanup(struct obd_export *exp);
 402 extern cfs_proc_dir_entry_t *lprocfs_add_simple(struct proc_dir_entry *root,
 403                                                 char *name,
 404                                                 read_proc_t *read_proc,
 405                                                 write_proc_t *write_proc,
 406                                                 void *data,
 407                                                 struct file_operations *fops);
 408 extern int lprocfs_register_stats(cfs_proc_dir_entry_t *root, const char *name,
 409                                   struct lprocfs_stats *stats);
 410
 411 /* lprocfs_status.c */
 412 extern int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
 413                             struct lprocfs_vars *var,
 414                             void *data);
 415
 416 extern cfs_proc_dir_entry_t *lprocfs_register(const char *name,
 417                                                cfs_proc_dir_entry_t *parent,
 418                                                struct lprocfs_vars *list,
 419                                                void *data);
 420
 421 extern void lprocfs_remove(cfs_proc_dir_entry_t **root);
 422
 423 extern cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *root,
 424                                            const char *name);
 425
 426 extern int lprocfs_obd_setup(struct obd_device *obd, struct lprocfs_vars *list);
 427 extern int lprocfs_obd_cleanup(struct obd_device *obd);
 428 struct nid_stat;
 429 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
 430 extern int lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
 431                                          unsigned long count, void *data);
 432 extern int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
 433                                         int count, int *eof,  void *data);
 434
 435
 436 extern struct file_operations lprocfs_evict_client_fops;
 437
 438 extern int lprocfs_seq_create(cfs_proc_dir_entry_t *parent, char *name,
 439                               mode_t mode, struct file_operations *seq_fops,
 440                               void *data);
 441 extern int lprocfs_obd_seq_create(struct obd_device *dev, char *name,
 442                                   mode_t mode, struct file_operations *seq_fops,
 443                                   void *data);
 444
 445 /* Generic callbacks */
 446
 447 extern int lprocfs_rd_u64(char *page, char **start, off_t off,
 448                           int count, int *eof, void *data);
 449 extern int lprocfs_rd_atomic(char *page, char **start, off_t off,
 450                              int count, int *eof, void *data);
 451 extern int lprocfs_wr_atomic(struct file *file, const char *buffer,
 452                              unsigned long count, void *data);
 453 extern int lprocfs_rd_uint(char *page, char **start, off_t off,
 454                            int count, int *eof, void *data);
 455 extern int lprocfs_wr_uint(struct file *file, const char *buffer,
 456                            unsigned long count, void *data);
 457 extern int lprocfs_rd_uuid(char *page, char **start, off_t off,
 458                            int count, int *eof, void *data);
 459 extern int lprocfs_rd_name(char *page, char **start, off_t off,
 460                            int count, int *eof, void *data);
 461 extern int lprocfs_rd_fstype(char *page, char **start, off_t off,
 462                              int count, int *eof, void *data);
 463 extern int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
 464                                   int count, int *eof, void *data);
 465 extern int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
 466                                 int count, int *eof, void *data);
 467 extern int lprocfs_rd_import(char *page, char **start, off_t off, int count,
 468                              int *eof, void *data);
 469 extern int lprocfs_rd_state(char *page, char **start, off_t off, int count,
 470                             int *eof, void *data);
 471 extern int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
 472                                     int count, int *eof, void *data);
 473 extern int lprocfs_rd_num_exports(char *page, char **start, off_t off,
 474                                   int count, int *eof, void *data);
 475 extern int lprocfs_rd_numrefs(char *page, char **start, off_t off,
 476                               int count, int *eof, void *data);
 477 struct adaptive_timeout;
 478 extern int lprocfs_at_hist_helper(char *page, int count, int rc,
 479                                   struct adaptive_timeout *at);
 480 extern int lprocfs_rd_timeouts(char *page, char **start, off_t off,
 481                                int count, int *eof, void *data);
 482 extern int lprocfs_wr_timeouts(struct file *file, const char *buffer,
 483                                unsigned long count, void *data);
 484 extern int lprocfs_wr_evict_client(struct file *file, const char *buffer,
 485                                    unsigned long count, void *data);
 486 extern int lprocfs_wr_ping(struct file *file, const char *buffer,
 487                            unsigned long count, void *data);
 488
 489 /* Statfs helpers */
 490 extern int lprocfs_rd_blksize(char *page, char **start, off_t off,
 491                               int count, int *eof, void *data);
 492 extern int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
 493                                   int count, int *eof, void *data);
 494 extern int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
 495                                  int count, int *eof, void *data);
 496 extern int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
 497                                  int count, int *eof, void *data);
 498 extern int lprocfs_rd_filestotal(char *page, char **start, off_t off,
 499                                  int count, int *eof, void *data);
 500 extern int lprocfs_rd_filesfree(char *page, char **start, off_t off,
 501                                 int count, int *eof, void *data);
 502 extern int lprocfs_rd_filegroups(char *page, char **start, off_t off,
 503                                  int count, int *eof, void *data);
 504
 505 extern int lprocfs_write_helper(const char *buffer, unsigned long count,
 506                                 int *val);
 507 extern int lprocfs_write_frac_helper(const char *buffer, unsigned long count,
 508                                      int *val, int mult);
 509 extern int lprocfs_read_frac_helper(char *buffer, unsigned long count,
 510                                     long val, int mult);
 511 extern int lprocfs_write_u64_helper(const char *buffer, unsigned long count,
 512                                     __u64 *val);
 513 extern int lprocfs_write_frac_u64_helper(const char *buffer, unsigned long count,
 514                                          __u64 *val, int mult);
 515 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
 516 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
 517 void lprocfs_oh_clear(struct obd_histogram *oh);
 518 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
 519
 520 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
 521                            struct lprocfs_counter *cnt);
 522
 523
 524 /* lprocfs_status.c: recovery status */
 525 int lprocfs_obd_rd_recovery_status(char *page, char **start, off_t off,
 526                                    int count, int *eof, void *data);
 527
 528 /* lprocfs_statuc.c: hash statistics */
 529 int lprocfs_obd_rd_hash(char *page, char **start, off_t off,
 530                         int count, int *eof, void *data);
 531
 532 extern int lprocfs_seq_release(struct inode *, struct file *);
 533
 534 /* in lprocfs_stat.c, to protect the private data for proc entries */
 535 extern struct rw_semaphore _lprocfs_lock;
 536
 537 /* to begin from 2.6.23, Linux defines self file_operations (proc_reg_file_ops)
 538  * in procfs, the proc file_operation defined by Lustre (lprocfs_generic_fops)
 539  * will be wrapped into the new defined proc_reg_file_ops, which instroduces
 540  * user count in proc_dir_entrey(pde_users) to protect the proc entry from
 541  * being deleted. then the protection lock (_lprocfs_lock) defined by Lustre
 542  * isn't necessary anymore for lprocfs_generic_fops(e.g. lprocfs_fops_read).
 543  * see bug19706 for detailed information.
 544  */
 545 #ifndef HAVE_PROCFS_USERS
 546
 547 #define LPROCFS_ENTRY()           do {  \
 548         down_read(&_lprocfs_lock);      \
 549 } while(0)
 550 #define LPROCFS_EXIT()            do {  \
 551         up_read(&_lprocfs_lock);        \
 552 } while(0)
 553
 554 #else
 555
 556 #define LPROCFS_ENTRY()
 557 #define LPROCFS_EXIT()
 558 #endif
 559
 560 #ifdef HAVE_PROCFS_DELETED
 561
 562 #ifdef HAVE_PROCFS_USERS
 563 #error proc_dir_entry->deleted is conflicted with proc_dir_entry->pde_users
 564 #endif
 565
 566 #define LPROCFS_ENTRY_AND_CHECK(dp) do {        \
 567         typecheck(struct proc_dir_entry *, dp); \
 568         LPROCFS_ENTRY();                        \
 569         if ((dp)->deleted) {                    \
 570                 LPROCFS_EXIT();                 \
 571                 return -ENODEV;                 \
 572         }                                       \
 573 } while(0)
 574 #define LPROCFS_CHECK_DELETED(dp) ((dp)->deleted)
 575
 576 #elif defined HAVE_PROCFS_USERS
 577
 578 #define LPROCFS_CHECK_DELETED(dp) ({            \
 579         int deleted = 0;                        \
 580         spin_lock(&(dp)->pde_unload_lock);      \
 581         if (dp->proc_fops == NULL)              \
 582                 deleted = 1;                    \
 583         spin_unlock(&(dp)->pde_unload_lock);    \
 584         deleted;                                \
 585 })
 586
 587 #define LPROCFS_ENTRY_AND_CHECK(dp) do {        \
 588         if (LPROCFS_CHECK_DELETED(dp))          \
 589                 return -ENODEV;                 \
 590 } while(0)
 591
 592 #else
 593
 594 #define LPROCFS_ENTRY_AND_CHECK(dp) \
 595         LPROCFS_ENTRY();
 596 #define LPROCFS_CHECK_DELETED(dp) (0)
 597 #endif
 598
 599 #define LPROCFS_SRCH_ENTRY()      do {  \
 600         down_read(&_lprocfs_lock);      \
 601 } while(0)
 602
 603 #define LPROCFS_SRCH_EXIT()       do {  \
 604         up_read(&_lprocfs_lock);        \
 605 } while(0)
 606
 607 #define LPROCFS_WRITE_ENTRY()     do {  \
 608         down_write(&_lprocfs_lock);     \
 609 } while(0)
 610 #define LPROCFS_WRITE_EXIT()      do {  \
 611         up_write(&_lprocfs_lock);       \
 612 } while(0)
 613
 614
 615 /* You must use these macros when you want to refer to
 616  * the import in a client obd_device for a lprocfs entry */
 617 #define LPROCFS_CLIMP_CHECK(obd) do {           \
 618         typecheck(struct obd_device *, obd);    \
 619         down_read(&(obd)->u.cli.cl_sem);        \
 620         if ((obd)->u.cli.cl_import == NULL) {   \
 621              up_read(&(obd)->u.cli.cl_sem);     \
 622              return -ENODEV;                    \
 623         }                                       \
 624 } while(0)
 625 #define LPROCFS_CLIMP_EXIT(obd)                 \
 626         up_read(&(obd)->u.cli.cl_sem);
 627
 628
 629 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
 630   proc entries; otherwise, you will define name##_seq_write function also for
 631   a read-write proc entry, and then call LPROC_SEQ_SEQ instead. Finally,
 632   call lprocfs_obd_seq_create(obd, filename, 0444, &name#_fops, data); */
 633 #define __LPROC_SEQ_FOPS(name, custom_seq_write)                           \
 634 static int name##_seq_open(struct inode *inode, struct file *file) {       \
 635         struct proc_dir_entry *dp = PDE(inode);                            \
 636         int rc;                                                            \
 637         LPROCFS_ENTRY_AND_CHECK(dp);                                       \
 638         rc = single_open(file, name##_seq_show, dp->data);                 \
 639         if (rc) {                                                          \
 640                 LPROCFS_EXIT();                                            \
 641                 return rc;                                                 \
 642         }                                                                  \
 643         return 0;                                                          \
 644 }                                                                          \
 645 struct file_operations name##_fops = {                                     \
 646         .owner   = THIS_MODULE,                                            \
 647         .open    = name##_seq_open,                                        \
 648         .read    = seq_read,                                               \
 649         .write   = custom_seq_write,                                       \
 650         .llseek  = seq_lseek,                                              \
 651         .release = lprocfs_seq_release,                                    \
 652 }
 653
 654 #define LPROC_SEQ_FOPS_RO(name)         __LPROC_SEQ_FOPS(name, NULL)
 655 #define LPROC_SEQ_FOPS(name)            __LPROC_SEQ_FOPS(name, name##_seq_write)
 656
 657 /* lproc_ptlrpc.c */
 658 struct ptlrpc_request;
 659 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
 660
 661 int lprocfs_obd_rd_recovery_time_soft(char *page, char **start, off_t off,
 662                                       int count, int *eof, void *data);
 663 int lprocfs_obd_wr_recovery_time_soft(struct file *file, const char *buffer,
 664                                       unsigned long count, void *data);
 665 int lprocfs_obd_rd_recovery_time_hard(char *page, char **start, off_t off,
 666                                       int count, int *eof, void *data);
 667 int lprocfs_obd_wr_recovery_time_hard(struct file *file, const char *buffer,
 668                                       unsigned long count, void *data);
 669
 670 #ifdef HAVE_DELAYED_RECOVERY
 671 int lprocfs_obd_rd_stale_export_age(char *page, char **start, off_t off,
 672                                     int count, int *eof, void *data);
 673 int lprocfs_obd_wr_stale_export_age(struct file *file, const char *buffer,
 674                                     unsigned long count, void *data);
 675 int lprocfs_obd_attach_stale_exports(struct obd_device *dev);
 676 int lprocfs_obd_wr_flush_stale_exports(struct file *file, const char *buffer,
 677                                        unsigned long count, void *data);
 678 #endif
 679 /* all quota proc functions */
 680 extern int lprocfs_quota_rd_bunit(char *page, char **start, off_t off, int count,
 681                                   int *eof, void *data);
 682 extern int lprocfs_quota_wr_bunit(struct file *file, const char *buffer,
 683                                   unsigned long count, void *data);
 684 extern int lprocfs_quota_rd_btune(char *page, char **start, off_t off, int count,
 685                                   int *eof, void *data);
 686 extern int lprocfs_quota_wr_btune(struct file *file, const char *buffer,
 687                                   unsigned long count, void *data);
 688 extern int lprocfs_quota_rd_iunit(char *page, char **start, off_t off, int count,
 689                                   int *eof, void *data);
 690 extern int lprocfs_quota_wr_iunit(struct file *file, const char *buffer,
 691                                   unsigned long count, void *data);
 692 extern int lprocfs_quota_rd_itune(char *page, char **start, off_t off, int count,
 693                                   int *eof, void *data);
 694 extern int lprocfs_quota_wr_itune(struct file *file, const char *buffer,
 695                                   unsigned long count, void *data);
 696 extern int lprocfs_quota_rd_type(char *page, char **start, off_t off, int count,
 697                                  int *eof, void *data);
 698 extern int lprocfs_quota_wr_type(struct file *file, const char *buffer,
 699                                  unsigned long count, void *data);
 700 extern int lprocfs_quota_rd_switch_seconds(char *page, char **start, off_t off,
 701                                            int count, int *eof, void *data);
 702 extern int lprocfs_quota_wr_switch_seconds(struct file *file, const char *buffer,
 703                                            unsigned long count, void *data);
 704 extern int lprocfs_quota_rd_sync_blk(char *page, char **start, off_t off,
 705                                      int count, int *eof, void *data);
 706 extern int lprocfs_quota_wr_sync_blk(struct file *file, const char *buffer,
 707                                      unsigned long count, void *data);
 708 extern int lprocfs_quota_rd_switch_qs(char *page, char **start, off_t off,
 709                                       int count, int *eof, void *data);
 710 extern int lprocfs_quota_wr_switch_qs(struct file *file, const char *buffer,
 711                                       unsigned long count, void *data);
 712 extern int lprocfs_quota_rd_boundary_factor(char *page, char **start, off_t off,
 713                                             int count, int *eof, void *data);
 714 extern int lprocfs_quota_wr_boundary_factor(struct file *file, const char *buffer,
 715                                             unsigned long count, void *data);
 716 extern int lprocfs_quota_rd_least_bunit(char *page, char **start, off_t off,
 717                                         int count, int *eof, void *data);
 718 extern int lprocfs_quota_wr_least_bunit(struct file *file, const char *buffer,
 719                                         unsigned long count, void *data);
 720 extern int lprocfs_quota_rd_least_iunit(char *page, char **start, off_t off,
 721                                         int count, int *eof, void *data);
 722 extern int lprocfs_quota_wr_least_iunit(struct file *file, const char *buffer,
 723                                         unsigned long count, void *data);
 724 extern int lprocfs_quota_rd_qs_factor(char *page, char **start, off_t off,
 725                                       int count, int *eof, void *data);
 726 extern int lprocfs_quota_wr_qs_factor(struct file *file, const char *buffer,
 727                                       unsigned long count, void *data);
 728
 729 #else
 730 /* LPROCFS is not defined */
 731 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
 732                                        int index, long amount) { return; }
 733 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
 734                                         int index) { return; }
 735 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
 736                                        int index, long amount) { return; }
 737 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
 738                                         int index, unsigned conf,
 739                                         const char *name, const char *units)
 740 { return; }
 741
 742 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
 743                                    enum lprocfs_fields_flags field)
 744 { return 0; }
 745
 746 static inline struct lprocfs_stats* lprocfs_alloc_stats(unsigned int num,
 747                                                         enum lprocfs_stats_flags flags)
 748 { return NULL; }
 749 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
 750 { return; }
 751 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
 752 { return; }
 753 static inline int lprocfs_register_stats(cfs_proc_dir_entry_t *root,
 754                                             const char *name,
 755                                             struct lprocfs_stats *stats)
 756 { return 0; }
 757 static inline void lprocfs_init_ops_stats(int num_private_stats,
 758                                           struct lprocfs_stats *stats)
 759 { return; }
 760 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
 761 { return; }
 762 static inline int lprocfs_alloc_obd_stats(struct obd_device *obddev,
 763                                           unsigned int num_private_stats)
 764 { return 0; }
 765 static inline void lprocfs_free_obd_stats(struct obd_device *obddev)
 766 { return; }
 767
 768 struct obd_export;
 769 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
 770 { return 0; }
 771 static inline int lprocfs_exp_setup(struct obd_export *exp, lnet_nid_t *peer_nid,
 772                                     int reconnect, int *newnid)
 773 { return 0; }
 774 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
 775 { return 0; }
 776 static inline cfs_proc_dir_entry_t *lprocfs_add_simple(struct proc_dir_entry *root,
 777                                                 char *name,
 778                                                 read_proc_t *read_proc,
 779                                                 write_proc_t *write_proc,
 780                                                 void *data,
 781                                                 struct file_operations *fops)
 782 {return 0; }
 783 struct nid_stat;
 784 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
 785 {}
 786 static inline
 787 int lprocfs_nid_stats_clear_write(struct file *file, const char *buffer,
 788                                   unsigned long count, void *data)
 789 {return count;}
 790 static inline
 791 int lprocfs_nid_stats_clear_read(char *page, char **start, off_t off,
 792                                  int count, int *eof,  void *data)
 793 {return count;}
 794
 795
 796 static inline cfs_proc_dir_entry_t *
 797 lprocfs_register(const char *name, cfs_proc_dir_entry_t *parent,
 798                  struct lprocfs_vars *list, void *data) { return NULL; }
 799 static inline int lprocfs_add_vars(cfs_proc_dir_entry_t *root,
 800                                    struct lprocfs_vars *var,
 801                                    void *data) { return 0; }
 802 static inline void lprocfs_remove(cfs_proc_dir_entry_t **root) {};
 803 static inline cfs_proc_dir_entry_t *lprocfs_srch(cfs_proc_dir_entry_t *head,
 804                                     const char *name) {return 0;}
 805 static inline int lprocfs_obd_setup(struct obd_device *dev,
 806                                     struct lprocfs_vars *list) { return 0; }
 807 static inline int lprocfs_obd_cleanup(struct obd_device *dev)  { return 0; }
 808 static inline int lprocfs_rd_u64(char *page, char **start, off_t off,
 809                                  int count, int *eof, void *data) { return 0; }
 810 static inline int lprocfs_rd_uuid(char *page, char **start, off_t off,
 811                                   int count, int *eof, void *data) { return 0; }
 812 static inline int lprocfs_rd_name(char *page, char **start, off_t off,
 813                                   int count, int *eof, void *data) { return 0; }
 814 static inline int lprocfs_rd_server_uuid(char *page, char **start, off_t off,
 815                                          int count, int *eof, void *data)
 816 { return 0; }
 817 static inline int lprocfs_rd_conn_uuid(char *page, char **start, off_t off,
 818                                        int count, int *eof, void *data)
 819 { return 0; }
 820 static inline int lprocfs_rd_import(char *page, char **start, off_t off,
 821                                     int count, int *eof, void *data)
 822 { return 0; }
 823 static inline int lprocfs_rd_state(char *page, char **start, off_t off,
 824                                    int count, int *eof, void *data)
 825 { return 0; }
 826 static inline int lprocfs_rd_connect_flags(char *page, char **start, off_t off,
 827                                            int count, int *eof, void *data)
 828 { return 0; }
 829 static inline int lprocfs_rd_num_exports(char *page, char **start, off_t off,
 830                                          int count, int *eof, void *data)
 831 { return 0; }
 832 static inline int lprocfs_rd_numrefs(char *page, char **start, off_t off,
 833                                      int count, int *eof, void *data)
 834 { return 0; }
 835 struct adaptive_timeout;
 836 static inline int lprocfs_at_hist_helper(char *page, int count, int rc,
 837                                          struct adaptive_timeout *at)
 838 { return 0; }
 839 static inline int lprocfs_rd_timeouts(char *page, char **start, off_t off,
 840                                       int count, int *eof, void *data)
 841 { return 0; }
 842 static inline int lprocfs_wr_timeouts(struct file *file, const char *buffer,
 843                                       unsigned long count, void *data)
 844 { return 0; }
 845 static inline int lprocfs_wr_evict_client(struct file *file, const char *buffer,
 846                                           unsigned long count, void *data)
 847 { return 0; }
 848 static inline int lprocfs_wr_ping(struct file *file, const char *buffer,
 849                                   unsigned long count, void *data)
 850 { return 0; }
 851 #ifdef HAVE_DELAYED_RECOVERY
 852 static inline
 853 int lprocfs_obd_rd_stale_export_age(char *page, char **start, off_t off,
 854                                     int count, int *eof, void *data)
 855 { return 0; }
 856 static inline
 857 int lprocfs_obd_wr_stale_export_age(struct file *file, const char *buffer,
 858                                     unsigned long count, void *data)
 859 { return 0; }
 860 static inline
 861 int lprocfs_obd_attach_stale_exports(struct obd_device *dev)
 862 { return 0; }
 863 static inline
 864 int lprocfs_obd_wr_flush_stale_exports(struct file *file, const char *buffer,
 865                                        unsigned long count, void *data)
 866 { return 0; }
 867 #endif
 868 /* Statfs helpers */
 869 static inline
 870 int lprocfs_rd_blksize(char *page, char **start, off_t off,
 871                        int count, int *eof, void *data) { return 0; }
 872 static inline
 873 int lprocfs_rd_kbytestotal(char *page, char **start, off_t off,
 874                            int count, int *eof, void *data) { return 0; }
 875 static inline
 876 int lprocfs_rd_kbytesfree(char *page, char **start, off_t off,
 877                           int count, int *eof, void *data) { return 0; }
 878 static inline
 879 int lprocfs_rd_kbytesavail(char *page, char **start, off_t off,
 880                            int count, int *eof, void *data) { return 0; }
 881 static inline
 882 int lprocfs_rd_filestotal(char *page, char **start, off_t off,
 883                           int count, int *eof, void *data) { return 0; }
 884 static inline
 885 int lprocfs_rd_filesfree(char *page, char **start, off_t off,
 886                          int count, int *eof, void *data)  { return 0; }
 887 static inline
 888 int lprocfs_rd_filegroups(char *page, char **start, off_t off,
 889                           int count, int *eof, void *data) { return 0; }
 890 static inline
 891 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value) {}
 892 static inline
 893 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value) {}
 894 static inline
 895 void lprocfs_oh_clear(struct obd_histogram *oh) {}
 896 static inline
 897 unsigned long lprocfs_oh_sum(struct obd_histogram *oh) { return 0; }
 898 static inline
 899 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
 900                            struct lprocfs_counter *cnt) {}
 901
 902 static inline
 903 __u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
 904                                enum lprocfs_fields_flags field)
 905 { return (__u64)0; }
 906
 907 #define LPROCFS_ENTRY()
 908 #define LPROCFS_EXIT()
 909 #define LPROCFS_ENTRY_AND_CHECK(dp)
 910 #define LPROC_SEQ_FOPS_RO(name)
 911 #define LPROC_SEQ_FOPS(name)
 912
 913 /* lproc_ptlrpc.c */
 914 #define target_print_req NULL
 915
 916 #endif /* LPROCFS */
 917
 918 #endif /* LPROCFS_SNMP_H */