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