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