lustre/include/lustre_log.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) 2012, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  *
  31  * lustre/include/lustre_log.h
  32  *
  33  * Generic infrastructure for managing a collection of logs.
  34  * These logs are used for:
  35  *
  36  * - orphan recovery: OST adds record on create
  37  * - mtime/size consistency: the OST adds a record on first write
  38  * - open/unlinked objects: OST adds a record on destroy
  39  *
  40  * - mds unlink log: the MDS adds an entry upon delete
  41  *
  42  * - raid1 replication log between OST's
  43  * - MDS replication logs
  44  */
  45
  46 #ifndef _LUSTRE_LOG_H
  47 #define _LUSTRE_LOG_H
  48
  49 /** \defgroup log log
  50  *
  51  * @{
  52  */
  53
  54 #include <obd_class.h>
  55 #include <dt_object.h>
  56 #include <uapi/linux/lustre/lustre_idl.h>
  57 #include <uapi/linux/lustre/lustre_log_user.h>
  58
  59 #define LOG_NAME_LIMIT(logname, name)                   \
  60         snprintf(logname, sizeof(logname), "LOGS/%s", name)
  61 #define LLOG_EEMPTY 4711
  62
  63 enum llog_open_param {
  64         LLOG_OPEN_EXISTS        = 0x0000,
  65         LLOG_OPEN_NEW           = 0x0001,
  66 };
  67
  68 struct plain_handle_data {
  69         struct list_head        phd_entry;
  70         struct llog_handle      *phd_cat_handle;
  71         /* cookie of this log in its cat */
  72         struct llog_cookie      phd_cookie;
  73 };
  74
  75 struct cat_handle_data {
  76         struct list_head        chd_head;
  77         struct llog_handle     *chd_current_log;/* currently open log */
  78         struct llog_handle     *chd_next_log;   /* llog to be used next */
  79 };
  80
  81 struct llog_handle;
  82
  83 /* llog.c  -  general API */
  84 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
  85                      int flags, struct obd_uuid *uuid);
  86 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
  87                       struct llog_rec_hdr *rec, void *data);
  88 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
  89                  llog_cb_t cb, void *data, void *catdata);
  90 int llog_process_or_fork(const struct lu_env *env,
  91                          struct llog_handle *loghandle,
  92                          llog_cb_t cb, void *data, void *catdata, bool fork);
  93 int llog_reverse_process(const struct lu_env *env,
  94                          struct llog_handle *loghandle, llog_cb_t cb,
  95                          void *data, void *catdata);
  96 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
  97                     int index);
  98 int llog_cancel_arr_rec(const struct lu_env *env, struct llog_handle *loghandle,
  99                     int num, int *index);
 100 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
 101               struct llog_handle **lgh, struct llog_logid *logid,
 102               char *name, enum llog_open_param open_param);
 103 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
 104 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
 105                   char *name);
 106 int llog_backup(const struct lu_env *env, struct obd_device *obd,
 107                 struct llog_ctxt *ctxt, struct llog_ctxt *bak_ctxt,
 108                 char *name, char *backup);
 109 int llog_read_header(const struct lu_env *env, struct llog_handle *handle,
 110                      const struct obd_uuid *uuid);
 111 __u64 llog_size(const struct lu_env *env, struct llog_handle *llh);
 112
 113 /* llog_process flags */
 114 #define LLOG_FLAG_NODEAMON 0x0001
 115
 116 /* llog_cat.c - catalog api */
 117 struct llog_process_data {
 118         /**
 119          * Any useful data needed while processing catalog. This is
 120          * passed later to process callback.
 121          */
 122         void                *lpd_data;
 123         /**
 124          * Catalog process callback function, called for each record
 125          * in catalog.
 126          */
 127         llog_cb_t            lpd_cb;
 128         /**
 129          * Start processing the catalog from startcat/startidx
 130          */
 131         int                  lpd_startcat;
 132         int                  lpd_startidx;
 133 };
 134
 135 struct llog_process_cat_data {
 136         /**
 137          * Temporary stored first_idx while scanning log.
 138          */
 139         int                  lpcd_first_idx;
 140         /**
 141          * Temporary stored last_idx while scanning log.
 142          */
 143         int                  lpcd_last_idx;
 144 };
 145
 146 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
 147 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
 148                      struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
 149                      struct thandle *th);
 150 int llog_cat_declare_add_rec(const struct lu_env *env,
 151                              struct llog_handle *cathandle,
 152                              struct llog_rec_hdr *rec, struct thandle *th);
 153 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
 154                  struct llog_rec_hdr *rec, struct llog_cookie *reccookie);
 155 int llog_cat_cancel_arr_rec(const struct lu_env *env,
 156                             struct llog_handle *cathandle,
 157                             struct llog_logid *lgl, int count, int *index);
 158 int llog_cat_cancel_records(const struct lu_env *env,
 159                             struct llog_handle *cathandle, int count,
 160                             struct llog_cookie *cookies);
 161 int llog_cat_process_or_fork(const struct lu_env *env,
 162                              struct llog_handle *cat_llh, llog_cb_t cat_cb,
 163                              llog_cb_t cb, void *data, int startcat,
 164                              int startidx, bool fork);
 165 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
 166                      llog_cb_t cb, void *data, int startcat, int startidx);
 167 __u64 llog_cat_size(const struct lu_env *env, struct llog_handle *cat_llh);
 168 __u32 llog_cat_free_space(struct llog_handle *cat_llh);
 169 int llog_cat_reverse_process(const struct lu_env *env,
 170                              struct llog_handle *cat_llh, llog_cb_t cb,
 171                              void *data);
 172 /* llog_obd.c */
 173 int llog_setup(const struct lu_env *env, struct obd_device *obd,
 174                struct obd_llog_group *olg, int index,
 175                struct obd_device *disk_obd, const struct llog_operations *op);
 176 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
 177 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
 178 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
 179
 180 /* llog_ioctl.c */
 181 struct obd_ioctl_data;
 182 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
 183                struct obd_ioctl_data *data);
 184 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
 185                       int count, struct obd_ioctl_data *data,
 186                       const struct lu_fid *fid);
 187
 188 /* llog_net.c */
 189 int llog_initiator_connect(struct llog_ctxt *ctxt);
 190
 191 struct llog_operations {
 192         int (*lop_declare_destroy)(const struct lu_env *env,
 193                            struct llog_handle *handle, struct thandle *th);
 194         int (*lop_destroy)(const struct lu_env *env,
 195                            struct llog_handle *handle, struct thandle *th);
 196         int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
 197                               int *curr_idx, int next_idx, __u64 *offset,
 198                               void *buf, int len);
 199         int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
 200                               int prev_idx, void *buf, int len);
 201         int (*lop_read_header)(const struct lu_env *env,
 202                                struct llog_handle *handle);
 203         int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
 204                          struct obd_llog_group *olg, int ctxt_idx,
 205                          struct obd_device *disk_obd);
 206         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
 207                         int flags);
 208         int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
 209         int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
 210                            struct llog_gen *gen, struct obd_uuid *uuid);
 211         /**
 212          * Any llog file must be opened first using llog_open().  Llog can be
 213          * opened by name, logid or without both, in last case the new logid
 214          * will be generated.
 215          */
 216         int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
 217                         struct llog_logid *logid, char *name,
 218                         enum llog_open_param);
 219         /**
 220          * Opened llog may not exist and this must be checked where needed using
 221          * the llog_exist() call.
 222          */
 223         int (*lop_exist)(struct llog_handle *lgh);
 224         /**
 225          * Close llog file and calls llog_free_handle() implicitly.
 226          * Any opened llog must be closed by llog_close() call.
 227          */
 228         int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
 229         /**
 230          * Create new llog file. The llog must be opened.
 231          * Must be used only for local llog operations.
 232          */
 233         int (*lop_declare_create)(const struct lu_env *env,
 234                                   struct llog_handle *handle,
 235                                   struct thandle *th);
 236         int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
 237                           struct thandle *th);
 238         /**
 239          * write new record in llog. It appends records usually but can edit
 240          * existing records too.
 241          */
 242         int (*lop_declare_write_rec)(const struct lu_env *env,
 243                                      struct llog_handle *lgh,
 244                                      struct llog_rec_hdr *rec,
 245                                      int idx, struct thandle *th);
 246         int (*lop_write_rec)(const struct lu_env *env,
 247                              struct llog_handle *loghandle,
 248                              struct llog_rec_hdr *rec,
 249                              struct llog_cookie *cookie,
 250                              int idx, struct thandle *th);
 251         /**
 252          * Add new record in llog catalog. Does the same as llog_write_rec()
 253          * but using llog catalog.
 254          */
 255         int (*lop_declare_add)(const struct lu_env *env,
 256                                struct llog_handle *lgh,
 257                                struct llog_rec_hdr *rec, struct thandle *th);
 258         int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
 259                        struct llog_rec_hdr *rec, struct llog_cookie *cookie,
 260                        struct thandle *th);
 261 };
 262
 263 /* In-memory descriptor for a log object or log catalog */
 264 struct llog_handle {
 265         struct rw_semaphore      lgh_lock;
 266         struct mutex             lgh_hdr_mutex; /* protect lgh_hdr data */
 267         struct llog_logid        lgh_id; /* id of this log */
 268         struct llog_log_hdr     *lgh_hdr; /* may be vmalloc'd */
 269         size_t                  lgh_hdr_size;
 270         struct dt_object        *lgh_obj;
 271         /* For a Catalog, is the last/newest used index for a plain slot.
 272          * Used in conjunction with llh_cat_idx to handle Catalog wrap-around
 273          * case, after it will have reached LLOG_HDR_BITMAP_SIZE, llh_cat_idx
 274          * will become its upper limit */
 275         int                      lgh_last_idx;
 276         struct rw_semaphore      lgh_last_sem;
 277         __u64                    lgh_cur_offset; /* used for test only */
 278         struct llog_ctxt        *lgh_ctxt;
 279         union {
 280                 struct plain_handle_data         phd;
 281                 struct cat_handle_data           chd;
 282         } u;
 283         char                    *lgh_name;
 284         void                    *private_data;
 285         const struct llog_operations    *lgh_logops;
 286         refcount_t               lgh_refcount;
 287
 288         int                     lgh_max_size;
 289         bool                    lgh_destroyed;
 290 };
 291
 292 /* llog_osd.c */
 293 extern const struct llog_operations llog_osd_ops;
 294 extern const struct llog_operations llog_common_cat_ops;
 295 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
 296                           int idx, int count, struct llog_catid *idarray,
 297                           const struct lu_fid *fid);
 298 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
 299                           int idx, int count, struct llog_catid *idarray,
 300                           const struct lu_fid *fid);
 301
 302 #define LLOG_CTXT_FLAG_UNINITIALIZED     0x00000001
 303 #define LLOG_CTXT_FLAG_STOP              0x00000002
 304
 305 /* Indicate the llog objects under this context are normal FID objects,
 306  * instead of objects with local FID. */
 307 #define LLOG_CTXT_FLAG_NORMAL_FID        0x00000004
 308
 309 struct llog_ctxt {
 310         int                      loc_idx; /* my index the obd array of ctxt's */
 311         struct obd_device       *loc_obd; /* points back to the containing obd*/
 312         struct obd_llog_group   *loc_olg; /* group containing that ctxt */
 313         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
 314         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
 315                                            * pointing import */
 316         const struct llog_operations  *loc_logops;
 317         struct llog_handle      *loc_handle;
 318         struct mutex             loc_mutex; /* protect loc_imp */
 319         atomic_t                 loc_refcount;
 320         long                     loc_flags; /* flags, see above defines */
 321         struct dt_object        *loc_dir;
 322         struct local_oid_storage *loc_los_nameless;
 323         struct local_oid_storage *loc_los_named;
 324         /* llog chunk size, and llog record size can not be bigger than
 325          * loc_chunk_size */
 326         __u32                    loc_chunk_size;
 327 };
 328
 329 #define LLOG_PROC_BREAK 0x0001
 330 #define LLOG_DEL_RECORD 0x0002
 331 #define LLOG_DEL_PLAIN  0x0003
 332
 333 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
 334                                const struct llog_operations **lop)
 335 {
 336         if (ctxt == NULL)
 337                 return -ENOTCONN;
 338
 339         *lop = ctxt->loc_logops;
 340         if (*lop == NULL)
 341                 return -EOPNOTSUPP;
 342
 343         return 0;
 344 }
 345
 346 static inline int llog_handle2ops(struct llog_handle *loghandle,
 347                                   const struct llog_operations **lop)
 348 {
 349         if (loghandle == NULL || loghandle->lgh_logops == NULL)
 350                 return -EINVAL;
 351
 352         *lop = loghandle->lgh_logops;
 353         return 0;
 354 }
 355
 356 static inline int llog_data_len(int len)
 357 {
 358         return cfs_size_round(len);
 359 }
 360
 361 static inline int llog_get_size(struct llog_handle *loghandle)
 362 {
 363         if (loghandle && loghandle->lgh_hdr)
 364                 return loghandle->lgh_hdr->llh_count;
 365         return 0;
 366 }
 367
 368 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
 369 {
 370         atomic_inc(&ctxt->loc_refcount);
 371         CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
 372                atomic_read(&ctxt->loc_refcount));
 373         return ctxt;
 374 }
 375
 376 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
 377 {
 378         if (ctxt == NULL)
 379                 return;
 380         LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
 381         CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
 382                atomic_read(&ctxt->loc_refcount) - 1);
 383         __llog_ctxt_put(NULL, ctxt);
 384 }
 385
 386 static inline void llog_group_init(struct obd_llog_group *olg)
 387 {
 388         init_waitqueue_head(&olg->olg_waitq);
 389         spin_lock_init(&olg->olg_lock);
 390 }
 391
 392 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
 393                                       struct llog_ctxt *ctxt, int index)
 394 {
 395         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
 396
 397         spin_lock(&olg->olg_lock);
 398         if (olg->olg_ctxts[index] != NULL) {
 399                 spin_unlock(&olg->olg_lock);
 400                 return -EEXIST;
 401         }
 402         olg->olg_ctxts[index] = ctxt;
 403         spin_unlock(&olg->olg_lock);
 404         return 0;
 405 }
 406
 407 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
 408                                                     int index)
 409 {
 410         struct llog_ctxt *ctxt;
 411
 412         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
 413
 414         spin_lock(&olg->olg_lock);
 415         if (olg->olg_ctxts[index] == NULL)
 416                 ctxt = NULL;
 417         else
 418                 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
 419         spin_unlock(&olg->olg_lock);
 420         return ctxt;
 421 }
 422
 423 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
 424 {
 425         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
 426         spin_lock(&olg->olg_lock);
 427         olg->olg_ctxts[index] = NULL;
 428         spin_unlock(&olg->olg_lock);
 429 }
 430
 431 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
 432                                                  int index)
 433 {
 434         return llog_group_get_ctxt(&obd->obd_olg, index);
 435 }
 436
 437 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
 438 {
 439         return (olg->olg_ctxts[index] == NULL);
 440 }
 441
 442 static inline int llog_ctxt_null(struct obd_device *obd, int index)
 443 {
 444         return (llog_group_ctxt_null(&obd->obd_olg, index));
 445 }
 446
 447 static inline int llog_next_block(const struct lu_env *env,
 448                                   struct llog_handle *loghandle, int *cur_idx,
 449                                   int next_idx, __u64 *cur_offset, void *buf,
 450                                   int len)
 451 {
 452         const struct llog_operations *lop;
 453         int rc;
 454
 455         ENTRY;
 456
 457         rc = llog_handle2ops(loghandle, &lop);
 458         if (rc)
 459                 RETURN(rc);
 460         if (lop->lop_next_block == NULL)
 461                 RETURN(-EOPNOTSUPP);
 462
 463         rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
 464                                  cur_offset, buf, len);
 465         RETURN(rc);
 466 }
 467
 468 static inline int llog_prev_block(const struct lu_env *env,
 469                                   struct llog_handle *loghandle,
 470                                   int prev_idx, void *buf, int len)
 471 {
 472         const struct llog_operations *lop;
 473         int rc;
 474
 475         ENTRY;
 476
 477         rc = llog_handle2ops(loghandle, &lop);
 478         if (rc)
 479                 RETURN(rc);
 480         if (lop->lop_prev_block == NULL)
 481                 RETURN(-EOPNOTSUPP);
 482
 483         rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
 484         RETURN(rc);
 485 }
 486
 487 static inline int llog_connect(struct llog_ctxt *ctxt,
 488                                struct llog_logid *logid, struct llog_gen *gen,
 489                                struct obd_uuid *uuid)
 490 {
 491         const struct llog_operations *lop;
 492         int rc;
 493
 494         ENTRY;
 495
 496         rc = llog_obd2ops(ctxt, &lop);
 497         if (rc)
 498                 RETURN(rc);
 499         if (lop->lop_connect == NULL)
 500                 RETURN(-EOPNOTSUPP);
 501
 502         rc = lop->lop_connect(ctxt, logid, gen, uuid);
 503         RETURN(rc);
 504 }
 505
 506 static inline int llog_is_full(struct llog_handle *llh)
 507 {
 508         return llh->lgh_last_idx >= LLOG_HDR_BITMAP_SIZE(llh->lgh_hdr) - 1;
 509 }
 510
 511 struct llog_cfg_rec {
 512         struct llog_rec_hdr     lcr_hdr;
 513         struct lustre_cfg       lcr_cfg;
 514         struct llog_rec_tail    lcr_tail;
 515 };
 516
 517 struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
 518 void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
 519
 520 enum {
 521         LLOG_NEXT_IDX = -1,
 522         LLOG_HEADER_IDX = 0,
 523 };
 524
 525 /* llog.c */
 526 int llog_exist(struct llog_handle *loghandle);
 527 int llog_declare_create(const struct lu_env *env,
 528                         struct llog_handle *loghandle, struct thandle *th);
 529 int llog_create(const struct lu_env *env, struct llog_handle *handle,
 530                 struct thandle *th);
 531 int llog_trans_destroy(const struct lu_env *env, struct llog_handle *handle,
 532                        struct thandle *th);
 533 int llog_destroy(const struct lu_env *env, struct llog_handle *handle);
 534
 535 int llog_declare_write_rec(const struct lu_env *env,
 536                            struct llog_handle *handle,
 537                            struct llog_rec_hdr *rec, int idx,
 538                            struct thandle *th);
 539 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
 540                    struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
 541                    int idx, struct thandle *th);
 542 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
 543              struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
 544              struct thandle *th);
 545 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
 546                      struct llog_rec_hdr *rec, struct thandle *th);
 547 int lustre_process_log(struct super_block *sb, char *logname,
 548                        struct config_llog_instance *cfg);
 549 int lustre_end_log(struct super_block *sb, char *logname,
 550                    struct config_llog_instance *cfg);
 551 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
 552                      struct llog_handle **res, struct llog_logid *logid,
 553                      char *name);
 554 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
 555                struct llog_logid *logid, char *name);
 556 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
 557                struct llog_rec_hdr *rec, int idx);
 558
 559 /** @} log */
 560
 561 #endif