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