lustre/obdclass/llog_ioctl.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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  */
  31
  32 #define DEBUG_SUBSYSTEM S_LOG
  33
  34 #include <obd_class.h>
  35 #include <uapi/linux/lustre/lustre_ioctl.h>
  36 #include <lustre_log.h>
  37 #include "llog_internal.h"
  38
  39 static int str2logid(struct llog_logid *logid, char *str, int len)
  40 {
  41         unsigned long long id, seq;
  42         char *start, *end;
  43         u32 ogen;
  44         int rc;
  45
  46         ENTRY;
  47         start = str;
  48         if (start[0] == '[') {
  49                 struct lu_fid *fid = &logid->lgl_oi.oi_fid;
  50                 struct lu_fid sfid;
  51                 int num;
  52
  53                 fid_zero(fid);
  54                 logid->lgl_ogen = 0;
  55                 num = sscanf(start + 1, SFID, RFID(fid));
  56                 CDEBUG(D_INFO, DFID":%x\n", PFID(fid), logid->lgl_ogen);
  57                 logid_to_fid(logid, &sfid);
  58                 RETURN(num == 3 && fid_is_sane(&sfid) ? 0 : -EINVAL);
  59         }
  60
  61 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 1, 53, 0)
  62         /*
  63          * logids used to be input in the form "#id#seq:ogen" before they
  64          * were changed over to accept the FID [seq:oid:ver] format.
  65          * This is accepted for compatibility reasons, though I doubt
  66          * anyone is actually using this for anything.
  67          */
  68         if (start[0] != '#')
  69                 RETURN(-EINVAL);
  70
  71         start++;
  72         if (start - str >= len - 1)
  73                 RETURN(-EINVAL);
  74         end = strchr(start, '#');
  75         if (end == NULL || end == start)
  76                 RETURN(-EINVAL);
  77
  78         *end = '\0';
  79         rc = kstrtoull(start, 0, &id);
  80         if (rc)
  81                 RETURN(rc);
  82
  83         start = ++end;
  84         if (start - str >= len - 1)
  85                 RETURN(-EINVAL);
  86
  87         end = strchr(start, '#');
  88         if (!end || end == start)
  89                 RETURN(-EINVAL);
  90
  91         *end = '\0';
  92         rc = kstrtoull(start, 0, &seq);
  93         if (rc)
  94                 RETURN(rc);
  95
  96         ostid_set_seq(&logid->lgl_oi, seq);
  97         if (ostid_set_id(&logid->lgl_oi, id))
  98                 RETURN(-EINVAL);
  99
 100         start = ++end;
 101         if (start - str >= len - 1)
 102                 RETURN(-EINVAL);
 103
 104         rc = kstrtouint(start, 16, &ogen);
 105         if (rc)
 106                 RETURN(-EINVAL);
 107         logid->lgl_ogen = ogen;
 108
 109         RETURN(0);
 110 #else
 111         RETURN(-EINVAL);
 112 #endif
 113 }
 114
 115 static int llog_check_cb(const struct lu_env *env, struct llog_handle *handle,
 116                          struct llog_rec_hdr *rec, void *data)
 117 {
 118         struct obd_ioctl_data *ioc_data = data;
 119         static int l, remains;
 120         static long from, to;
 121         static char *out;
 122         int cur_index;
 123         int rc = 0;
 124
 125         ENTRY;
 126         if (ioc_data && ioc_data->ioc_inllen1 > 0) {
 127                 l = 0;
 128                 remains = ioc_data->ioc_inllen4 +
 129                           round_up(ioc_data->ioc_inllen1, 8) +
 130                           round_up(ioc_data->ioc_inllen2, 8) +
 131                           round_up(ioc_data->ioc_inllen3, 8);
 132
 133                 rc = kstrtol(ioc_data->ioc_inlbuf2, 0, &from);
 134                 if (rc)
 135                         RETURN(rc);
 136
 137                 rc = kstrtol(ioc_data->ioc_inlbuf3, 0, &to);
 138                 if (rc)
 139                         RETURN(rc);
 140
 141                 ioc_data->ioc_inllen1 = 0;
 142                 out = ioc_data->ioc_bulk;
 143         }
 144
 145         cur_index = rec->lrh_index;
 146         if (cur_index < from)
 147                 RETURN(0);
 148         if (to > 0 && cur_index > to)
 149                 RETURN(-LLOG_EEMPTY);
 150
 151         if (handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT) {
 152                 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
 153                 struct llog_handle *loghandle;
 154
 155                 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
 156                         l = snprintf(out, remains,
 157                                      "[index]: %05d  [type]: %02x  [len]: %04d failed\n",
 158                                      cur_index, rec->lrh_type,
 159                                      rec->lrh_len);
 160                 }
 161                 if (handle->lgh_ctxt == NULL)
 162                         RETURN(-EOPNOTSUPP);
 163                 rc = llog_cat_id2handle(env, handle, &loghandle, &lir->lid_id);
 164                 if (rc) {
 165                         CDEBUG(D_IOCTL, "cannot find log "DFID":%x\n",
 166                                PFID(&lir->lid_id.lgl_oi.oi_fid),
 167                                lir->lid_id.lgl_ogen);
 168                         RETURN(rc);
 169                 }
 170                 rc = llog_process(env, loghandle, llog_check_cb, NULL, NULL);
 171                 llog_handle_put(env, loghandle);
 172         } else {
 173                 bool ok;
 174
 175                 switch (rec->lrh_type) {
 176                 case OST_SZ_REC:
 177                 case MDS_UNLINK_REC:
 178                 case MDS_UNLINK64_REC:
 179                 case MDS_SETATTR64_REC:
 180                 case OBD_CFG_REC:
 181                 case LLOG_GEN_REC:
 182                 case LLOG_HDR_MAGIC:
 183                         ok = true;
 184                         break;
 185                 default:
 186                         ok = false;
 187                 }
 188
 189                 l = snprintf(out, remains, "[index]: %05d  [type]: "
 190                              "%02x  [len]: %04d %s\n",
 191                              cur_index, rec->lrh_type, rec->lrh_len,
 192                              ok ? "ok" : "failed");
 193                 out += l;
 194                 remains -= l;
 195                 if (remains <= 0) {
 196                         CERROR("%s: no space to print log records\n",
 197                                handle->lgh_ctxt->loc_obd->obd_name);
 198                         RETURN(-LLOG_EEMPTY);
 199                 }
 200         }
 201         RETURN(rc);
 202 }
 203
 204 struct llog_print_data {
 205         struct obd_ioctl_data *lprd_data;
 206         unsigned int           lprd_cfg_flags;
 207         bool                   lprd_raw;
 208 };
 209
 210 static int llog_print_cb(const struct lu_env *env, struct llog_handle *handle,
 211                          struct llog_rec_hdr *rec, void *data)
 212 {
 213         struct llog_print_data *lprd = data;
 214         struct obd_ioctl_data *ioc_data = lprd->lprd_data;
 215         static int l, remains;
 216         static long from, to;
 217         static char *out;
 218         int cur_index;
 219         int rc;
 220
 221         ENTRY;
 222         if (ioc_data && ioc_data->ioc_inllen1 > 0) {
 223                 l = 0;
 224                 remains = ioc_data->ioc_inllen4 +
 225                           round_up(ioc_data->ioc_inllen1, 8) +
 226                           round_up(ioc_data->ioc_inllen2, 8) +
 227                           round_up(ioc_data->ioc_inllen3, 8);
 228
 229                 rc = kstrtol(ioc_data->ioc_inlbuf2, 0, &from);
 230                 if (rc)
 231                         RETURN(rc);
 232
 233                 rc = kstrtol(ioc_data->ioc_inlbuf3, 0, &to);
 234                 if (rc)
 235                         RETURN(rc);
 236
 237                 out = ioc_data->ioc_bulk;
 238                 ioc_data->ioc_inllen1 = 0;
 239         }
 240
 241         cur_index = rec->lrh_index;
 242         if (cur_index < from)
 243                 RETURN(0);
 244         if (to > 0 && cur_index > to)
 245                 RETURN(-LLOG_EEMPTY);
 246
 247         if (handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT) {
 248                 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
 249
 250                 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
 251                         CERROR("invalid record in catalog\n");
 252                         RETURN(-EINVAL);
 253                 }
 254
 255                 l = snprintf(out, remains,
 256                              "[index]: %05d  [logid]: "DFID":%x\n",
 257                              cur_index, PFID(&lir->lid_id.lgl_oi.oi_fid),
 258                              lir->lid_id.lgl_ogen);
 259         } else if (rec->lrh_type == OBD_CFG_REC) {
 260                 int rc;
 261
 262                 rc = class_config_yaml_output(rec, out, remains,
 263                                               &lprd->lprd_cfg_flags,
 264                                               lprd->lprd_raw);
 265                 if (rc < 0)
 266                         RETURN(rc);
 267                 l = rc;
 268         } else {
 269                 l = snprintf(out, remains,
 270                              "[index]: %05d  [type]: %02x  [len]: %04d\n",
 271                              cur_index, rec->lrh_type, rec->lrh_len);
 272         }
 273         out += l;
 274         remains -= l;
 275         if (remains <= 0) {
 276                 CERROR("not enough space for print log records\n");
 277                 RETURN(-LLOG_EEMPTY);
 278         }
 279
 280         RETURN(0);
 281 }
 282 static int llog_remove_log(const struct lu_env *env, struct llog_handle *cat,
 283                            struct llog_logid *logid)
 284 {
 285         struct llog_handle *log;
 286         int rc;
 287
 288         ENTRY;
 289
 290         rc = llog_cat_id2handle(env, cat, &log, logid);
 291         if (rc) {
 292                 CDEBUG(D_IOCTL, "cannot find log "DFID":%x\n",
 293                        PFID(&logid->lgl_oi.oi_fid), logid->lgl_ogen);
 294                 RETURN(-ENOENT);
 295         }
 296
 297         rc = llog_destroy(env, log);
 298         if (rc) {
 299                 CDEBUG(D_IOCTL, "cannot destroy log "DFID":%x\n",
 300                        PFID(&logid->lgl_oi.oi_fid), logid->lgl_ogen);
 301                 GOTO(out, rc);
 302         }
 303         llog_cat_cleanup(env, cat, log, log->u.phd.phd_cookie.lgc_index);
 304 out:
 305         llog_handle_put(env, log);
 306         RETURN(rc);
 307
 308 }
 309
 310 static int llog_delete_cb(const struct lu_env *env, struct llog_handle *handle,
 311                           struct llog_rec_hdr *rec, void *data)
 312 {
 313         struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
 314         int rc;
 315
 316         ENTRY;
 317         if (rec->lrh_type != LLOG_LOGID_MAGIC)
 318                 RETURN(-EINVAL);
 319         rc = llog_remove_log(env, handle, &lir->lid_id);
 320
 321         RETURN(rc);
 322 }
 323
 324
 325 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
 326                struct obd_ioctl_data *data)
 327 {
 328         struct llog_logid logid;
 329         int rc = 0;
 330         struct llog_handle *handle = NULL;
 331         char *logname, start;
 332
 333         ENTRY;
 334
 335         logname = data->ioc_inlbuf1;
 336         start = logname[0];
 337         if (start == '#' || start == '[') {
 338                 rc = str2logid(&logid, logname, data->ioc_inllen1);
 339                 if (rc)
 340                         RETURN(rc);
 341                 rc = llog_open(env, ctxt, &handle, &logid, NULL,
 342                                LLOG_OPEN_EXISTS);
 343                 if (rc)
 344                         RETURN(rc);
 345         } else if (start == '$' || isalpha(start) || isdigit(start)) {
 346                 if (start == '$')
 347                         logname++;
 348
 349                 rc = llog_open(env, ctxt, &handle, NULL, logname,
 350                                LLOG_OPEN_EXISTS);
 351                 if (rc)
 352                         RETURN(rc);
 353         } else {
 354                 rc = -EINVAL;
 355                 CDEBUG(D_INFO, "%s: invalid log name '%s': rc = %d\n",
 356                       ctxt->loc_obd->obd_name, logname, rc);
 357                 RETURN(rc);
 358         }
 359
 360         rc = llog_init_handle(env, handle, 0, NULL);
 361         if (rc)
 362                 GOTO(out_close, rc = -ENOENT);
 363
 364         switch (cmd) {
 365         case OBD_IOC_LLOG_INFO: {
 366                 int l;
 367                 int remains = data->ioc_inllen2 +
 368                                    cfs_size_round(data->ioc_inllen1);
 369                 char *out = data->ioc_bulk;
 370
 371                 l = snprintf(out, remains,
 372                              "logid:            "DFID":%x\n"
 373                              "flags:            %x (%s)\n"
 374                              "records_count:    %d\n"
 375                              "last_index:       %d\n",
 376                              PFID(&handle->lgh_id.lgl_oi.oi_fid),
 377                              handle->lgh_id.lgl_ogen,
 378                              handle->lgh_hdr->llh_flags,
 379                              handle->lgh_hdr->llh_flags &
 380                                 LLOG_F_IS_CAT ? "cat" : "plain",
 381                              handle->lgh_hdr->llh_count,
 382                              handle->lgh_last_idx);
 383                 out += l;
 384                 remains -= l;
 385                 if (remains <= 0) {
 386                         CERROR("%s: not enough space for log header info\n",
 387                                ctxt->loc_obd->obd_name);
 388                         rc = -ENOSPC;
 389                 }
 390                 break;
 391         }
 392         case OBD_IOC_LLOG_CHECK:
 393                 LASSERT(data->ioc_inllen1 > 0);
 394                 rc = llog_process(env, handle, llog_check_cb, data, NULL);
 395                 if (rc == -LLOG_EEMPTY)
 396                         rc = 0;
 397                 else if (rc)
 398                         GOTO(out_close, rc);
 399                 break;
 400         case OBD_IOC_LLOG_PRINT: {
 401                 struct llog_print_data lprd = {
 402                         .lprd_data = data,
 403                         .lprd_raw = data->ioc_u32_1,
 404                 };
 405
 406                 LASSERT(data->ioc_inllen1 > 0);
 407                 rc = llog_process(env, handle, llog_print_cb, &lprd, NULL);
 408                 if (rc == -LLOG_EEMPTY)
 409                         rc = 0;
 410                 else if (rc)
 411                         GOTO(out_close, rc);
 412                 break;
 413         }
 414         case OBD_IOC_LLOG_CANCEL: {
 415                 struct llog_cookie cookie;
 416                 struct llog_logid plain;
 417                 u32 lgc_index;
 418
 419                 rc = kstrtouint(data->ioc_inlbuf3, 0, &lgc_index);
 420                 if (rc)
 421                         GOTO(out_close, rc);
 422                 cookie.lgc_index = lgc_index;
 423
 424                 if (handle->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN) {
 425                         rc = llog_cancel_rec(env, handle, cookie.lgc_index);
 426                         GOTO(out_close, rc);
 427                 } else if (!(handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT)) {
 428                         GOTO(out_close, rc = -EINVAL);
 429                 }
 430
 431                 if (data->ioc_inlbuf2 == NULL) /* catalog but no logid */
 432                         GOTO(out_close, rc = -ENOTTY);
 433
 434                 rc = str2logid(&plain, data->ioc_inlbuf2, data->ioc_inllen2);
 435                 if (rc)
 436                         GOTO(out_close, rc);
 437                 cookie.lgc_lgl = plain;
 438                 rc = llog_cat_cancel_records(env, handle, 1, &cookie);
 439                 if (rc)
 440                         GOTO(out_close, rc);
 441                 break;
 442         }
 443         case OBD_IOC_LLOG_REMOVE: {
 444                 struct llog_logid plain;
 445
 446                 if (handle->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN) {
 447                         rc = llog_destroy(env, handle);
 448                         GOTO(out_close, rc);
 449                 } else if (!(handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT)) {
 450                         GOTO(out_close, rc = -EINVAL);
 451                 }
 452
 453                 if (data->ioc_inlbuf2) {
 454                         /* remove indicate log from the catalog */
 455                         rc = str2logid(&plain, data->ioc_inlbuf2,
 456                                        data->ioc_inllen2);
 457                         if (rc)
 458                                 GOTO(out_close, rc);
 459                         rc = llog_remove_log(env, handle, &plain);
 460                 } else {
 461                         /* remove all the log of the catalog */
 462                         rc = llog_process(env, handle, llog_delete_cb, NULL,
 463                                           NULL);
 464                         if (rc)
 465                                 GOTO(out_close, rc);
 466                 }
 467                 break;
 468         }
 469         default:
 470                 CERROR("%s: Unknown ioctl cmd %#x\n",
 471                        ctxt->loc_obd->obd_name, cmd);
 472                 GOTO(out_close, rc = -ENOTTY);
 473         }
 474
 475 out_close:
 476         if (handle->lgh_hdr &&
 477             handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT)
 478                 llog_cat_close(env, handle);
 479         else
 480                 llog_close(env, handle);
 481         RETURN(rc);
 482 }
 483 EXPORT_SYMBOL(llog_ioctl);
 484
 485 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
 486                       int count, struct obd_ioctl_data *data,
 487                       const struct lu_fid *fid)
 488 {
 489         int size, i;
 490         struct llog_catid *idarray;
 491         struct llog_logid *id;
 492         char *out;
 493         int l, remains, rc = 0;
 494
 495         ENTRY;
 496
 497         if (count == 0) { /* get total number of logs */
 498                 rc = llog_osd_get_cat_list(env, d, 0, 0, NULL, fid);
 499                 if (rc < 0)
 500                         RETURN(rc);
 501                 count = rc;
 502         }
 503
 504         size = sizeof(*idarray) * count;
 505
 506         OBD_ALLOC_LARGE(idarray, size);
 507         if (!idarray)
 508                 RETURN(-ENOMEM);
 509
 510         rc = llog_osd_get_cat_list(env, d, 0, count, idarray, fid);
 511         if (rc)
 512                 GOTO(out, rc);
 513
 514         out = data->ioc_bulk;
 515         remains = data->ioc_inllen1;
 516         /* OBD_FAIL: fetch the catalog records from the specified one */
 517         if (OBD_FAIL_CHECK(OBD_FAIL_CATLIST))
 518                 data->ioc_count = cfs_fail_val - 1;
 519         for (i = data->ioc_count; i < count; i++) {
 520                 id = &idarray[i].lci_logid;
 521                 l = snprintf(out, remains, "catalog_log: "DFID":%x\n",
 522                               PFID(&id->lgl_oi.oi_fid), id->lgl_ogen);
 523                 out += l;
 524                 remains -= l;
 525                 if (remains <= 0) {
 526                         if (remains < 0) {
 527                                 /* the print is not complete */
 528                                 remains += l;
 529                                 data->ioc_bulk[out - data->ioc_bulk - l] = '\0';
 530                                 data->ioc_count = i;
 531                         } else {
 532                                 data->ioc_count = i++;
 533                         }
 534                         goto out;
 535                 }
 536         }
 537         data->ioc_count = 0;
 538 out:
 539         OBD_FREE_LARGE(idarray, size);
 540         RETURN(rc);
 541 }
 542 EXPORT_SYMBOL(llog_catalog_list);