lustre/mdd/mdd_lproc.c

   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  2008 Sun Microsystems, Inc. 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/mdd/mdd_lproc.c
  37  *
  38  * Lustre Metadata Server (mdd) routines
  39  *
  40  * Author: Wang Di <wangdi@clusterfs.com>
  41  */
  42
  43 #ifndef EXPORT_SYMTAB
  44 # define EXPORT_SYMTAB
  45 #endif
  46 #define DEBUG_SUBSYSTEM S_MDS
  47
  48 #include <linux/module.h>
  49 #include <linux/poll.h>
  50 #include <obd.h>
  51 #include <obd_class.h>
  52 #include <lustre_ver.h>
  53 #include <obd_support.h>
  54 #include <lprocfs_status.h>
  55 #include <lu_time.h>
  56 #include <lustre_log.h>
  57 #include <lustre/lustre_idl.h>
  58 #include <libcfs/libcfs_string.h>
  59
  60 #include "mdd_internal.h"
  61
  62 static const char *mdd_counter_names[LPROC_MDD_NR] = {
  63 };
  64
  65 int mdd_procfs_init(struct mdd_device *mdd, const char *name)
  66 {
  67         struct lprocfs_static_vars lvars;
  68         struct lu_device    *ld = &mdd->mdd_md_dev.md_lu_dev;
  69         struct obd_type     *type;
  70         int                  rc;
  71         ENTRY;
  72
  73         type = ld->ld_type->ldt_obd_type;
  74
  75         LASSERT(name != NULL);
  76         LASSERT(type != NULL);
  77
  78         /* Find the type procroot and add the proc entry for this device */
  79         lprocfs_mdd_init_vars(&lvars);
  80         mdd->mdd_proc_entry = lprocfs_register(name, type->typ_procroot,
  81                                                lvars.obd_vars, mdd);
  82         if (IS_ERR(mdd->mdd_proc_entry)) {
  83                 rc = PTR_ERR(mdd->mdd_proc_entry);
  84                 CERROR("Error %d setting up lprocfs for %s\n",
  85                        rc, name);
  86                 mdd->mdd_proc_entry = NULL;
  87                 GOTO(out, rc);
  88         }
  89
  90         rc = lu_time_init(&mdd->mdd_stats,
  91                           mdd->mdd_proc_entry,
  92                           mdd_counter_names, ARRAY_SIZE(mdd_counter_names));
  93
  94         EXIT;
  95 out:
  96         if (rc)
  97                mdd_procfs_fini(mdd);
  98         return rc;
  99 }
 100
 101 int mdd_procfs_fini(struct mdd_device *mdd)
 102 {
 103         if (mdd->mdd_stats)
 104                 lu_time_fini(&mdd->mdd_stats);
 105
 106         if (mdd->mdd_proc_entry) {
 107                  lprocfs_remove(&mdd->mdd_proc_entry);
 108                  mdd->mdd_proc_entry = NULL;
 109         }
 110         RETURN(0);
 111 }
 112
 113 void mdd_lprocfs_time_start(const struct lu_env *env)
 114 {
 115         lu_lprocfs_time_start(env);
 116 }
 117
 118 void mdd_lprocfs_time_end(const struct lu_env *env, struct mdd_device *mdd,
 119                           int idx)
 120 {
 121         lu_lprocfs_time_end(env, mdd->mdd_stats, idx);
 122 }
 123
 124 static int lprocfs_wr_atime_diff(struct file *file, const char *buffer,
 125                                  unsigned long count, void *data)
 126 {
 127         struct mdd_device *mdd = data;
 128         char kernbuf[20], *end;
 129         unsigned long diff = 0;
 130
 131         if (count > (sizeof(kernbuf) - 1))
 132                 return -EINVAL;
 133
 134         if (copy_from_user(kernbuf, buffer, count))
 135                 return -EFAULT;
 136
 137         kernbuf[count] = '\0';
 138
 139         diff = simple_strtoul(kernbuf, &end, 0);
 140         if (kernbuf == end)
 141                 return -EINVAL;
 142
 143         mdd->mdd_atime_diff = diff;
 144         return count;
 145 }
 146
 147 static int lprocfs_rd_atime_diff(char *page, char **start, off_t off,
 148                                  int count, int *eof, void *data)
 149 {
 150         struct mdd_device *mdd = data;
 151
 152         *eof = 1;
 153         return snprintf(page, count, "%lu\n", mdd->mdd_atime_diff);
 154 }
 155
 156
 157 /**** changelogs ****/
 158 static int lprocfs_rd_changelog_mask(char *page, char **start, off_t off,
 159                                      int count, int *eof, void *data)
 160 {
 161         struct mdd_device *mdd = data;
 162         int i = 0, rc = 0;
 163
 164         *eof = 1;
 165         while (i < CL_LAST) {
 166                 if (mdd->mdd_cl.mc_mask & (1 << i))
 167                         rc += snprintf(page + rc, count - rc, "%s ",
 168                                        changelog_type2str(i));
 169                 i++;
 170         }
 171         return rc;
 172 }
 173
 174 static int lprocfs_wr_changelog_mask(struct file *file, const char *buffer,
 175                                      unsigned long count, void *data)
 176 {
 177         struct mdd_device *mdd = data;
 178         char *kernbuf;
 179         int rc;
 180         ENTRY;
 181
 182         if (count >= CFS_PAGE_SIZE)
 183                 RETURN(-EINVAL);
 184         OBD_ALLOC(kernbuf, CFS_PAGE_SIZE);
 185         if (kernbuf == NULL)
 186                 RETURN(-ENOMEM);
 187         if (copy_from_user(kernbuf, buffer, count))
 188                 GOTO(out, rc = -EFAULT);
 189         kernbuf[count] = 0;
 190
 191         rc = libcfs_str2mask(kernbuf, changelog_type2str, &mdd->mdd_cl.mc_mask,
 192                              CHANGELOG_MINMASK, CHANGELOG_ALLMASK);
 193         if (rc == 0)
 194                 rc = count;
 195 out:
 196         OBD_FREE(kernbuf, CFS_PAGE_SIZE);
 197         return rc;
 198 }
 199
 200 struct cucb_data {
 201         char *page;
 202         int count;
 203         int idx;
 204 };
 205
 206 static int lprocfs_changelog_users_cb(struct llog_handle *llh,
 207                                       struct llog_rec_hdr *hdr, void *data)
 208 {
 209         struct llog_changelog_user_rec *rec;
 210         struct cucb_data *cucb = (struct cucb_data *)data;
 211
 212         LASSERT(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN);
 213
 214         rec = (struct llog_changelog_user_rec *)hdr;
 215
 216         cucb->idx += snprintf(cucb->page + cucb->idx, cucb->count - cucb->idx,
 217                               CHANGELOG_USER_PREFIX"%-3d "LPU64"\n",
 218                               rec->cur_id, rec->cur_endrec);
 219         if (cucb->idx >= cucb->count)
 220                 return -ENOSPC;
 221
 222         return 0;
 223 }
 224
 225 static int lprocfs_rd_changelog_users(char *page, char **start, off_t off,
 226                                       int count, int *eof, void *data)
 227 {
 228         struct mdd_device *mdd = data;
 229         struct llog_ctxt *ctxt;
 230         struct cucb_data cucb;
 231         __u64 cur;
 232
 233         *eof = 1;
 234
 235         ctxt = llog_get_context(mdd2obd_dev(mdd),LLOG_CHANGELOG_USER_ORIG_CTXT);
 236         if (ctxt == NULL)
 237                 return -ENXIO;
 238         LASSERT(ctxt->loc_handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT);
 239
 240         spin_lock(&mdd->mdd_cl.mc_lock);
 241         cur = mdd->mdd_cl.mc_index;
 242         spin_unlock(&mdd->mdd_cl.mc_lock);
 243
 244         cucb.count = count;
 245         cucb.page = page;
 246         cucb.idx = 0;
 247
 248         cucb.idx += snprintf(cucb.page + cucb.idx, cucb.count - cucb.idx,
 249                               "current index: "LPU64"\n", cur);
 250
 251         cucb.idx += snprintf(cucb.page + cucb.idx, cucb.count - cucb.idx,
 252                               "%-5s %s\n", "ID", "index");
 253
 254         llog_cat_process(ctxt->loc_handle, lprocfs_changelog_users_cb,
 255                          &cucb, 0, 0);
 256
 257         llog_ctxt_put(ctxt);
 258         return cucb.idx;
 259 }
 260
 261 /* non-seq version for direct calling by class_process_proc_param */
 262 static int mdd_changelog_write(struct file *file, const char *buffer,
 263                                unsigned long count, void *data)
 264 {
 265         struct mdd_device *mdd = (struct mdd_device *)data;
 266         char kernbuf[32];
 267         char *end;
 268         int rc;
 269
 270         if (count > (sizeof(kernbuf) - 1))
 271                 goto out_usage;
 272
 273         count = min_t(unsigned long, count, sizeof(kernbuf));
 274         if (copy_from_user(kernbuf, buffer, count))
 275                 return -EFAULT;
 276
 277         kernbuf[count] = '\0';
 278         /* strip trailing newline from "echo blah" */
 279         if (kernbuf[count - 1] == '\n')
 280                 kernbuf[count - 1] = '\0';
 281
 282         /* Forced on/off/purge rec, independent of changelog users! */
 283         if (strcmp(kernbuf, "on") == 0) {
 284                 rc = mdd_changelog_on(mdd, 1);
 285         } else if (strcmp(kernbuf, "off") == 0) {
 286                 rc = mdd_changelog_on(mdd, 0);
 287         } else {
 288                 /* purge to an index */
 289                 long long unsigned endrec;
 290
 291                 endrec = (long long)simple_strtoull(kernbuf, &end, 0);
 292                 if (end == kernbuf)
 293                         goto out_usage;
 294
 295                 LCONSOLE_INFO("changelog purge to %llu\n", endrec);
 296
 297                 rc = mdd_changelog_llog_cancel(mdd, endrec);
 298         }
 299
 300         if (rc < 0)
 301                 return rc;
 302         return count;
 303
 304 out_usage:
 305         CWARN("changelog write usage: [on|off] | <purge_idx (0=all)>\n");
 306         return -EINVAL;
 307 }
 308
 309 static ssize_t mdd_changelog_seq_write(struct file *file, const char *buffer,
 310                                        size_t count, loff_t *off)
 311 {
 312         struct seq_file *seq = file->private_data;
 313         struct changelog_seq_iter *csi = seq->private;
 314         struct mdd_device *mdd = (struct mdd_device *)csi->csi_dev;
 315
 316         return mdd_changelog_write(file, buffer, count, mdd);
 317 }
 318
 319 static int mdd_changelog_done(struct changelog_seq_iter *csi)
 320 {
 321         struct mdd_device *mdd = (struct mdd_device *)csi->csi_dev;
 322         int done = 0;
 323
 324         spin_lock(&mdd->mdd_cl.mc_lock);
 325         done = (csi->csi_endrec >= mdd->mdd_cl.mc_index);
 326         spin_unlock(&mdd->mdd_cl.mc_lock);
 327         return done;
 328 }
 329
 330 /* handle nonblocking */
 331 static ssize_t mdd_changelog_seq_read(struct file *file, char __user *buf,
 332                                       size_t count, loff_t *ppos)
 333 {
 334         struct seq_file *seq = (struct seq_file *)file->private_data;
 335         struct changelog_seq_iter *csi = seq->private;
 336         int rc;
 337         ENTRY;
 338
 339         if ((file->f_flags & O_NONBLOCK) && mdd_changelog_done(csi))
 340                 RETURN(-EAGAIN);
 341
 342         csi->csi_done = 0;
 343         rc = seq_read(file, buf, count, ppos);
 344         RETURN(rc);
 345 }
 346
 347 /* handle nonblocking */
 348 static unsigned int mdd_changelog_seq_poll(struct file *file, poll_table *wait)
 349 {
 350         struct seq_file *seq = (struct seq_file *)file->private_data;
 351         struct changelog_seq_iter *csi = seq->private;
 352         struct mdd_device *mdd = (struct mdd_device *)csi->csi_dev;
 353         ENTRY;
 354
 355         csi->csi_done = 0;
 356         poll_wait(file, &mdd->mdd_cl.mc_waitq, wait);
 357         if (!mdd_changelog_done(csi))
 358                 RETURN(POLLIN | POLLRDNORM);
 359
 360         RETURN(0);
 361 }
 362
 363 static int mdd_changelog_seq_open(struct inode *inode, struct file *file)
 364 {
 365         struct changelog_seq_iter *csi;
 366         struct obd_device *obd;
 367         int rc;
 368         ENTRY;
 369
 370         rc = changelog_seq_open(inode, file, &csi);
 371         if (rc)
 372                 RETURN(rc);
 373
 374         /* The proc file is set up with mdd in data, not obd */
 375         obd = mdd2obd_dev((struct mdd_device *)csi->csi_dev);
 376         csi->csi_ctxt = llog_get_context(obd, LLOG_CHANGELOG_ORIG_CTXT);
 377         if (csi->csi_ctxt == NULL) {
 378                 changelog_seq_release(inode, file);
 379                 RETURN(-ENOENT);
 380         }
 381         /* The handle is set up in llog_obd_origin_setup */
 382         csi->csi_llh = csi->csi_ctxt->loc_handle;
 383         RETURN(rc);
 384 }
 385
 386 static int mdd_changelog_seq_release(struct inode *inode, struct file *file)
 387 {
 388         struct seq_file *seq = file->private_data;
 389         struct changelog_seq_iter *csi = seq->private;
 390
 391         if (csi && csi->csi_ctxt)
 392                 llog_ctxt_put(csi->csi_ctxt);
 393
 394         return (changelog_seq_release(inode, file));
 395 }
 396
 397 /* mdd changelog proc can handle nonblocking ops and writing to purge recs */
 398 struct file_operations mdd_changelog_fops = {
 399         .owner   = THIS_MODULE,
 400         .open    = mdd_changelog_seq_open,
 401         .read    = mdd_changelog_seq_read,
 402         .write   = mdd_changelog_seq_write,
 403         .llseek  = changelog_seq_lseek,
 404         .poll    = mdd_changelog_seq_poll,
 405         .release = mdd_changelog_seq_release,
 406 };
 407
 408 #ifdef HAVE_QUOTA_SUPPORT
 409 static int mdd_lprocfs_quota_rd_type(char *page, char **start, off_t off,
 410                                      int count, int *eof, void *data)
 411 {
 412         struct mdd_device *mdd = data;
 413         return lprocfs_quota_rd_type(page, start, off, count, eof,
 414                                      mdd->mdd_obd_dev);
 415 }
 416
 417 static int mdd_lprocfs_quota_wr_type(struct file *file, const char *buffer,
 418                                      unsigned long count, void *data)
 419 {
 420         struct mdd_device *mdd = data;
 421         return lprocfs_quota_wr_type(file, buffer, count, mdd->mdd_obd_dev);
 422 }
 423 #endif
 424
 425 static int lprocfs_rd_sync_perm(char *page, char **start, off_t off,
 426                                 int count, int *eof, void *data)
 427 {
 428         struct mdd_device *mdd = data;
 429
 430         LASSERT(mdd != NULL);
 431         return snprintf(page, count, "%d\n", mdd->mdd_sync_permission);
 432 }
 433
 434 static int lprocfs_wr_sync_perm(struct file *file, const char *buffer,
 435                                 unsigned long count, void *data)
 436 {
 437         struct mdd_device *mdd = data;
 438         int val, rc;
 439
 440         LASSERT(mdd != NULL);
 441         rc = lprocfs_write_helper(buffer, count, &val);
 442         if (rc)
 443                 return rc;
 444
 445         mdd->mdd_sync_permission = !!val;
 446         return count;
 447 }
 448
 449 static struct lprocfs_vars lprocfs_mdd_obd_vars[] = {
 450         { "atime_diff",      lprocfs_rd_atime_diff, lprocfs_wr_atime_diff, 0 },
 451         { "changelog_mask",  lprocfs_rd_changelog_mask,
 452                              lprocfs_wr_changelog_mask, 0 },
 453         { "changelog_users", lprocfs_rd_changelog_users, 0, 0},
 454         { "changelog", 0, mdd_changelog_write, 0, &mdd_changelog_fops, 0600 },
 455 #ifdef HAVE_QUOTA_SUPPORT
 456         { "quota_type",      mdd_lprocfs_quota_rd_type,
 457                              mdd_lprocfs_quota_wr_type, 0 },
 458 #endif
 459         { "sync_permission", lprocfs_rd_sync_perm, lprocfs_wr_sync_perm, 0 },
 460         { 0 }
 461 };
 462
 463 static struct lprocfs_vars lprocfs_mdd_module_vars[] = {
 464         { "num_refs",   lprocfs_rd_numrefs, 0, 0 },
 465         { 0 }
 466 };
 467
 468 void lprocfs_mdd_init_vars(struct lprocfs_static_vars *lvars)
 469 {
 470         lvars->module_vars  = lprocfs_mdd_module_vars;
 471         lvars->obd_vars     = lprocfs_mdd_obd_vars;
 472 }
 473