1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/mdd/mdd_lproc.c
38 * Lustre Metadata Server (mdd) routines
40 * Author: Wang Di <wangdi@clusterfs.com>
44 # define EXPORT_SYMTAB
46 #define DEBUG_SUBSYSTEM S_MDS
48 #include <linux/module.h>
49 #include <linux/poll.h>
51 #include <obd_class.h>
52 #include <lustre_ver.h>
53 #include <obd_support.h>
54 #include <lprocfs_status.h>
56 #include <lustre_log.h>
57 #include <lustre/lustre_idl.h>
58 #include <libcfs/libcfs_string.h>
60 #include "mdd_internal.h"
62 static const char *mdd_counter_names[LPROC_MDD_NR] = {
65 int mdd_procfs_init(struct mdd_device *mdd, const char *name)
67 struct lprocfs_static_vars lvars;
68 struct lu_device *ld = &mdd->mdd_md_dev.md_lu_dev;
69 struct obd_type *type;
73 type = ld->ld_type->ldt_obd_type;
75 LASSERT(name != NULL);
76 LASSERT(type != NULL);
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,
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",
86 mdd->mdd_proc_entry = NULL;
90 rc = lu_time_init(&mdd->mdd_stats,
92 mdd_counter_names, ARRAY_SIZE(mdd_counter_names));
101 int mdd_procfs_fini(struct mdd_device *mdd)
104 lu_time_fini(&mdd->mdd_stats);
106 if (mdd->mdd_proc_entry) {
107 lprocfs_remove(&mdd->mdd_proc_entry);
108 mdd->mdd_proc_entry = NULL;
113 void mdd_lprocfs_time_start(const struct lu_env *env)
115 lu_lprocfs_time_start(env);
118 void mdd_lprocfs_time_end(const struct lu_env *env, struct mdd_device *mdd,
121 lu_lprocfs_time_end(env, mdd->mdd_stats, idx);
124 static int lprocfs_wr_atime_diff(struct file *file, const char *buffer,
125 unsigned long count, void *data)
127 struct mdd_device *mdd = data;
128 char kernbuf[20], *end;
129 unsigned long diff = 0;
131 if (count > (sizeof(kernbuf) - 1))
134 if (copy_from_user(kernbuf, buffer, count))
137 kernbuf[count] = '\0';
139 diff = simple_strtoul(kernbuf, &end, 0);
143 mdd->mdd_atime_diff = diff;
147 static int lprocfs_rd_atime_diff(char *page, char **start, off_t off,
148 int count, int *eof, void *data)
150 struct mdd_device *mdd = data;
153 return snprintf(page, count, "%lu\n", mdd->mdd_atime_diff);
157 /**** changelogs ****/
158 DECLARE_CHANGELOG_NAMES;
160 const char *changelog_bit2str(int bit)
163 return changelog_str[bit];
167 static int lprocfs_rd_changelog_mask(char *page, char **start, off_t off,
168 int count, int *eof, void *data)
170 struct mdd_device *mdd = data;
174 while (i < CL_LAST) {
175 if (mdd->mdd_cl.mc_mask & (1 << i))
176 rc += snprintf(page + rc, count - rc, "%s ",
183 static int lprocfs_wr_changelog_mask(struct file *file, const char *buffer,
184 unsigned long count, void *data)
186 struct mdd_device *mdd = data;
191 if (count >= CFS_PAGE_SIZE)
193 OBD_ALLOC(kernbuf, CFS_PAGE_SIZE);
196 if (copy_from_user(kernbuf, buffer, count))
197 GOTO(out, rc = -EFAULT);
200 rc = libcfs_str2mask(kernbuf, changelog_bit2str, &mdd->mdd_cl.mc_mask,
201 CHANGELOG_MINMASK, CHANGELOG_ALLMASK);
205 OBD_FREE(kernbuf, CFS_PAGE_SIZE);
215 static int lprocfs_changelog_users_cb(struct llog_handle *llh,
216 struct llog_rec_hdr *hdr, void *data)
218 struct llog_changelog_user_rec *rec;
219 struct cucb_data *cucb = (struct cucb_data *)data;
221 LASSERT(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN);
223 rec = (struct llog_changelog_user_rec *)hdr;
225 cucb->idx += snprintf(cucb->page + cucb->idx, cucb->count - cucb->idx,
226 CHANGELOG_USER_PREFIX"%-3d "LPU64"\n",
227 rec->cur_id, rec->cur_endrec);
228 if (cucb->idx >= cucb->count)
234 static int lprocfs_rd_changelog_users(char *page, char **start, off_t off,
235 int count, int *eof, void *data)
237 struct mdd_device *mdd = data;
238 struct llog_ctxt *ctxt;
239 struct cucb_data cucb;
244 ctxt = llog_get_context(mdd2obd_dev(mdd),LLOG_CHANGELOG_USER_ORIG_CTXT);
247 LASSERT(ctxt->loc_handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT);
249 spin_lock(&mdd->mdd_cl.mc_lock);
250 cur = mdd->mdd_cl.mc_index;
251 spin_unlock(&mdd->mdd_cl.mc_lock);
257 cucb.idx += snprintf(cucb.page + cucb.idx, cucb.count - cucb.idx,
258 "current index: "LPU64"\n", cur);
260 cucb.idx += snprintf(cucb.page + cucb.idx, cucb.count - cucb.idx,
261 "%-5s %s\n", "ID", "index");
263 llog_cat_process(ctxt->loc_handle, lprocfs_changelog_users_cb,
270 /* non-seq version for direct calling by class_process_proc_param */
271 static int mdd_changelog_write(struct file *file, const char *buffer,
272 unsigned long count, void *data)
274 struct mdd_device *mdd = (struct mdd_device *)data;
279 if (count > (sizeof(kernbuf) - 1))
282 count = min_t(unsigned long, count, sizeof(kernbuf));
283 if (copy_from_user(kernbuf, buffer, count))
286 kernbuf[count] = '\0';
287 /* strip trailing newline from "echo blah" */
288 if (kernbuf[count - 1] == '\n')
289 kernbuf[count - 1] = '\0';
291 /* Forced on/off/purge rec, independent of changelog users! */
292 if (strcmp(kernbuf, "on") == 0) {
293 rc = mdd_changelog_on(mdd, 1);
294 } else if (strcmp(kernbuf, "off") == 0) {
295 rc = mdd_changelog_on(mdd, 0);
297 /* purge to an index */
298 long long unsigned endrec;
300 endrec = (long long)simple_strtoull(kernbuf, &end, 0);
304 LCONSOLE_INFO("changelog purge to %llu\n", endrec);
306 rc = mdd_changelog_llog_cancel(mdd, endrec);
314 CWARN("changelog write usage: [on|off] | <purge_idx (0=all)>\n");
318 static ssize_t mdd_changelog_seq_write(struct file *file, const char *buffer,
319 size_t count, loff_t *off)
321 struct seq_file *seq = file->private_data;
322 struct changelog_seq_iter *csi = seq->private;
323 struct mdd_device *mdd = (struct mdd_device *)csi->csi_dev;
325 return mdd_changelog_write(file, buffer, count, mdd);
328 static int mdd_changelog_done(struct changelog_seq_iter *csi)
330 struct mdd_device *mdd = (struct mdd_device *)csi->csi_dev;
333 spin_lock(&mdd->mdd_cl.mc_lock);
334 done = (csi->csi_endrec >= mdd->mdd_cl.mc_index);
335 spin_unlock(&mdd->mdd_cl.mc_lock);
339 /* handle nonblocking */
340 static ssize_t mdd_changelog_seq_read(struct file *file, char __user *buf,
341 size_t count, loff_t *ppos)
343 struct seq_file *seq = (struct seq_file *)file->private_data;
344 struct changelog_seq_iter *csi = seq->private;
348 if ((file->f_flags & O_NONBLOCK) && mdd_changelog_done(csi))
352 rc = seq_read(file, buf, count, ppos);
356 /* handle nonblocking */
357 static unsigned int mdd_changelog_seq_poll(struct file *file, poll_table *wait)
359 struct seq_file *seq = (struct seq_file *)file->private_data;
360 struct changelog_seq_iter *csi = seq->private;
361 struct mdd_device *mdd = (struct mdd_device *)csi->csi_dev;
365 poll_wait(file, &mdd->mdd_cl.mc_waitq, wait);
366 if (!mdd_changelog_done(csi))
367 RETURN(POLLIN | POLLRDNORM);
372 static int mdd_changelog_seq_open(struct inode *inode, struct file *file)
374 struct changelog_seq_iter *csi;
375 struct obd_device *obd;
379 rc = changelog_seq_open(inode, file, &csi);
383 /* The proc file is set up with mdd in data, not obd */
384 obd = mdd2obd_dev((struct mdd_device *)csi->csi_dev);
385 csi->csi_ctxt = llog_get_context(obd, LLOG_CHANGELOG_ORIG_CTXT);
386 if (csi->csi_ctxt == NULL) {
387 changelog_seq_release(inode, file);
390 /* The handle is set up in llog_obd_origin_setup */
391 csi->csi_llh = csi->csi_ctxt->loc_handle;
395 static int mdd_changelog_seq_release(struct inode *inode, struct file *file)
397 struct seq_file *seq = file->private_data;
398 struct changelog_seq_iter *csi = seq->private;
400 if (csi && csi->csi_ctxt)
401 llog_ctxt_put(csi->csi_ctxt);
403 return (changelog_seq_release(inode, file));
406 /* mdd changelog proc can handle nonblocking ops and writing to purge recs */
407 struct file_operations mdd_changelog_fops = {
408 .owner = THIS_MODULE,
409 .open = mdd_changelog_seq_open,
410 .read = mdd_changelog_seq_read,
411 .write = mdd_changelog_seq_write,
412 .llseek = changelog_seq_lseek,
413 .poll = mdd_changelog_seq_poll,
414 .release = mdd_changelog_seq_release,
417 #ifdef HAVE_QUOTA_SUPPORT
418 static int mdd_lprocfs_quota_rd_type(char *page, char **start, off_t off,
419 int count, int *eof, void *data)
421 struct mdd_device *mdd = data;
422 return lprocfs_quota_rd_type(page, start, off, count, eof,
426 static int mdd_lprocfs_quota_wr_type(struct file *file, const char *buffer,
427 unsigned long count, void *data)
429 struct mdd_device *mdd = data;
430 return lprocfs_quota_wr_type(file, buffer, count, mdd->mdd_obd_dev);
434 static struct lprocfs_vars lprocfs_mdd_obd_vars[] = {
435 { "atime_diff", lprocfs_rd_atime_diff, lprocfs_wr_atime_diff, 0 },
436 { "changelog_mask", lprocfs_rd_changelog_mask,
437 lprocfs_wr_changelog_mask, 0 },
438 { "changelog_users", lprocfs_rd_changelog_users, 0, 0},
439 { "changelog", 0, mdd_changelog_write, 0, &mdd_changelog_fops, 0600 },
440 #ifdef HAVE_QUOTA_SUPPORT
441 { "quota_type", mdd_lprocfs_quota_rd_type,
442 mdd_lprocfs_quota_wr_type, 0 },
447 static struct lprocfs_vars lprocfs_mdd_module_vars[] = {
448 { "num_refs", lprocfs_rd_numrefs, 0, 0 },
452 void lprocfs_mdd_init_vars(struct lprocfs_static_vars *lvars)
454 lvars->module_vars = lprocfs_mdd_module_vars;
455 lvars->obd_vars = lprocfs_mdd_obd_vars;