lustre/fid/lproc_fid.c

   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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2013, Intel Corporation.
  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/fid/lproc_fid.c
  37  *
  38  * Lustre Sequence Manager
  39  *
  40  * Author: Yury Umanets <umka@clusterfs.com>
  41  */
  42
  43 #define DEBUG_SUBSYSTEM S_FID
  44
  45 #include <libcfs/libcfs.h>
  46 #include <linux/module.h>
  47 #include <obd.h>
  48 #include <obd_class.h>
  49 #include <obd_support.h>
  50 #include <lustre_fid.h>
  51 #include <lprocfs_status.h>
  52 #include "fid_internal.h"
  53 #include <md_object.h>
  54
  55 #ifdef LPROCFS
  56 /**
  57  * Reduce the SEQ range allocated to a node to a strict subset of the range
  58  * currently-allocated SEQ range.  If the specified range is "clear", then
  59  * drop all allocated sequences and request a new one from the master.
  60  *
  61  * Note: this function should only be used for testing, it is not necessarily
  62  * safe for production use.
  63  */
  64 static int
  65 lprocfs_fid_write_common(const char *buffer, unsigned long count,
  66                                 struct lu_seq_range *range)
  67 {
  68         struct lu_seq_range tmp = { 0, };
  69         int rc;
  70         ENTRY;
  71
  72         LASSERT(range != NULL);
  73
  74         if (count == 5 && strcmp(buffer, "clear") == 0) {
  75                 memset(range, 0, sizeof(*range));
  76                 RETURN(0);
  77         }
  78
  79         /* of the form "[0x0000000240000400 - 0x000000028000400]" */
  80         rc = sscanf(buffer, "[%llx - %llx]\n",
  81                     (long long unsigned *)&tmp.lsr_start,
  82                     (long long unsigned *)&tmp.lsr_end);
  83         if (!range_is_sane(&tmp) || range_is_zero(&tmp) ||
  84             tmp.lsr_start < range->lsr_start || tmp.lsr_end > range->lsr_end)
  85                 RETURN(-EINVAL);
  86         *range = tmp;
  87         RETURN(0);
  88 }
  89
  90 #ifdef HAVE_SERVER_SUPPORT
  91 /*
  92  * Server side procfs stuff.
  93  */
  94 static ssize_t
  95 lprocfs_server_fid_space_seq_write(struct file *file, const char *buffer,
  96                                         size_t count, loff_t *off)
  97 {
  98         struct lu_server_seq *seq = ((struct seq_file *)file->private_data)->private;
  99         int rc;
 100         ENTRY;
 101
 102         LASSERT(seq != NULL);
 103
 104         mutex_lock(&seq->lss_mutex);
 105         rc = lprocfs_fid_write_common(buffer, count, &seq->lss_space);
 106         if (rc == 0) {
 107                 CDEBUG(D_INFO, "%s: Space: "DRANGE"\n",
 108                         seq->lss_name, PRANGE(&seq->lss_space));
 109         }
 110         mutex_unlock(&seq->lss_mutex);
 111
 112         RETURN(count);
 113 }
 114
 115 static int
 116 lprocfs_server_fid_space_seq_show(struct seq_file *m, void *unused)
 117 {
 118         struct lu_server_seq *seq = (struct lu_server_seq *)m->private;
 119         int rc;
 120         ENTRY;
 121
 122         LASSERT(seq != NULL);
 123
 124         mutex_lock(&seq->lss_mutex);
 125         rc = seq_printf(m, "["LPX64" - "LPX64"]:%x:%s\n",
 126                         PRANGE(&seq->lss_space));
 127         mutex_unlock(&seq->lss_mutex);
 128
 129         RETURN(rc);
 130 }
 131
 132 static int
 133 lprocfs_server_fid_server_seq_show(struct seq_file *m, void *unused)
 134 {
 135         struct lu_server_seq *seq = (struct lu_server_seq *)m->private;
 136         struct client_obd *cli;
 137         int rc;
 138         ENTRY;
 139
 140         LASSERT(seq != NULL);
 141
 142         if (seq->lss_cli) {
 143                 if (seq->lss_cli->lcs_exp != NULL) {
 144                         cli = &seq->lss_cli->lcs_exp->exp_obd->u.cli;
 145                         rc = seq_printf(m, "%s\n", cli->cl_target_uuid.uuid);
 146                 } else {
 147                         rc = seq_printf(m, "%s\n",
 148                                         seq->lss_cli->lcs_srv->lss_name);
 149                 }
 150         } else {
 151                 rc = seq_printf(m, "<none>\n");
 152         }
 153
 154         RETURN(rc);
 155 }
 156
 157 static ssize_t
 158 lprocfs_server_fid_width_seq_write(struct file *file, const char *buffer,
 159                                         size_t count, loff_t *off)
 160 {
 161         struct lu_server_seq *seq = ((struct seq_file *)file->private_data)->private;
 162         int rc, val;
 163         ENTRY;
 164
 165         LASSERT(seq != NULL);
 166
 167         mutex_lock(&seq->lss_mutex);
 168
 169         rc = lprocfs_write_helper(buffer, count, &val);
 170         if (rc != 0) {
 171                 CERROR("%s: invalid width.\n", seq->lss_name);
 172                 GOTO(out_unlock, count = rc);
 173         }
 174
 175         seq->lss_width = val;
 176
 177         CDEBUG(D_INFO, "%s: Width: "LPU64"\n",
 178                seq->lss_name, seq->lss_width);
 179 out_unlock:
 180         mutex_unlock(&seq->lss_mutex);
 181
 182         RETURN(count);
 183 }
 184
 185 static int
 186 lprocfs_server_fid_width_seq_show(struct seq_file *m, void *unused)
 187 {
 188         struct lu_server_seq *seq = (struct lu_server_seq *)m->private;
 189         int rc;
 190         ENTRY;
 191
 192         LASSERT(seq != NULL);
 193
 194         mutex_lock(&seq->lss_mutex);
 195         rc = seq_printf(m, LPU64"\n", seq->lss_width);
 196         mutex_unlock(&seq->lss_mutex);
 197
 198         RETURN(rc);
 199 }
 200
 201 LPROC_SEQ_FOPS(lprocfs_server_fid_space);
 202 LPROC_SEQ_FOPS(lprocfs_server_fid_width);
 203 LPROC_SEQ_FOPS_RO(lprocfs_server_fid_server);
 204
 205 struct lprocfs_seq_vars seq_server_proc_list[] = {
 206         { "space",      &lprocfs_server_fid_space_fops },
 207         { "width",      &lprocfs_server_fid_width_fops },
 208         { "server",     &lprocfs_server_fid_server_fops },
 209         { NULL }
 210 };
 211
 212 struct fld_seq_param {
 213         struct lu_env           fsp_env;
 214         struct dt_it            *fsp_it;
 215         struct lu_server_fld    *fsp_fld;
 216         struct lu_server_seq    *fsp_seq;
 217         unsigned int            fsp_stop:1;
 218 };
 219
 220 /*
 221  * XXX: below is a copy of the functions in lustre/fld/lproc_fld.c.
 222  * we want to avoid this duplication either by exporting the
 223  * functions or merging fid and fld into a single module.
 224  */
 225 static void *fldb_seq_start(struct seq_file *p, loff_t *pos)
 226 {
 227         struct fld_seq_param    *param = p->private;
 228         struct lu_server_fld    *fld;
 229         struct dt_object        *obj;
 230         const struct dt_it_ops  *iops;
 231         struct dt_key           *key;
 232         int                     rc;
 233
 234         if (param == NULL || param->fsp_stop)
 235                 return NULL;
 236
 237         fld = param->fsp_fld;
 238         obj = fld->lsf_obj;
 239         LASSERT(obj != NULL);
 240         iops = &obj->do_index_ops->dio_it;
 241
 242         rc = iops->load(&param->fsp_env, param->fsp_it, *pos);
 243         if (rc <= 0)
 244                 return NULL;
 245
 246         key = iops->key(&param->fsp_env, param->fsp_it);
 247         if (IS_ERR(key))
 248                 return NULL;
 249
 250         *pos = be64_to_cpu(*(__u64 *)key);
 251
 252         return param;
 253 }
 254
 255 static void fldb_seq_stop(struct seq_file *p, void *v)
 256 {
 257         struct fld_seq_param    *param = p->private;
 258         const struct dt_it_ops  *iops;
 259         struct lu_server_fld    *fld;
 260         struct dt_object        *obj;
 261
 262         if (param == NULL)
 263                 return;
 264
 265         fld = param->fsp_fld;
 266         obj = fld->lsf_obj;
 267         LASSERT(obj != NULL);
 268         iops = &obj->do_index_ops->dio_it;
 269
 270         iops->put(&param->fsp_env, param->fsp_it);
 271 }
 272
 273 static void *fldb_seq_next(struct seq_file *p, void *v, loff_t *pos)
 274 {
 275         struct fld_seq_param    *param = p->private;
 276         struct lu_server_fld    *fld;
 277         struct dt_object        *obj;
 278         const struct dt_it_ops  *iops;
 279         int                     rc;
 280
 281         if (param == NULL || param->fsp_stop)
 282                 return NULL;
 283
 284         fld = param->fsp_fld;
 285         obj = fld->lsf_obj;
 286         LASSERT(obj != NULL);
 287         iops = &obj->do_index_ops->dio_it;
 288
 289         rc = iops->next(&param->fsp_env, param->fsp_it);
 290         if (rc > 0) {
 291                 param->fsp_stop = 1;
 292                 return NULL;
 293         }
 294
 295         *pos = be64_to_cpu(*(__u64 *)iops->key(&param->fsp_env, param->fsp_it));
 296         return param;
 297 }
 298
 299 static int fldb_seq_show(struct seq_file *p, void *v)
 300 {
 301         struct fld_seq_param    *param = p->private;
 302         struct lu_server_fld    *fld;
 303         struct dt_object        *obj;
 304         const struct dt_it_ops  *iops;
 305         struct lu_seq_range      fld_rec;
 306         int                     rc;
 307
 308         if (param == NULL || param->fsp_stop)
 309                 return 0;
 310
 311         fld = param->fsp_fld;
 312         obj = fld->lsf_obj;
 313         LASSERT(obj != NULL);
 314         iops = &obj->do_index_ops->dio_it;
 315
 316         rc = iops->rec(&param->fsp_env, param->fsp_it,
 317                        (struct dt_rec *)&fld_rec, 0);
 318         if (rc != 0) {
 319                 CERROR("%s: read record error: rc = %d\n",
 320                        fld->lsf_name, rc);
 321         } else if (fld_rec.lsr_start != 0) {
 322                 range_be_to_cpu(&fld_rec, &fld_rec);
 323                 rc = seq_printf(p, DRANGE"\n", PRANGE(&fld_rec));
 324         }
 325
 326         return rc;
 327 }
 328
 329 struct seq_operations fldb_sops = {
 330         .start = fldb_seq_start,
 331         .stop = fldb_seq_stop,
 332         .next = fldb_seq_next,
 333         .show = fldb_seq_show,
 334 };
 335
 336 static int fldb_seq_open(struct inode *inode, struct file *file)
 337 {
 338         struct seq_file         *seq;
 339         struct lu_server_seq    *ss = (struct lu_server_seq *) PDE_DATA(inode);
 340         struct lu_server_fld    *fld;
 341         struct dt_object        *obj;
 342         const struct dt_it_ops  *iops;
 343         struct fld_seq_param    *param = NULL;
 344         int                     env_init = 0;
 345         int                     rc;
 346
 347         fld = ss->lss_site->ss_server_fld;
 348         LASSERT(fld != NULL);
 349
 350         LPROCFS_ENTRY_CHECK(PDE(inode));
 351         rc = seq_open(file, &fldb_sops);
 352         if (rc)
 353                 return rc;
 354
 355         obj = fld->lsf_obj;
 356         if (obj == NULL) {
 357                 seq = file->private_data;
 358                 seq->private = NULL;
 359                 return 0;
 360         }
 361
 362         OBD_ALLOC_PTR(param);
 363         if (param == NULL)
 364                 GOTO(out, rc = -ENOMEM);
 365
 366         rc = lu_env_init(&param->fsp_env, LCT_MD_THREAD);
 367         if (rc != 0)
 368                 GOTO(out, rc);
 369
 370         env_init = 1;
 371         iops = &obj->do_index_ops->dio_it;
 372         param->fsp_it = iops->init(&param->fsp_env, obj, 0, NULL);
 373         if (IS_ERR(param->fsp_it))
 374                 GOTO(out, rc = PTR_ERR(param->fsp_it));
 375
 376         param->fsp_fld = fld;
 377         param->fsp_seq = ss;
 378         param->fsp_stop = 0;
 379
 380         seq = file->private_data;
 381         seq->private = param;
 382 out:
 383         if (rc != 0) {
 384                 if (env_init == 1)
 385                         lu_env_fini(&param->fsp_env);
 386                 if (param != NULL)
 387                         OBD_FREE_PTR(param);
 388         }
 389         return rc;
 390 }
 391
 392 static int fldb_seq_release(struct inode *inode, struct file *file)
 393 {
 394         struct seq_file         *seq = file->private_data;
 395         struct fld_seq_param    *param;
 396         struct lu_server_fld    *fld;
 397         struct dt_object        *obj;
 398         const struct dt_it_ops  *iops;
 399
 400         param = seq->private;
 401         if (param == NULL) {
 402                 lprocfs_seq_release(inode, file);
 403                 return 0;
 404         }
 405
 406         fld = param->fsp_fld;
 407         obj = fld->lsf_obj;
 408         LASSERT(obj != NULL);
 409         iops = &obj->do_index_ops->dio_it;
 410
 411         LASSERT(iops != NULL);
 412         LASSERT(param->fsp_it != NULL);
 413         iops->fini(&param->fsp_env, param->fsp_it);
 414         lu_env_fini(&param->fsp_env);
 415         OBD_FREE_PTR(param);
 416         lprocfs_seq_release(inode, file);
 417
 418         return 0;
 419 }
 420
 421 static ssize_t fldb_seq_write(struct file *file, const char *buf,
 422                               size_t len, loff_t *off)
 423 {
 424         struct seq_file         *seq = file->private_data;
 425         struct fld_seq_param    *param;
 426         struct lu_seq_range      range;
 427         int                      rc = 0;
 428         char                    *buffer, *_buffer;
 429         ENTRY;
 430
 431         param = seq->private;
 432         if (param == NULL)
 433                 RETURN(-EINVAL);
 434
 435         OBD_ALLOC(buffer, len + 1);
 436         if (buffer == NULL)
 437                 RETURN(-ENOMEM);
 438         memcpy(buffer, buf, len);
 439         buffer[len] = 0;
 440         _buffer = buffer;
 441
 442         /*
 443          * format - [0x0000000200000007-0x0000000200000008):0:mdt
 444          */
 445         if (*buffer != '[')
 446                 GOTO(out, rc = -EINVAL);
 447         buffer++;
 448
 449         range.lsr_start = simple_strtoull(buffer, &buffer, 0);
 450         if (*buffer != '-')
 451                 GOTO(out, rc = -EINVAL);
 452         buffer++;
 453
 454         range.lsr_end = simple_strtoull(buffer, &buffer, 0);
 455         if (*buffer != ')')
 456                 GOTO(out, rc = -EINVAL);
 457         buffer++;
 458         if (*buffer != ':')
 459                 GOTO(out, rc = -EINVAL);
 460         buffer++;
 461
 462         range.lsr_index = simple_strtoul(buffer, &buffer, 0);
 463         if (*buffer != ':')
 464                 GOTO(out, rc = -EINVAL);
 465         buffer++;
 466
 467         if (strncmp(buffer, "mdt", 3) == 0)
 468                 range.lsr_flags = LU_SEQ_RANGE_MDT;
 469         else if (strncmp(buffer, "ost", 3) == 0)
 470                 range.lsr_flags = LU_SEQ_RANGE_OST;
 471         else
 472                 GOTO(out, rc = -EINVAL);
 473
 474         rc = seq_server_alloc_spec(param->fsp_seq->lss_site->ss_control_seq,
 475                                    &range, &param->fsp_env);
 476
 477 out:
 478         OBD_FREE(_buffer, len + 1);
 479         RETURN(rc < 0 ? rc : len);
 480 }
 481
 482 const struct file_operations seq_fld_proc_seq_fops = {
 483         .owner   = THIS_MODULE,
 484         .open    = fldb_seq_open,
 485         .read    = seq_read,
 486         .write   = fldb_seq_write,
 487         .release = fldb_seq_release,
 488 };
 489
 490 #endif /* HAVE_SERVER_SUPPORT */
 491
 492 /* Client side procfs stuff */
 493 static ssize_t
 494 lprocfs_client_fid_space_seq_write(struct file *file, const char *buffer,
 495                                    size_t count, loff_t *off)
 496 {
 497         struct lu_client_seq *seq = ((struct seq_file *)file->private_data)->private;
 498         int rc;
 499         ENTRY;
 500
 501         LASSERT(seq != NULL);
 502
 503         mutex_lock(&seq->lcs_mutex);
 504         rc = lprocfs_fid_write_common(buffer, count, &seq->lcs_space);
 505         if (rc == 0) {
 506                 CDEBUG(D_INFO, "%s: Space: "DRANGE"\n",
 507                        seq->lcs_name, PRANGE(&seq->lcs_space));
 508         }
 509
 510         mutex_unlock(&seq->lcs_mutex);
 511
 512         RETURN(count);
 513 }
 514
 515 static int
 516 lprocfs_client_fid_space_seq_show(struct seq_file *m, void *unused)
 517 {
 518         struct lu_client_seq *seq = (struct lu_client_seq *)m->private;
 519         int rc;
 520         ENTRY;
 521
 522         LASSERT(seq != NULL);
 523
 524         mutex_lock(&seq->lcs_mutex);
 525         rc = seq_printf(m, "["LPX64" - "LPX64"]:%x:%s\n",
 526                         PRANGE(&seq->lcs_space));
 527         mutex_unlock(&seq->lcs_mutex);
 528
 529         RETURN(rc);
 530 }
 531
 532 static ssize_t
 533 lprocfs_client_fid_width_seq_write(struct file *file, const char *buffer,
 534                                    size_t count, loff_t *off)
 535 {
 536         struct lu_client_seq *seq = ((struct seq_file *)file->private_data)->private;
 537         __u64  max;
 538         int rc, val;
 539         ENTRY;
 540
 541         LASSERT(seq != NULL);
 542
 543         mutex_lock(&seq->lcs_mutex);
 544
 545         rc = lprocfs_write_helper(buffer, count, &val);
 546         if (rc) {
 547                 mutex_unlock(&seq->lcs_mutex);
 548                 RETURN(rc);
 549         }
 550
 551         if (seq->lcs_type == LUSTRE_SEQ_DATA)
 552                 max = LUSTRE_DATA_SEQ_MAX_WIDTH;
 553         else
 554                 max = LUSTRE_METADATA_SEQ_MAX_WIDTH;
 555
 556         if (val <= max && val > 0) {
 557                 seq->lcs_width = val;
 558
 559                 if (rc == 0) {
 560                         CDEBUG(D_INFO, "%s: Sequence size: "LPU64"\n",
 561                                seq->lcs_name, seq->lcs_width);
 562                 }
 563         }
 564         mutex_unlock(&seq->lcs_mutex);
 565
 566         RETURN(count);
 567 }
 568
 569 static int
 570 lprocfs_client_fid_width_seq_show(struct seq_file *m, void *unused)
 571 {
 572         struct lu_client_seq *seq = (struct lu_client_seq *)m->private;
 573         int rc;
 574         ENTRY;
 575
 576         LASSERT(seq != NULL);
 577
 578         mutex_lock(&seq->lcs_mutex);
 579         rc = seq_printf(m, LPU64"\n", seq->lcs_width);
 580         mutex_unlock(&seq->lcs_mutex);
 581
 582         RETURN(rc);
 583 }
 584
 585 static int
 586 lprocfs_client_fid_fid_seq_show(struct seq_file *m, void *unused)
 587 {
 588         struct lu_client_seq *seq = (struct lu_client_seq *)m->private;
 589         int rc;
 590         ENTRY;
 591
 592         LASSERT(seq != NULL);
 593
 594         mutex_lock(&seq->lcs_mutex);
 595         rc = seq_printf(m, DFID"\n", PFID(&seq->lcs_fid));
 596         mutex_unlock(&seq->lcs_mutex);
 597
 598         RETURN(rc);
 599 }
 600
 601 static int
 602 lprocfs_client_fid_server_seq_show(struct seq_file *m, void *unused)
 603 {
 604         struct lu_client_seq *seq = (struct lu_client_seq *)m->private;
 605         struct client_obd *cli;
 606         int rc;
 607         ENTRY;
 608
 609         LASSERT(seq != NULL);
 610
 611         if (seq->lcs_exp != NULL) {
 612                 cli = &seq->lcs_exp->exp_obd->u.cli;
 613                 rc = seq_printf(m, "%s\n", cli->cl_target_uuid.uuid);
 614         } else {
 615                 rc = seq_printf(m, "%s\n", seq->lcs_srv->lss_name);
 616         }
 617         RETURN(rc);
 618 }
 619
 620 LPROC_SEQ_FOPS(lprocfs_client_fid_space);
 621 LPROC_SEQ_FOPS(lprocfs_client_fid_width);
 622 LPROC_SEQ_FOPS_RO(lprocfs_client_fid_server);
 623 LPROC_SEQ_FOPS_RO(lprocfs_client_fid_fid);
 624
 625 struct lprocfs_seq_vars seq_client_proc_list[] = {
 626         { "space",      &lprocfs_client_fid_space_fops },
 627         { "width",      &lprocfs_client_fid_width_fops },
 628         { "server",     &lprocfs_client_fid_server_fops },
 629         { "fid",        &lprocfs_client_fid_fid_fops },
 630         { NULL }
 631 };
 632 #endif