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