lustre/include/lprocfs_status.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/include/lprocfs_status.h
  33  *
  34  * Top level header file for LProc
  35  *
  36  * Author: Hariharan Thantry thantry@users.sourceforge.net
  37  */
  38 #ifndef _LPROCFS_STATUS_H
  39 #define _LPROCFS_STATUS_H
  40
  41 #include <linux/fs.h>
  42 #include <linux/proc_fs.h>
  43 #include <linux/debugfs.h>
  44 #include <linux/rwsem.h>
  45 #include <linux/spinlock.h>
  46 #include <linux/seq_file.h>
  47
  48 #include <libcfs/libcfs.h>
  49 #include <lustre/lustre_idl.h>
  50
  51 struct lprocfs_vars {
  52         const char                      *name;
  53         const struct file_operations    *fops;
  54         void                            *data;
  55         /**
  56          * /proc file mode.
  57          */
  58         mode_t                           proc_mode;
  59 };
  60
  61 /* if we find more consumers this could be generalized */
  62 #define OBD_HIST_MAX 32
  63 struct obd_histogram {
  64         spinlock_t      oh_lock;
  65         unsigned long   oh_buckets[OBD_HIST_MAX];
  66 };
  67
  68 enum {
  69         BRW_R_PAGES = 0,
  70         BRW_W_PAGES,
  71         BRW_R_RPC_HIST,
  72         BRW_W_RPC_HIST,
  73         BRW_R_IO_TIME,
  74         BRW_W_IO_TIME,
  75         BRW_R_DISCONT_PAGES,
  76         BRW_W_DISCONT_PAGES,
  77         BRW_R_DISCONT_BLOCKS,
  78         BRW_W_DISCONT_BLOCKS,
  79         BRW_R_DISK_IOSIZE,
  80         BRW_W_DISK_IOSIZE,
  81         BRW_R_DIO_FRAGS,
  82         BRW_W_DIO_FRAGS,
  83         BRW_LAST,
  84 };
  85
  86 struct brw_stats {
  87         struct obd_histogram hist[BRW_LAST];
  88 };
  89
  90 enum {
  91         RENAME_SAMEDIR_SIZE = 0,
  92         RENAME_CROSSDIR_SRC_SIZE,
  93         RENAME_CROSSDIR_TGT_SIZE,
  94         RENAME_LAST,
  95 };
  96
  97 struct rename_stats {
  98         struct obd_histogram hist[RENAME_LAST];
  99 };
 100
 101 /* An lprocfs counter can be configured using the enum bit masks below.
 102  *
 103  * LPROCFS_CNTR_EXTERNALLOCK indicates that an external lock already
 104  * protects this counter from concurrent updates. If not specified,
 105  * lprocfs an internal per-counter lock variable. External locks are
 106  * not used to protect counter increments, but are used to protect
 107  * counter readout and resets.
 108  *
 109  * LPROCFS_CNTR_AVGMINMAX indicates a multi-valued counter samples,
 110  * (i.e. counter can be incremented by more than "1"). When specified,
 111  * the counter maintains min, max and sum in addition to a simple
 112  * invocation count. This allows averages to be be computed.
 113  * If not specified, the counter is an increment-by-1 counter.
 114  * min, max, sum, etc. are not maintained.
 115  *
 116  * LPROCFS_CNTR_STDDEV indicates that the counter should track sum of
 117  * squares (for multi-valued counter samples only). This allows
 118  * external computation of standard deviation, but involves a 64-bit
 119  * multiply per counter increment.
 120  */
 121
 122 enum {
 123         LPROCFS_CNTR_EXTERNALLOCK = 0x0001,
 124         LPROCFS_CNTR_AVGMINMAX    = 0x0002,
 125         LPROCFS_CNTR_STDDEV       = 0x0004,
 126
 127         /* counter data type */
 128         LPROCFS_TYPE_REGS         = 0x0100,
 129         LPROCFS_TYPE_BYTES        = 0x0200,
 130         LPROCFS_TYPE_PAGES        = 0x0400,
 131         LPROCFS_TYPE_CYCLE        = 0x0800,
 132 };
 133
 134 #define LC_MIN_INIT ((~(__u64)0) >> 1)
 135
 136 struct lprocfs_counter_header {
 137         unsigned int            lc_config;
 138         const char              *lc_name;   /* must be static */
 139         const char              *lc_units;  /* must be static */
 140 };
 141
 142 struct lprocfs_counter {
 143         __s64   lc_count;
 144         __s64   lc_min;
 145         __s64   lc_max;
 146         __s64   lc_sumsquare;
 147         /*
 148          * Every counter has lc_array_sum[0], while lc_array_sum[1] is only
 149          * for irq context counter, i.e. stats with
 150          * LPROCFS_STATS_FLAG_IRQ_SAFE flag, its counter need
 151          * lc_array_sum[1]
 152          */
 153         __s64   lc_array_sum[1];
 154 };
 155 #define lc_sum          lc_array_sum[0]
 156 #define lc_sum_irq      lc_array_sum[1]
 157
 158 struct lprocfs_percpu {
 159         struct lprocfs_counter lp_cntr[0];
 160 };
 161
 162 enum lprocfs_stats_lock_ops {
 163         LPROCFS_GET_NUM_CPU     = 0x0001, /* number allocated per-CPU stats */
 164         LPROCFS_GET_SMP_ID      = 0x0002, /* current stat to be updated */
 165 };
 166
 167 enum lprocfs_stats_flags {
 168         LPROCFS_STATS_FLAG_NONE     = 0x0000, /* per cpu counter */
 169         LPROCFS_STATS_FLAG_NOPERCPU = 0x0001, /* stats have no percpu
 170                                                * area and need locking */
 171         LPROCFS_STATS_FLAG_IRQ_SAFE = 0x0002, /* alloc need irq safe */
 172 };
 173
 174 enum lprocfs_fields_flags {
 175         LPROCFS_FIELDS_FLAGS_CONFIG     = 0x0001,
 176         LPROCFS_FIELDS_FLAGS_SUM        = 0x0002,
 177         LPROCFS_FIELDS_FLAGS_MIN        = 0x0003,
 178         LPROCFS_FIELDS_FLAGS_MAX        = 0x0004,
 179         LPROCFS_FIELDS_FLAGS_AVG        = 0x0005,
 180         LPROCFS_FIELDS_FLAGS_SUMSQUARE  = 0x0006,
 181         LPROCFS_FIELDS_FLAGS_COUNT      = 0x0007,
 182 };
 183
 184 struct lprocfs_stats {
 185         /* # of counters */
 186         unsigned short                  ls_num;
 187         /* 1 + the biggest cpu # whose ls_percpu slot has been allocated */
 188         unsigned short                  ls_biggest_alloc_num;
 189         enum lprocfs_stats_flags        ls_flags;
 190         /* Lock used when there are no percpu stats areas; For percpu stats,
 191          * it is used to protect ls_biggest_alloc_num change */
 192         spinlock_t                      ls_lock;
 193
 194         /* has ls_num of counter headers */
 195         struct lprocfs_counter_header   *ls_cnt_header;
 196         struct lprocfs_percpu           *ls_percpu[0];
 197 };
 198
 199 #define OPC_RANGE(seg) (seg ## _LAST_OPC - seg ## _FIRST_OPC)
 200
 201 /* Pack all opcodes down into a single monotonically increasing index */
 202 static inline int opcode_offset(__u32 opc) {
 203         if (opc < OST_LAST_OPC) {
 204                  /* OST opcode */
 205                 return (opc - OST_FIRST_OPC);
 206         } else if (opc < MDS_LAST_OPC) {
 207                 /* MDS opcode */
 208                 return (opc - MDS_FIRST_OPC +
 209                         OPC_RANGE(OST));
 210         } else if (opc < LDLM_LAST_OPC) {
 211                 /* LDLM Opcode */
 212                 return (opc - LDLM_FIRST_OPC +
 213                         OPC_RANGE(MDS) +
 214                         OPC_RANGE(OST));
 215         } else if (opc < MGS_LAST_OPC) {
 216                 /* MGS Opcode */
 217                 return (opc - MGS_FIRST_OPC +
 218                         OPC_RANGE(LDLM) +
 219                         OPC_RANGE(MDS) +
 220                         OPC_RANGE(OST));
 221         } else if (opc < OBD_LAST_OPC) {
 222                 /* OBD Ping */
 223                 return (opc - OBD_FIRST_OPC +
 224                         OPC_RANGE(MGS) +
 225                         OPC_RANGE(LDLM) +
 226                         OPC_RANGE(MDS) +
 227                         OPC_RANGE(OST));
 228         } else if (opc < LLOG_LAST_OPC) {
 229                 /* LLOG Opcode */
 230                 return (opc - LLOG_FIRST_OPC +
 231                         OPC_RANGE(OBD) +
 232                         OPC_RANGE(MGS) +
 233                         OPC_RANGE(LDLM) +
 234                         OPC_RANGE(MDS) +
 235                         OPC_RANGE(OST));
 236         } else if (opc < QUOTA_LAST_OPC) {
 237                 /* LQUOTA Opcode */
 238                 return (opc - QUOTA_FIRST_OPC +
 239                         OPC_RANGE(LLOG) +
 240                         OPC_RANGE(OBD) +
 241                         OPC_RANGE(MGS) +
 242                         OPC_RANGE(LDLM) +
 243                         OPC_RANGE(MDS) +
 244                         OPC_RANGE(OST));
 245         } else if (opc < SEQ_LAST_OPC) {
 246                 /* SEQ opcode */
 247                 return (opc - SEQ_FIRST_OPC +
 248                         OPC_RANGE(QUOTA) +
 249                         OPC_RANGE(LLOG) +
 250                         OPC_RANGE(OBD) +
 251                         OPC_RANGE(MGS) +
 252                         OPC_RANGE(LDLM) +
 253                         OPC_RANGE(MDS) +
 254                         OPC_RANGE(OST));
 255         } else if (opc < SEC_LAST_OPC) {
 256                 /* SEC opcode */
 257                 return (opc - SEC_FIRST_OPC +
 258                         OPC_RANGE(SEQ) +
 259                         OPC_RANGE(QUOTA) +
 260                         OPC_RANGE(LLOG) +
 261                         OPC_RANGE(OBD) +
 262                         OPC_RANGE(MGS) +
 263                         OPC_RANGE(LDLM) +
 264                         OPC_RANGE(MDS) +
 265                         OPC_RANGE(OST));
 266         } else if (opc < FLD_LAST_OPC) {
 267                 /* FLD opcode */
 268                  return (opc - FLD_FIRST_OPC +
 269                         OPC_RANGE(SEC) +
 270                         OPC_RANGE(SEQ) +
 271                         OPC_RANGE(QUOTA) +
 272                         OPC_RANGE(LLOG) +
 273                         OPC_RANGE(OBD) +
 274                         OPC_RANGE(MGS) +
 275                         OPC_RANGE(LDLM) +
 276                         OPC_RANGE(MDS) +
 277                         OPC_RANGE(OST));
 278         } else if (opc < OUT_UPDATE_LAST_OPC) {
 279                 /* update opcode */
 280                 return (opc - OUT_UPDATE_FIRST_OPC +
 281                         OPC_RANGE(FLD) +
 282                         OPC_RANGE(SEC) +
 283                         OPC_RANGE(SEQ) +
 284                         OPC_RANGE(QUOTA) +
 285                         OPC_RANGE(LLOG) +
 286                         OPC_RANGE(OBD) +
 287                         OPC_RANGE(MGS) +
 288                         OPC_RANGE(LDLM) +
 289                         OPC_RANGE(MDS) +
 290                         OPC_RANGE(OST));
 291         } else if (opc < LFSCK_LAST_OPC) {
 292                 /* LFSCK opcode */
 293                 return (opc - LFSCK_FIRST_OPC +
 294                         OPC_RANGE(OUT_UPDATE) +
 295                         OPC_RANGE(FLD) +
 296                         OPC_RANGE(SEC) +
 297                         OPC_RANGE(SEQ) +
 298                         OPC_RANGE(QUOTA) +
 299                         OPC_RANGE(LLOG) +
 300                         OPC_RANGE(OBD) +
 301                         OPC_RANGE(MGS) +
 302                         OPC_RANGE(LDLM) +
 303                         OPC_RANGE(MDS) +
 304                         OPC_RANGE(OST));
 305         } else {
 306                 /* Unknown Opcode */
 307                 return -1;
 308         }
 309 }
 310
 311
 312 #define LUSTRE_MAX_OPCODES (OPC_RANGE(OST)  + \
 313                             OPC_RANGE(MDS)  + \
 314                             OPC_RANGE(LDLM) + \
 315                             OPC_RANGE(MGS)  + \
 316                             OPC_RANGE(OBD)  + \
 317                             OPC_RANGE(LLOG) + \
 318                             OPC_RANGE(SEC)  + \
 319                             OPC_RANGE(SEQ)  + \
 320                             OPC_RANGE(SEC)  + \
 321                             OPC_RANGE(FLD)  + \
 322                             OPC_RANGE(OUT_UPDATE) + \
 323                             OPC_RANGE(LFSCK))
 324
 325 #define EXTRA_MAX_OPCODES ((PTLRPC_LAST_CNTR - PTLRPC_FIRST_CNTR)  + \
 326                             OPC_RANGE(EXTRA))
 327
 328 enum {
 329         PTLRPC_REQWAIT_CNTR = 0,
 330         PTLRPC_REQQDEPTH_CNTR,
 331         PTLRPC_REQACTIVE_CNTR,
 332         PTLRPC_TIMEOUT,
 333         PTLRPC_REQBUF_AVAIL_CNTR,
 334         PTLRPC_LAST_CNTR
 335 };
 336
 337 #define PTLRPC_FIRST_CNTR PTLRPC_REQWAIT_CNTR
 338
 339 enum lprocfs_extra_opc {
 340         LDLM_GLIMPSE_ENQUEUE = 0,
 341         LDLM_PLAIN_ENQUEUE,
 342         LDLM_EXTENT_ENQUEUE,
 343         LDLM_FLOCK_ENQUEUE,
 344         LDLM_IBITS_ENQUEUE,
 345         MDS_REINT_SETATTR,
 346         MDS_REINT_CREATE,
 347         MDS_REINT_LINK,
 348         MDS_REINT_UNLINK,
 349         MDS_REINT_RENAME,
 350         MDS_REINT_OPEN,
 351         MDS_REINT_SETXATTR,
 352         BRW_READ_BYTES,
 353         BRW_WRITE_BYTES,
 354         EXTRA_LAST_OPC
 355 };
 356
 357 #define EXTRA_FIRST_OPC LDLM_GLIMPSE_ENQUEUE
 358 /* class_obd.c */
 359 extern struct proc_dir_entry *proc_lustre_root;
 360 extern struct dentry *debugfs_lustre_root;
 361 extern struct kobject *lustre_kobj;
 362
 363 struct obd_device;
 364 struct obd_histogram;
 365
 366 #define JOBSTATS_JOBID_VAR_MAX_LEN      20
 367 #define JOBSTATS_DISABLE                "disable"
 368 #define JOBSTATS_PROCNAME_UID           "procname_uid"
 369 #define JOBSTATS_NODELOCAL              "nodelocal"
 370
 371 typedef void (*cntr_init_callback)(struct lprocfs_stats *stats);
 372
 373 struct obd_job_stats {
 374         struct cfs_hash        *ojs_hash;       /* hash of jobids */
 375         struct list_head        ojs_list;       /* list of job_stat structs */
 376         rwlock_t                ojs_lock;       /* protect ojs_list/js_list */
 377         unsigned int            ojs_cleanup_interval;/* seconds before expiry */
 378         time_t                  ojs_last_cleanup; /* previous cleanup time */
 379         cntr_init_callback      ojs_cntr_init_fn;/* lprocfs_stats initializer */
 380         unsigned short          ojs_cntr_num;   /* number of stats in struct */
 381         bool                    ojs_cleaning;   /* currently expiring stats */
 382 };
 383
 384 #ifdef CONFIG_PROC_FS
 385
 386 int lprocfs_stats_alloc_one(struct lprocfs_stats *stats,
 387                             unsigned int cpuid);
 388 int lprocfs_stats_lock(struct lprocfs_stats *stats,
 389                        enum lprocfs_stats_lock_ops opc,
 390                        unsigned long *flags);
 391 void lprocfs_stats_unlock(struct lprocfs_stats *stats,
 392                           enum lprocfs_stats_lock_ops opc,
 393                           unsigned long *flags);
 394
 395 static inline unsigned int
 396 lprocfs_stats_counter_size(struct lprocfs_stats *stats)
 397 {
 398         unsigned int percpusize;
 399
 400         percpusize = offsetof(struct lprocfs_percpu, lp_cntr[stats->ls_num]);
 401
 402         /* irq safe stats need lc_array_sum[1] */
 403         if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
 404                 percpusize += stats->ls_num * sizeof(__s64);
 405
 406         if ((stats->ls_flags & LPROCFS_STATS_FLAG_NOPERCPU) == 0)
 407                 percpusize = L1_CACHE_ALIGN(percpusize);
 408
 409         return percpusize;
 410 }
 411
 412 static inline struct lprocfs_counter *
 413 lprocfs_stats_counter_get(struct lprocfs_stats *stats, unsigned int cpuid,
 414                           int index)
 415 {
 416         struct lprocfs_counter *cntr;
 417
 418         cntr = &stats->ls_percpu[cpuid]->lp_cntr[index];
 419
 420         if ((stats->ls_flags & LPROCFS_STATS_FLAG_IRQ_SAFE) != 0)
 421                 cntr = (void *)cntr + index * sizeof(__s64);
 422
 423         return cntr;
 424 }
 425
 426 /* Two optimized LPROCFS counter increment functions are provided:
 427  *     lprocfs_counter_incr(cntr, value) - optimized for by-one counters
 428  *     lprocfs_counter_add(cntr) - use for multi-valued counters
 429  * Counter data layout allows config flag, counter lock and the
 430  * count itself to reside within a single cache line.
 431  */
 432
 433 extern void lprocfs_counter_add(struct lprocfs_stats *stats, int idx,
 434                                 long amount);
 435 extern void lprocfs_counter_sub(struct lprocfs_stats *stats, int idx,
 436                                 long amount);
 437
 438 #define lprocfs_counter_incr(stats, idx) \
 439         lprocfs_counter_add(stats, idx, 1)
 440 #define lprocfs_counter_decr(stats, idx) \
 441         lprocfs_counter_sub(stats, idx, 1)
 442
 443 extern __s64 lprocfs_read_helper(struct lprocfs_counter *lc,
 444                                  struct lprocfs_counter_header *header,
 445                                  enum lprocfs_stats_flags flags,
 446                                  enum lprocfs_fields_flags field);
 447 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
 448                             enum lprocfs_fields_flags field);
 449
 450 extern struct lprocfs_stats *
 451 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags);
 452 extern void lprocfs_clear_stats(struct lprocfs_stats *stats);
 453 extern void lprocfs_free_stats(struct lprocfs_stats **stats);
 454 extern void lprocfs_init_ops_stats(int num_private_stats,
 455                                    struct lprocfs_stats *stats);
 456 extern void lprocfs_init_mps_stats(int num_private_stats,
 457                                    struct lprocfs_stats *stats);
 458 extern void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats);
 459 extern int lprocfs_alloc_obd_stats(struct obd_device *obddev,
 460                                    unsigned int num_private_stats);
 461 extern int lprocfs_alloc_md_stats(struct obd_device *obddev,
 462                                   unsigned int num_private_stats);
 463 extern void lprocfs_counter_init(struct lprocfs_stats *stats, int index,
 464                                  unsigned conf, const char *name,
 465                                  const char *units);
 466 extern void lprocfs_free_obd_stats(struct obd_device *obddev);
 467 extern void lprocfs_free_md_stats(struct obd_device *obddev);
 468 struct obd_export;
 469 struct nid_stat;
 470 extern int lprocfs_add_clear_entry(struct obd_device * obd,
 471                                    struct proc_dir_entry *entry);
 472 #ifdef HAVE_SERVER_SUPPORT
 473 extern int lprocfs_exp_setup(struct obd_export *exp, lnet_nid_t *peer_nid);
 474 extern int lprocfs_exp_cleanup(struct obd_export *exp);
 475 #else
 476 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
 477 { return 0; }
 478 #endif
 479 extern struct proc_dir_entry *
 480 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
 481                    void *data, const struct file_operations *fops);
 482 extern struct proc_dir_entry *
 483 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
 484                     const char *format, ...);
 485 extern void lprocfs_free_per_client_stats(struct obd_device *obd);
 486 #ifdef HAVE_SERVER_SUPPORT
 487 extern ssize_t
 488 lprocfs_nid_stats_clear_seq_write(struct file *file, const char __user *buffer,
 489                                         size_t count, loff_t *off);
 490 extern int lprocfs_nid_stats_clear_seq_show(struct seq_file *file, void *data);
 491 #endif
 492 extern int ldebugfs_register_stats(struct dentry *parent, const char *name,
 493                                    struct lprocfs_stats *stats);
 494 extern int lprocfs_register_stats(struct proc_dir_entry *root, const char *name,
 495                                   struct lprocfs_stats *stats);
 496
 497 /* lprocfs_status.c */
 498 extern int ldebugfs_add_vars(struct dentry *parent, struct lprocfs_vars *var,
 499                              void *data);
 500 extern int lprocfs_add_vars(struct proc_dir_entry *root,
 501                             struct lprocfs_vars *var, void *data);
 502
 503 extern struct dentry *ldebugfs_register(const char *name,
 504                                         struct dentry *parent,
 505                                         struct lprocfs_vars *list,
 506                                         void *data);
 507 extern struct proc_dir_entry *
 508 lprocfs_register(const char *name, struct proc_dir_entry *parent,
 509                  struct lprocfs_vars *list, void *data);
 510
 511 extern void ldebugfs_remove(struct dentry **entryp);
 512 extern void lprocfs_remove(struct proc_dir_entry **root);
 513 extern void lprocfs_remove_proc_entry(const char *name,
 514                                       struct proc_dir_entry *parent);
 515 #ifndef HAVE_REMOVE_PROC_SUBTREE
 516 extern int remove_proc_subtree(const char *name,
 517                                struct proc_dir_entry *parent);
 518 #define PDE_DATA(inode)         (PDE(inode)->data)
 519
 520 static inline int LPROCFS_ENTRY_CHECK(struct inode *inode)
 521 {
 522         struct proc_dir_entry *dp = PDE(inode);
 523         int deleted = 0;
 524
 525         spin_lock(&(dp)->pde_unload_lock);
 526         if (dp->proc_fops == NULL)
 527                 deleted = 1;
 528         spin_unlock(&(dp)->pde_unload_lock);
 529         if (deleted)
 530                 return -ENODEV;
 531         return 0;
 532 }
 533 #else
 534 static inline int LPROCFS_ENTRY_CHECK(struct inode *inode)
 535 { return 0; }
 536 #endif
 537 extern int lprocfs_obd_setup(struct obd_device *dev);
 538 extern int lprocfs_obd_cleanup(struct obd_device *obd);
 539 #ifdef HAVE_SERVER_SUPPORT
 540 extern const struct file_operations lprocfs_evict_client_fops;
 541 #endif
 542
 543 extern int ldebugfs_seq_create(struct dentry *parent, const char *name,
 544                                umode_t mode,
 545                                const struct file_operations *seq_fops,
 546                                void *data);
 547 extern int lprocfs_seq_create(struct proc_dir_entry *parent, const char *name,
 548                               mode_t mode,
 549                               const struct file_operations *seq_fops,
 550                               void *data);
 551 extern int lprocfs_obd_seq_create(struct obd_device *dev, const char *name,
 552                                   mode_t mode,
 553                                   const struct file_operations *seq_fops,
 554                                   void *data);
 555
 556 /* Generic callbacks */
 557 extern int lprocfs_u64_seq_show(struct seq_file *m, void *data);
 558 extern int lprocfs_atomic_seq_show(struct seq_file *m, void *data);
 559 extern ssize_t lprocfs_atomic_seq_write(struct file *file,
 560                                         const char __user *buffer,
 561                                         size_t count, loff_t *off);
 562 extern int lprocfs_uint_seq_show(struct seq_file *m, void *data);
 563 extern ssize_t lprocfs_uint_seq_write(struct file *file,
 564                                       const char __user *buffer,
 565                                       size_t count, loff_t *off);
 566 extern int lprocfs_wr_uint(struct file *file, const char __user *buffer,
 567                            unsigned long count, void *data);
 568 extern int lprocfs_uuid_seq_show(struct seq_file *m, void *data);
 569 extern int lprocfs_name_seq_show(struct seq_file *m, void *data);
 570 extern int lprocfs_server_uuid_seq_show(struct seq_file *m, void *data);
 571 extern int lprocfs_conn_uuid_seq_show(struct seq_file *m, void *data);
 572 extern int lprocfs_import_seq_show(struct seq_file *m, void *data);
 573 extern int lprocfs_state_seq_show(struct seq_file *m, void *data);
 574 extern int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data);
 575 #ifdef HAVE_SERVER_SUPPORT
 576 extern int lprocfs_num_exports_seq_show(struct seq_file *m, void *data);
 577 #endif
 578 struct adaptive_timeout;
 579 extern int lprocfs_at_hist_helper(struct seq_file *m,
 580                                   struct adaptive_timeout *at);
 581 extern int lprocfs_timeouts_seq_show(struct seq_file *m, void *data);
 582 extern ssize_t
 583 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
 584                            size_t count, loff_t *off);
 585 #ifdef HAVE_SERVER_SUPPORT
 586 extern ssize_t
 587 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
 588                                 size_t count, loff_t *off);
 589 #endif
 590 extern ssize_t
 591 lprocfs_ping_seq_write(struct file *file, const char __user *buffer,
 592                        size_t count, loff_t *off);
 593 extern ssize_t
 594 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
 595                          size_t count, loff_t *off);
 596 extern int lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data);
 597 extern ssize_t
 598 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
 599                                size_t count, loff_t *off);
 600
 601 /* Statfs helpers */
 602 extern int lprocfs_blksize_seq_show(struct seq_file *m, void *data);
 603 extern int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data);
 604 extern int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data);
 605 extern int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data);
 606 extern int lprocfs_filestotal_seq_show(struct seq_file *m, void *data);
 607 extern int lprocfs_filesfree_seq_show(struct seq_file *m, void *data);
 608
 609 extern int lprocfs_seq_read_frac_helper(struct seq_file *m, long val, int mult);
 610 extern int lprocfs_read_frac_helper(char *buffer, unsigned long count,
 611                                     long val, int mult);
 612 extern int lprocfs_str_to_s64(const char __user *buffer, unsigned long count,
 613                               __s64 *val);
 614 extern int lprocfs_str_with_units_to_s64(const char __user *buffer,
 615                                          unsigned long count, __s64 *val,
 616                                          char defunit);
 617 char *lprocfs_find_named_value(const char *buffer, const char *name,
 618                                 size_t *count);
 619 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value);
 620 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value);
 621 void lprocfs_oh_clear(struct obd_histogram *oh);
 622 unsigned long lprocfs_oh_sum(struct obd_histogram *oh);
 623
 624 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
 625                            struct lprocfs_counter *cnt);
 626
 627 #ifdef HAVE_SERVER_SUPPORT
 628 /* lprocfs_status.c: recovery status */
 629 int lprocfs_recovery_status_seq_show(struct seq_file *m, void *data);
 630
 631 /* lprocfs_status.c: hash statistics */
 632 int lprocfs_hash_seq_show(struct seq_file *m, void *data);
 633
 634 /* lprocfs_status.c: IR factor */
 635 int lprocfs_ir_factor_seq_show(struct seq_file *m, void *data);
 636 ssize_t
 637 lprocfs_ir_factor_seq_write(struct file *file, const char __user *buffer,
 638                                 size_t count, loff_t *off);
 639 #endif
 640
 641 /* lprocfs_status.c: dump pages on cksum error */
 642 int lprocfs_checksum_dump_seq_show(struct seq_file *m, void *data);
 643 ssize_t
 644 lprocfs_checksum_dump_seq_write(struct file *file, const char __user *buffer,
 645                                 size_t count, loff_t *off);
 646
 647 extern int lprocfs_single_release(struct inode *, struct file *);
 648 extern int lprocfs_seq_release(struct inode *, struct file *);
 649
 650 /* You must use these macros when you want to refer to
 651  * the import in a client obd_device for a lprocfs entry */
 652 #define LPROCFS_CLIMP_CHECK(obd) do {           \
 653         typecheck(struct obd_device *, obd);    \
 654         down_read(&(obd)->u.cli.cl_sem);    \
 655         if ((obd)->u.cli.cl_import == NULL) {   \
 656              up_read(&(obd)->u.cli.cl_sem); \
 657              return -ENODEV;                    \
 658         }                                       \
 659 } while(0)
 660 #define LPROCFS_CLIMP_EXIT(obd)                 \
 661         up_read(&(obd)->u.cli.cl_sem);
 662
 663 /* write the name##_seq_show function, call LPROC_SEQ_FOPS_RO for read-only
 664   proc entries; otherwise, you will define name##_seq_write function also for
 665   a read-write proc entry, and then call LPROC_SEQ_SEQ instead. Finally,
 666   call lprocfs_obd_seq_create(obd, filename, 0444, &name#_fops, data); */
 667 #define __LPROC_SEQ_FOPS(name, custom_seq_write)                        \
 668 static int name##_single_open(struct inode *inode, struct file *file)   \
 669 {                                                                       \
 670         int rc;                                                         \
 671                                                                         \
 672         rc = LPROCFS_ENTRY_CHECK(inode);                                \
 673         if (rc < 0)                                                     \
 674                 return rc;                                              \
 675                                                                         \
 676         return single_open(file, name##_seq_show,                       \
 677                            inode->i_private ? : PDE_DATA(inode));       \
 678 }                                                                       \
 679 static const struct file_operations name##_fops = {                     \
 680         .owner   = THIS_MODULE,                                         \
 681         .open    = name##_single_open,                                  \
 682         .read    = seq_read,                                            \
 683         .write   = custom_seq_write,                                    \
 684         .llseek  = seq_lseek,                                           \
 685         .release = lprocfs_single_release,                              \
 686 }
 687
 688 #define LPROC_SEQ_FOPS_RO(name)         __LPROC_SEQ_FOPS(name, NULL)
 689 #define LPROC_SEQ_FOPS(name)            __LPROC_SEQ_FOPS(name, name##_seq_write)
 690
 691 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)                              \
 692         static int name##_##type##_seq_show(struct seq_file *m, void *v)\
 693         {                                                               \
 694                 return lprocfs_##type##_seq_show(m, m->private);        \
 695         }                                                               \
 696         LPROC_SEQ_FOPS_RO(name##_##type)
 697
 698 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)                              \
 699         static int name##_##type##_seq_show(struct seq_file *m, void *v)\
 700         {                                                               \
 701                 return lprocfs_##type##_seq_show(m, m->private);        \
 702         }                                                               \
 703         static ssize_t name##_##type##_seq_write(struct file *file,     \
 704                         const char __user *buffer, size_t count,        \
 705                         loff_t *off)                                    \
 706         {                                                               \
 707                 struct seq_file *seq = file->private_data;              \
 708                 return lprocfs_##type##_seq_write(file, buffer,         \
 709                                                 count, seq->private);   \
 710         }                                                               \
 711         LPROC_SEQ_FOPS(name##_##type);
 712
 713 #define LPROC_SEQ_FOPS_WO_TYPE(name, type)                              \
 714         static ssize_t name##_##type##_write(struct file *file,         \
 715                         const char __user *buffer, size_t count,        \
 716                         loff_t *off)                                    \
 717         {                                                               \
 718                 return lprocfs_##type##_seq_write(file, buffer, count, off);\
 719         }                                                               \
 720         static int name##_##type##_open(struct inode *inode, struct file *file)\
 721         {                                                               \
 722                 return single_open(file, NULL,                          \
 723                                    inode->i_private ? : PDE_DATA(inode));\
 724         }                                                               \
 725         static const struct file_operations name##_##type##_fops = {    \
 726                 .open    = name##_##type##_open,                        \
 727                 .write   = name##_##type##_write,                       \
 728                 .release = lprocfs_single_release,                      \
 729         };
 730
 731 struct lustre_attr {
 732         struct attribute attr;
 733         ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
 734                         char *buf);
 735         ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
 736                          const char *buf, size_t len);
 737 };
 738
 739 #define LUSTRE_ATTR(name, mode, show, store) \
 740 static struct lustre_attr lustre_attr_##name = __ATTR(name, mode, show, store)
 741
 742 #define LUSTRE_RO_ATTR(name) LUSTRE_ATTR(name, 0444, name##_show, NULL)
 743 #define LUSTRE_RW_ATTR(name) LUSTRE_ATTR(name, 0644, name##_show, name##_store)
 744
 745 ssize_t lustre_attr_show(struct kobject *kobj, struct attribute *attr,
 746                          char *buf);
 747 ssize_t lustre_attr_store(struct kobject *kobj, struct attribute *attr,
 748                           const char *buf, size_t len);
 749
 750 extern const struct sysfs_ops lustre_sysfs_ops;
 751
 752 /* lproc_ptlrpc.c */
 753 struct ptlrpc_request;
 754 extern void target_print_req(void *seq_file, struct ptlrpc_request *req);
 755
 756 #ifdef HAVE_SERVER_SUPPORT
 757 /* lprocfs_jobstats.c */
 758 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid,
 759                           int event, long amount);
 760 void lprocfs_job_stats_fini(struct obd_device *obd);
 761 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
 762                            cntr_init_callback fn);
 763 int lprocfs_job_interval_seq_show(struct seq_file *m, void *data);
 764 ssize_t
 765 lprocfs_job_interval_seq_write(struct file *file, const char __user *buffer,
 766                                 size_t count, loff_t *off);
 767 /* lproc_status.c */
 768 int lprocfs_recovery_time_soft_seq_show(struct seq_file *m, void *data);
 769 ssize_t lprocfs_recovery_time_soft_seq_write(struct file *file,
 770                                                 const char __user *buffer,
 771                                                 size_t count, loff_t *off);
 772 int lprocfs_recovery_time_hard_seq_show(struct seq_file *m, void *data);
 773 ssize_t
 774 lprocfs_recovery_time_hard_seq_write(struct file *file,
 775                                      const char __user *buffer,
 776                                      size_t count, loff_t *off);
 777 int lprocfs_target_instance_seq_show(struct seq_file *m, void *data);
 778 #endif
 779 int lprocfs_obd_max_pages_per_rpc_seq_show(struct seq_file *m, void *data);
 780 ssize_t lprocfs_obd_max_pages_per_rpc_seq_write(struct file *file,
 781                                                 const char __user *buffer,
 782                                                 size_t count, loff_t *off);
 783
 784 struct root_squash_info;
 785 int lprocfs_wr_root_squash(const char __user *buffer, unsigned long count,
 786                            struct root_squash_info *squash, char *name);
 787 int lprocfs_wr_nosquash_nids(const char __user *buffer, unsigned long count,
 788                              struct root_squash_info *squash, char *name);
 789
 790 #else /* !CONFIG_PROC_FS */
 791
 792 #define proc_lustre_root NULL
 793
 794 static inline void lprocfs_counter_add(struct lprocfs_stats *stats,
 795                                        int index, long amount)
 796 { return; }
 797 static inline void lprocfs_counter_incr(struct lprocfs_stats *stats,
 798                                         int index)
 799 { return; }
 800 static inline void lprocfs_counter_sub(struct lprocfs_stats *stats,
 801                                        int index, long amount)
 802 { return; }
 803 static inline void lprocfs_counter_decr(struct lprocfs_stats *stats,
 804                                         int index)
 805 { return; }
 806 static inline void lprocfs_counter_init(struct lprocfs_stats *stats,
 807                                         int index, unsigned conf,
 808                                         const char *name, const char *units)
 809 { return; }
 810
 811 static inline __u64 lc_read_helper(struct lprocfs_counter *lc,
 812                                    enum lprocfs_fields_flags field)
 813 { return 0; }
 814
 815 /* NB: we return !NULL to satisfy error checker */
 816 static inline struct lprocfs_stats *
 817 lprocfs_alloc_stats(unsigned int num, enum lprocfs_stats_flags flags)
 818 { return (struct lprocfs_stats *)1; }
 819 static inline void lprocfs_clear_stats(struct lprocfs_stats *stats)
 820 { return; }
 821 static inline void lprocfs_free_stats(struct lprocfs_stats **stats)
 822 { return; }
 823 static inline int lprocfs_register_stats(struct proc_dir_entry *root,
 824                                          const char *name,
 825                                          struct lprocfs_stats *stats)
 826 { return 0; }
 827 static inline void lprocfs_init_ops_stats(int num_private_stats,
 828                                           struct lprocfs_stats *stats)
 829 { return; }
 830 static inline void lprocfs_init_mps_stats(int num_private_stats,
 831                                           struct lprocfs_stats *stats)
 832 { return; }
 833 static inline void lprocfs_init_ldlm_stats(struct lprocfs_stats *ldlm_stats)
 834 { return; }
 835 static inline int lprocfs_alloc_obd_stats(struct obd_device *obddev,
 836                                           unsigned int num_private_stats)
 837 { return 0; }
 838 static inline int lprocfs_alloc_md_stats(struct obd_device *obddev,
 839                                          unsigned int num_private_stats)
 840 { return 0; }
 841 static inline void lprocfs_free_obd_stats(struct obd_device *obddev)
 842 { return; }
 843 static inline void lprocfs_free_md_stats(struct obd_device *obddev)
 844 { return; }
 845
 846 struct obd_export;
 847 static inline int lprocfs_add_clear_entry(struct obd_export *exp)
 848 { return 0; }
 849 static inline void lprocfs_free_per_client_stats(struct obd_device *obd)
 850 { return; }
 851 #ifdef HAVE_SERVER_SUPPORT
 852 static inline
 853 ssize_t lprocfs_nid_stats_seq_write(struct file *file,
 854                                     const char __user *buffer,
 855                                     size_t count, loff_t *off)
 856 {return 0;}
 857 static inline
 858 int lprocfs_nid_stats_clear_seq_show(struct seq_file *m, void *data)
 859 {return 0;}
 860 static inline int lprocfs_exp_setup(struct obd_export *exp,lnet_nid_t *peer_nid)
 861 { return 0; }
 862 #endif
 863 static inline int lprocfs_exp_cleanup(struct obd_export *exp)
 864 { return 0; }
 865 static inline struct proc_dir_entry *
 866 lprocfs_add_simple(struct proc_dir_entry *root, char *name,
 867                    void *data, const struct file_operations *fops)
 868 {return 0; }
 869 static inline struct proc_dir_entry *
 870 lprocfs_add_symlink(const char *name, struct proc_dir_entry *parent,
 871                     const char *format, ...)
 872 {return NULL; }
 873 static inline int lprocfs_add_vars(struct proc_dir_entry *root,
 874                                    struct lprocfs_vars *var, void *data)
 875 { return 0; }
 876 static inline struct proc_dir_entry *
 877 lprocfs_register(const char *name, struct proc_dir_entry *parent,
 878                  struct lprocfs_vars *list, void *data)
 879 { return NULL; }
 880 static inline void lprocfs_remove(struct proc_dir_entry **root)
 881 { return; }
 882 static inline void lprocfs_remove_proc_entry(const char *name,
 883                                              struct proc_dir_entry *parent)
 884 { return; }
 885 static inline int lprocfs_obd_setup(struct obd_device *dev)
 886 { return 0; }
 887 static inline int lprocfs_obd_cleanup(struct obd_device *dev)
 888 { return 0; }
 889 static inline int lprocfs_uuid_seq_show(struct seq_file *m, void *data)
 890 { return 0; }
 891 static inline int lprocfs_name_seq_show(struct seq_file *m, void *data)
 892 { return 0; }
 893 static inline int lprocfs_server_seq_show(struct seq_file *m, void *data)
 894 { return 0; }
 895 static inline int lprocfs_conn_uuid_seq_show(struct seq_file *m, void *data)
 896 { return 0; }
 897 static inline int lprocfs_import_seq_show(struct seq_file *m, void *data)
 898 { return 0; }
 899 static inline int lprocfs_state_seq_show(struct seq_file *m, void *data)
 900 { return 0; }
 901 static inline int lprocfs_connect_flags_seq_show(struct seq_file *m, void *data)
 902 { return 0; }
 903 #ifdef HAVE_SERVER_SUPPORT
 904 static inline int lprocfs_num_exports_seq_show(struct seq_file *m, void *data)
 905 { return 0; }
 906 #endif
 907 struct adaptive_timeout;
 908 static inline int lprocfs_at_hist_helper(struct seq_file *m,
 909                                          struct adaptive_timeout *at)
 910 { return 0; }
 911 static inline int lprocfs_timeouts_seq_show(struct seq_file *m, void *data)
 912 { return 0; }
 913 static inline ssize_t
 914 lprocfs_timeouts_seq_write(struct file *file, const char __user *buffer,
 915                            size_t count, loff_t *off)
 916 { return 0; }
 917 #ifdef HAVE_SERVER_SUPPORT
 918 static inline ssize_t
 919 lprocfs_evict_client_seq_write(struct file *file, const char __user *buffer,
 920                                size_t count, loff_t *off)
 921 { return 0; }
 922 #endif
 923 static inline ssize_t
 924 lprocfs_ping_seq_write(struct file *file, const char __user *buffer,
 925                        size_t count, loff_t *off)
 926 { return 0; }
 927 static inline ssize_t
 928 lprocfs_import_seq_write(struct file *file, const char __user *buffer,
 929                          size_t count, loff_t *off)
 930 { return 0; }
 931 static inline int
 932 lprocfs_pinger_recov_seq_show(struct seq_file *m, void *data)
 933 { return 0; }
 934 static inline ssize_t
 935 lprocfs_pinger_recov_seq_write(struct file *file, const char __user *buffer,
 936                                size_t count, loff_t *off)
 937 { return 0; }
 938
 939 /* Statfs helpers */
 940 static inline
 941 int lprocfs_blksize_seq_show(struct seq_file *m, void *data)
 942 { return 0; }
 943 static inline
 944 int lprocfs_kbytestotal_seq_show(struct seq_file *m, void *data)
 945 { return 0; }
 946 static inline
 947 int lprocfs_kbytesfree_seq_show(struct seq_file *m, void *data)
 948 { return 0; }
 949 static inline
 950 int lprocfs_kbytesavail_seq_show(struct seq_file *m, void *data)
 951 { return 0; }
 952 static inline
 953 int lprocfs_filestotal_seq_show(struct seq_file *m, void *data)
 954 { return 0; }
 955 static inline
 956 int lprocfs_filesfree_seq_show(struct seq_file *m, void *data)
 957 { return 0; }
 958 static inline
 959 void lprocfs_oh_tally(struct obd_histogram *oh, unsigned int value)
 960 { return; }
 961 static inline
 962 void lprocfs_oh_tally_log2(struct obd_histogram *oh, unsigned int value)
 963 { return; }
 964 static inline
 965 void lprocfs_oh_clear(struct obd_histogram *oh)
 966 { return; }
 967 static inline
 968 unsigned long lprocfs_oh_sum(struct obd_histogram *oh)
 969 { return 0; }
 970 static inline
 971 void lprocfs_stats_collect(struct lprocfs_stats *stats, int idx,
 972                            struct lprocfs_counter *cnt)
 973 { return; }
 974 static inline
 975 u64 lprocfs_stats_collector(struct lprocfs_stats *stats, int idx,
 976                             enum lprocfs_fields_flags field)
 977 { return (__u64)0; }
 978
 979 #define LPROC_SEQ_FOPS_RO(name)
 980 #define LPROC_SEQ_FOPS(name)
 981 #define LPROC_SEQ_FOPS_RO_TYPE(name, type)
 982 #define LPROC_SEQ_FOPS_RW_TYPE(name, type)
 983 #define LPROC_SEQ_FOPS_WO_TYPE(name, type)
 984
 985 /* lprocfs_jobstats.c */
 986 static inline
 987 int lprocfs_job_stats_log(struct obd_device *obd, char *jobid, int event,
 988                           long amount)
 989 { return 0; }
 990 static inline
 991 void lprocfs_job_stats_fini(struct obd_device *obd)
 992 { return; }
 993 static inline
 994 int lprocfs_job_stats_init(struct obd_device *obd, int cntr_num,
 995                            cntr_init_callback fn)
 996 { return 0; }
 997
 998
 999 /* lproc_ptlrpc.c */
1000 #define target_print_req NULL
1001
1002 #endif /* CONFIG_PROC_FS */
1003
1004 #endif /* LPROCFS_STATUS_H */