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, Whamcloud, Inc.
  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 #if defined(__linux__)
  60 #include <linux/lustre_log.h>
  61 #elif defined(__APPLE__)
  62 #include <darwin/lustre_log.h>
  63 #elif defined(__WINNT__)
  64 #include <winnt/lustre_log.h>
  65 #else
  66 #error Unsupported operating system.
  67 #endif
  68
  69 #include <obd_class.h>
  70 #include <obd_ost.h>
  71 #include <lustre/lustre_idl.h>
  72 #include <dt_object.h>
  73
  74 #define LOG_NAME_LIMIT(logname, name)                   \
  75         snprintf(logname, sizeof(logname), "LOGS/%s", name)
  76 #define LLOG_EEMPTY 4711
  77
  78 enum llog_open_param {
  79         LLOG_OPEN_EXISTS        = 0x0000,
  80         LLOG_OPEN_NEW           = 0x0001,
  81 };
  82
  83 struct plain_handle_data {
  84         cfs_list_t          phd_entry;
  85         struct llog_handle *phd_cat_handle;
  86         struct llog_cookie  phd_cookie; /* cookie of this log in its cat */
  87 };
  88
  89 struct cat_handle_data {
  90         cfs_list_t              chd_head;
  91         struct llog_handle     *chd_current_log; /* currently open log */
  92         struct llog_handle      *chd_next_log; /* llog to be used next */
  93 };
  94
  95 static inline void logid_to_fid(struct llog_logid *id, struct lu_fid *fid)
  96 {
  97         /* For compatibility purposes we identify pre-OSD (~< 2.3.51 MDS)
  98          * logid's by non-zero ogen (inode generation) and convert them
  99          * into IGIF */
 100         if (id->lgl_ogen == 0) {
 101                 fid->f_seq = id->lgl_oseq;
 102                 fid->f_oid = id->lgl_oid;
 103                 fid->f_ver = 0;
 104         } else {
 105                 lu_igif_build(fid, id->lgl_oid, id->lgl_ogen);
 106         }
 107 }
 108
 109 static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
 110 {
 111         id->lgl_oseq = fid->f_seq;
 112         id->lgl_oid = fid->f_oid;
 113         id->lgl_ogen = 0;
 114 }
 115
 116 struct llog_handle;
 117
 118 /* llog.c  -  general API */
 119 typedef int (*llog_cb_t)(const struct lu_env *env, struct llog_handle *lgh,
 120                          struct llog_rec_hdr *rec, void *data);
 121 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
 122                      int flags, struct obd_uuid *uuid);
 123 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
 124                  llog_cb_t cb, void *data, void *catdata);
 125 int llog_process_or_fork(const struct lu_env *env,
 126                          struct llog_handle *loghandle,
 127                          llog_cb_t cb, void *data, void *catdata, bool fork);
 128 int llog_reverse_process(const struct lu_env *env,
 129                          struct llog_handle *loghandle, llog_cb_t cb,
 130                          void *data, void *catdata);
 131 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
 132                     int index);
 133 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
 134               struct llog_handle **lgh, struct llog_logid *logid,
 135               char *name, enum llog_open_param open_param);
 136 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
 137 int llog_get_size(struct llog_handle *loghandle);
 138
 139 /* llog_process flags */
 140 #define LLOG_FLAG_NODEAMON 0x0001
 141
 142 /* llog_cat.c - catalog api */
 143 struct llog_process_data {
 144         /**
 145          * Any useful data needed while processing catalog. This is
 146          * passed later to process callback.
 147          */
 148         void                *lpd_data;
 149         /**
 150          * Catalog process callback function, called for each record
 151          * in catalog.
 152          */
 153         llog_cb_t            lpd_cb;
 154         /**
 155          * Start processing the catalog from startcat/startidx
 156          */
 157         int                  lpd_startcat;
 158         int                  lpd_startidx;
 159 };
 160
 161 struct llog_process_cat_data {
 162         /**
 163          * Temporary stored first_idx while scanning log.
 164          */
 165         int                  lpcd_first_idx;
 166         /**
 167          * Temporary stored last_idx while scanning log.
 168          */
 169         int                  lpcd_last_idx;
 170 };
 171
 172 struct llog_process_cat_args {
 173         /**
 174          * Llog context used in recovery thread on OST (recov_thread.c)
 175          */
 176         struct llog_ctxt    *lpca_ctxt;
 177         /**
 178          * Llog callback used in recovery thread on OST (recov_thread.c)
 179          */
 180         void                *lpca_cb;
 181         /**
 182          * Data pointer for llog callback.
 183          */
 184         void                *lpca_arg;
 185 };
 186
 187 int cat_cancel_cb(const struct lu_env *env, struct llog_handle *cathandle,
 188                   struct llog_rec_hdr *rec, void *data);
 189 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
 190 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
 191                      struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
 192                      void *buf);
 193 int llog_cat_cancel_records(const struct lu_env *env,
 194                             struct llog_handle *cathandle, int count,
 195                             struct llog_cookie *cookies);
 196 int __llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
 197                        llog_cb_t cb, void *data, int startcat, int startidx,
 198                        int fork);
 199 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
 200                      llog_cb_t cb, void *data, int startcat, int startidx);
 201 int llog_cat_process_thread(void *data);
 202 int llog_cat_reverse_process(const struct lu_env *env,
 203                              struct llog_handle *cat_llh, llog_cb_t cb,
 204                              void *data);
 205 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index);
 206
 207 /* llog_obd.c */
 208 int llog_setup_named(struct obd_device *obd, struct obd_llog_group *olg,
 209                      int index, struct obd_device *disk_obd, int count,
 210                      struct llog_logid *logid, const char *logname,
 211                      struct llog_operations *op);
 212 int llog_setup(struct obd_device *obd, struct obd_llog_group *olg, int index,
 213                struct obd_device *disk_obd, int count, struct llog_logid *logid,
 214                struct llog_operations *op);
 215 int __llog_ctxt_put(struct llog_ctxt *ctxt);
 216 int llog_cleanup(struct llog_ctxt *);
 217 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
 218 int llog_add(const struct lu_env *env, struct llog_ctxt *ctxt,
 219              struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
 220              struct llog_cookie *logcookies, int numcookies);
 221 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
 222                 struct lov_stripe_md *lsm, int count,
 223                 struct llog_cookie *cookies, int flags);
 224 int llog_obd_origin_setup(const struct lu_env *env, struct obd_device *obd,
 225                           struct obd_llog_group *olg, int index,
 226                           struct obd_device *disk_obd, int count,
 227                           struct llog_logid *logid, const char *name);
 228 int llog_obd_origin_cleanup(const struct lu_env *env, struct llog_ctxt *ctxt);
 229 int llog_obd_origin_add(const struct lu_env *env, struct llog_ctxt *ctxt,
 230                         struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
 231                         struct llog_cookie *logcookies, int numcookies);
 232
 233 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
 234                   struct obd_device *disk_obd, int *idx);
 235
 236 int obd_llog_finish(struct obd_device *obd, int count);
 237
 238 /* llog_ioctl.c */
 239 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
 240 int llog_catalog_list(struct obd_device *obd, int count,
 241                       struct obd_ioctl_data *data);
 242
 243 /* llog_net.c */
 244 int llog_initiator_connect(struct llog_ctxt *ctxt);
 245 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
 246 int llog_origin_connect(struct llog_ctxt *ctxt,
 247                         struct llog_logid *logid, struct llog_gen *gen,
 248                         struct obd_uuid *uuid);
 249 int llog_handle_connect(struct ptlrpc_request *req);
 250
 251 /* recov_thread.c */
 252 int llog_obd_repl_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
 253                          struct lov_stripe_md *lsm, int count,
 254                          struct llog_cookie *cookies, int flags);
 255 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp,
 256                        int flags);
 257 int llog_obd_repl_connect(struct llog_ctxt *ctxt,
 258                           struct llog_logid *logid, struct llog_gen *gen,
 259                           struct obd_uuid *uuid);
 260
 261 struct llog_operations {
 262         int (*lop_destroy)(const struct lu_env *env,
 263                            struct llog_handle *handle);
 264         int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
 265                               int *curr_idx, int next_idx, __u64 *offset,
 266                               void *buf, int len);
 267         int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
 268                               int prev_idx, void *buf, int len);
 269         int (*lop_read_header)(const struct lu_env *env,
 270                                struct llog_handle *handle);
 271         int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
 272                          struct obd_llog_group *olg, int ctxt_idx,
 273                          struct obd_device *disk_obd, int count,
 274                          struct llog_logid *logid, const char *name);
 275         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
 276                         int flags);
 277         int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
 278         int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
 279                           struct lov_stripe_md *lsm, int count,
 280                           struct llog_cookie *cookies, int flags);
 281         int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
 282                            struct llog_gen *gen, struct obd_uuid *uuid);
 283         /**
 284          * Any llog file must be opened first using llog_open().  Llog can be
 285          * opened by name, logid or without both, in last case the new logid
 286          * will be generated.
 287          */
 288         int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
 289                         struct llog_logid *logid, char *name,
 290                         enum llog_open_param);
 291         /**
 292          * Opened llog may not exist and this must be checked where needed using
 293          * the llog_exist() call.
 294          */
 295         int (*lop_exist)(struct llog_handle *lgh);
 296         /**
 297          * Close llog file and calls llog_free_handle() implicitly.
 298          * Any opened llog must be closed by llog_close() call.
 299          */
 300         int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
 301         /**
 302          * Create new llog file. The llog must be opened.
 303          * Must be used only for local llog operations.
 304          */
 305         int (*lop_declare_create)(const struct lu_env *env,
 306                                   struct llog_handle *handle,
 307                                   struct thandle *th);
 308         int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
 309                           struct thandle *th);
 310         /**
 311          * write new record in llog. It appends records usually but can edit
 312          * existing records too.
 313          */
 314         int (*lop_write_rec)(const struct lu_env *env,
 315                              struct llog_handle *loghandle,
 316                              struct llog_rec_hdr *rec,
 317                              struct llog_cookie *logcookies, int numcookies,
 318                              void *buf, int idx);
 319         /**
 320          * Add new record in llog catalog. Does the same as llog_write_rec()
 321          * but using llog catalog.
 322          */
 323         int (*lop_add)(const struct lu_env *env, struct llog_ctxt *ctxt,
 324                        struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
 325                        struct llog_cookie *logcookies, int numcookies);
 326 };
 327
 328 /* In-memory descriptor for a log object or log catalog */
 329 struct llog_handle {
 330         cfs_rw_semaphore_t       lgh_lock;
 331         cfs_spinlock_t           lgh_hdr_lock; /* protect lgh_hdr data */
 332         struct llog_logid        lgh_id; /* id of this log */
 333         struct llog_log_hdr     *lgh_hdr;
 334         struct file             *lgh_file;
 335         struct dt_object        *lgh_obj;
 336         int                      lgh_last_idx;
 337         int                      lgh_cur_idx; /* used during llog_process */
 338         __u64                    lgh_cur_offset; /* used during llog_process */
 339         struct llog_ctxt        *lgh_ctxt;
 340         union {
 341                 struct plain_handle_data         phd;
 342                 struct cat_handle_data           chd;
 343         } u;
 344         char                    *lgh_name;
 345         void                    *private_data;
 346         struct llog_operations  *lgh_logops;
 347 };
 348
 349 /* llog_lvfs.c */
 350 extern struct llog_operations llog_lvfs_ops;
 351 int llog_get_cat_list(struct obd_device *disk_obd,
 352                       char *name, int idx, int count,
 353                       struct llog_catid *idarray);
 354
 355 int llog_put_cat_list(struct obd_device *disk_obd,
 356                       char *name, int idx, int count, struct llog_catid *idarray);
 357
 358 #define LLOG_CTXT_FLAG_UNINITIALIZED     0x00000001
 359 #define LLOG_CTXT_FLAG_STOP              0x00000002
 360
 361 struct llog_ctxt {
 362         int                      loc_idx; /* my index the obd array of ctxt's */
 363         struct llog_gen          loc_gen;
 364         struct obd_device       *loc_obd; /* points back to the containing obd*/
 365         struct obd_llog_group   *loc_olg; /* group containing that ctxt */
 366         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
 367         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
 368                                              pointing import */
 369         struct llog_operations  *loc_logops;
 370         struct llog_handle      *loc_handle;
 371         struct llog_commit_master *loc_lcm;
 372         struct llog_canceld_ctxt *loc_llcd;
 373         cfs_mutex_t              loc_mutex; /* protects loc_llcd and loc_imp */
 374         cfs_atomic_t             loc_refcount;
 375         void                    *llog_proc_cb;
 376         long                     loc_flags; /* flags, see above defines */
 377         struct dt_object        *loc_dir;
 378 };
 379
 380 #define LCM_NAME_SIZE 64
 381
 382 struct llog_commit_master {
 383         /**
 384          * Thread control flags (start, stop, etc.)
 385          */
 386         long                       lcm_flags;
 387         /**
 388          * Number of llcds onthis lcm.
 389          */
 390         cfs_atomic_t               lcm_count;
 391         /**
 392          * The refcount for lcm
 393          */
 394          cfs_atomic_t              lcm_refcount;
 395         /**
 396          * Thread control structure. Used for control commit thread.
 397          */
 398         struct ptlrpcd_ctl         lcm_pc;
 399         /**
 400          * Lock protecting list of llcds.
 401          */
 402         cfs_spinlock_t             lcm_lock;
 403         /**
 404          * Llcds in flight for debugging purposes.
 405          */
 406         cfs_list_t                 lcm_llcds;
 407         /**
 408          * Commit thread name buffer. Only used for thread start.
 409          */
 410         char                       lcm_name[LCM_NAME_SIZE];
 411 };
 412
 413 static inline struct llog_commit_master
 414 *lcm_get(struct llog_commit_master *lcm)
 415 {
 416         cfs_atomic_inc(&lcm->lcm_refcount);
 417         return lcm;
 418 }
 419
 420 static inline void
 421 lcm_put(struct llog_commit_master *lcm)
 422 {
 423         LASSERT_ATOMIC_POS(&lcm->lcm_refcount);
 424         if (cfs_atomic_dec_and_test(&lcm->lcm_refcount))
 425                 OBD_FREE_PTR(lcm);
 426 }
 427
 428 struct llog_canceld_ctxt {
 429         /**
 430          * Llog context this llcd is attached to. Used for accessing
 431          * ->loc_import and others in process of canceling cookies
 432          * gathered in this llcd.
 433          */
 434         struct llog_ctxt          *llcd_ctxt;
 435         /**
 436          * Cancel thread control stucture pointer. Used for accessing
 437          * it to see if should stop processing and other needs.
 438          */
 439         struct llog_commit_master *llcd_lcm;
 440         /**
 441          * Maximal llcd size. Used in calculations on how much of room
 442          * left in llcd to cookie comming cookies.
 443          */
 444         int                        llcd_size;
 445         /**
 446          * Link to lcm llcds list.
 447          */
 448         cfs_list_t                 llcd_list;
 449         /**
 450          * Current llcd size while gathering cookies. This should not be
 451          * more than ->llcd_size. Used for determining if we need to
 452          * send this llcd (if full) and allocate new one. This is also
 453          * used for copying new cookie at the end of buffer.
 454          */
 455         int                        llcd_cookiebytes;
 456         /**
 457          * Pointer to the start of cookies buffer.
 458          */
 459         struct llog_cookie         llcd_cookies[0];
 460 };
 461
 462 /* ptlrpc/recov_thread.c */
 463 extern struct llog_commit_master *llog_recov_thread_init(char *name);
 464 extern void llog_recov_thread_fini(struct llog_commit_master *lcm,
 465                                    int force);
 466 extern int llog_recov_thread_start(struct llog_commit_master *lcm);
 467 extern void llog_recov_thread_stop(struct llog_commit_master *lcm,
 468                                     int force);
 469
 470 static inline void llog_gen_init(struct llog_ctxt *ctxt)
 471 {
 472         struct obd_device *obd = ctxt->loc_exp->exp_obd;
 473
 474         LASSERTF(obd->u.obt.obt_magic == OBT_MAGIC,
 475                  "%s: wrong obt magic %#x\n",
 476                  obd->obd_name, obd->u.obt.obt_magic);
 477         ctxt->loc_gen.mnt_cnt = obd->u.obt.obt_mount_count;
 478         ctxt->loc_gen.conn_cnt++;
 479 }
 480
 481 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
 482 {
 483         if (a.mnt_cnt < b.mnt_cnt)
 484                 return 1;
 485         if (a.mnt_cnt > b.mnt_cnt)
 486                 return 0;
 487         return(a.conn_cnt < b.conn_cnt ? 1 : 0);
 488 }
 489
 490 #define LLOG_PROC_BREAK 0x0001
 491 #define LLOG_DEL_RECORD 0x0002
 492
 493 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
 494                                struct llog_operations **lop)
 495 {
 496         if (ctxt == NULL)
 497                 return -ENOTCONN;
 498
 499         *lop = ctxt->loc_logops;
 500         if (*lop == NULL)
 501                 return -EOPNOTSUPP;
 502
 503         return 0;
 504 }
 505
 506 static inline int llog_handle2ops(struct llog_handle *loghandle,
 507                                   struct llog_operations **lop)
 508 {
 509         if (loghandle == NULL || loghandle->lgh_logops == NULL)
 510                 return -EINVAL;
 511
 512         *lop = loghandle->lgh_logops;
 513         return 0;
 514 }
 515
 516 static inline int llog_data_len(int len)
 517 {
 518         return cfs_size_round(len);
 519 }
 520
 521 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
 522 {
 523         cfs_atomic_inc(&ctxt->loc_refcount);
 524         CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
 525                cfs_atomic_read(&ctxt->loc_refcount));
 526         return ctxt;
 527 }
 528
 529 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
 530 {
 531         if (ctxt == NULL)
 532                 return;
 533         LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
 534         CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
 535                cfs_atomic_read(&ctxt->loc_refcount) - 1);
 536         __llog_ctxt_put(ctxt);
 537 }
 538
 539 static inline void llog_group_init(struct obd_llog_group *olg, int group)
 540 {
 541         cfs_waitq_init(&olg->olg_waitq);
 542         cfs_spin_lock_init(&olg->olg_lock);
 543         cfs_mutex_init(&olg->olg_cat_processing);
 544         olg->olg_seq = group;
 545 }
 546
 547 static inline void llog_group_set_export(struct obd_llog_group *olg,
 548                                          struct obd_export *exp)
 549 {
 550         LASSERT(exp != NULL);
 551
 552         cfs_spin_lock(&olg->olg_lock);
 553         if (olg->olg_exp != NULL && olg->olg_exp != exp)
 554                 CWARN("%s: export for group %d is changed: 0x%p -> 0x%p\n",
 555                       exp->exp_obd->obd_name, olg->olg_seq,
 556                       olg->olg_exp, exp);
 557         olg->olg_exp = exp;
 558         cfs_spin_unlock(&olg->olg_lock);
 559 }
 560
 561 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
 562                                       struct llog_ctxt *ctxt, int index)
 563 {
 564         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
 565
 566         cfs_spin_lock(&olg->olg_lock);
 567         if (olg->olg_ctxts[index] != NULL) {
 568                 cfs_spin_unlock(&olg->olg_lock);
 569                 return -EEXIST;
 570         }
 571         olg->olg_ctxts[index] = ctxt;
 572         cfs_spin_unlock(&olg->olg_lock);
 573         return 0;
 574 }
 575
 576 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
 577                                                     int index)
 578 {
 579         struct llog_ctxt *ctxt;
 580
 581         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
 582
 583         cfs_spin_lock(&olg->olg_lock);
 584         if (olg->olg_ctxts[index] == NULL) {
 585                 ctxt = NULL;
 586         } else {
 587                 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
 588         }
 589         cfs_spin_unlock(&olg->olg_lock);
 590         return ctxt;
 591 }
 592
 593 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
 594                                                  int index)
 595 {
 596         return llog_group_get_ctxt(&obd->obd_olg, index);
 597 }
 598
 599 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
 600 {
 601         return (olg->olg_ctxts[index] == NULL);
 602 }
 603
 604 static inline int llog_ctxt_null(struct obd_device *obd, int index)
 605 {
 606         return (llog_group_ctxt_null(&obd->obd_olg, index));
 607 }
 608
 609 static inline int llog_write_rec(const struct lu_env *env,
 610                                  struct llog_handle *handle,
 611                                  struct llog_rec_hdr *rec,
 612                                  struct llog_cookie *logcookies,
 613                                  int numcookies, void *buf, int idx)
 614 {
 615         struct llog_operations *lop;
 616         int raised, rc, buflen;
 617
 618         ENTRY;
 619
 620         rc = llog_handle2ops(handle, &lop);
 621         if (rc)
 622                 RETURN(rc);
 623         LASSERT(lop);
 624         if (lop->lop_write_rec == NULL)
 625                 RETURN(-EOPNOTSUPP);
 626
 627         /* FIXME:  Why doesn't caller just set the right lrh_len itself? */
 628         if (buf)
 629                 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr) +
 630                          sizeof(struct llog_rec_tail);
 631         else
 632                 buflen = rec->lrh_len;
 633         LASSERT(cfs_size_round(buflen) == buflen);
 634
 635         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 636         if (!raised)
 637                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 638         rc = lop->lop_write_rec(env, handle, rec, logcookies, numcookies,
 639                                 buf, idx);
 640         if (!raised)
 641                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 642         RETURN(rc);
 643 }
 644
 645 static inline int llog_destroy(const struct lu_env *env,
 646                                struct llog_handle *handle)
 647 {
 648         struct llog_operations *lop;
 649         int rc;
 650
 651         ENTRY;
 652
 653         rc = llog_handle2ops(handle, &lop);
 654         if (rc)
 655                 RETURN(rc);
 656         if (lop->lop_destroy == NULL)
 657                 RETURN(-EOPNOTSUPP);
 658
 659         rc = lop->lop_destroy(env, handle);
 660         RETURN(rc);
 661 }
 662
 663 static inline int llog_next_block(const struct lu_env *env,
 664                                   struct llog_handle *loghandle, int *cur_idx,
 665                                   int next_idx, __u64 *cur_offset, void *buf,
 666                                   int len)
 667 {
 668         struct llog_operations *lop;
 669         int rc;
 670
 671         ENTRY;
 672
 673         rc = llog_handle2ops(loghandle, &lop);
 674         if (rc)
 675                 RETURN(rc);
 676         if (lop->lop_next_block == NULL)
 677                 RETURN(-EOPNOTSUPP);
 678
 679         rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
 680                                  cur_offset, buf, len);
 681         RETURN(rc);
 682 }
 683
 684 static inline int llog_prev_block(const struct lu_env *env,
 685                                   struct llog_handle *loghandle,
 686                                   int prev_idx, void *buf, int len)
 687 {
 688         struct llog_operations *lop;
 689         int rc;
 690
 691         ENTRY;
 692
 693         rc = llog_handle2ops(loghandle, &lop);
 694         if (rc)
 695                 RETURN(rc);
 696         if (lop->lop_prev_block == NULL)
 697                 RETURN(-EOPNOTSUPP);
 698
 699         rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
 700         RETURN(rc);
 701 }
 702
 703 static inline int llog_connect(struct llog_ctxt *ctxt,
 704                                struct llog_logid *logid, struct llog_gen *gen,
 705                                struct obd_uuid *uuid)
 706 {
 707         struct llog_operations  *lop;
 708         int                      rc;
 709
 710         ENTRY;
 711
 712         rc = llog_obd2ops(ctxt, &lop);
 713         if (rc)
 714                 RETURN(rc);
 715         if (lop->lop_connect == NULL)
 716                 RETURN(-EOPNOTSUPP);
 717
 718         rc = lop->lop_connect(ctxt, logid, gen, uuid);
 719         RETURN(rc);
 720 }
 721
 722 /**
 723  * new llog API
 724  *
 725  * API functions:
 726  *      llog_open - open llog, may not exist
 727  *      llog_exist - check if llog exists
 728  *      llog_close - close opened llog, pair for open, frees llog_handle
 729  *      llog_declare_create - declare llog creation
 730  *      llog_create - create new llog on disk, need transaction handle
 731  */
 732 static inline int llog_exist(struct llog_handle *loghandle)
 733 {
 734         struct llog_operations *lop;
 735         int raised, rc;
 736
 737         ENTRY;
 738
 739         rc = llog_handle2ops(loghandle, &lop);
 740         if (rc)
 741                 RETURN(rc);
 742         if (lop->lop_exist == NULL)
 743                 RETURN(-EOPNOTSUPP);
 744         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 745         if (!raised)
 746                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 747         rc = lop->lop_exist(loghandle);
 748         if (!raised)
 749                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 750         RETURN(rc);
 751 }
 752
 753 static inline int llog_declare_create(const struct lu_env *env,
 754                                       struct llog_handle *loghandle,
 755                                       struct thandle *th)
 756 {
 757         struct llog_operations  *lop;
 758         int                      raised, rc;
 759
 760         ENTRY;
 761
 762         rc = llog_handle2ops(loghandle, &lop);
 763         if (rc)
 764                 RETURN(rc);
 765         if (lop->lop_declare_create == NULL)
 766                 RETURN(-EOPNOTSUPP);
 767
 768         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 769         if (!raised)
 770                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 771         rc = lop->lop_declare_create(env, loghandle, th);
 772         if (!raised)
 773                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 774         RETURN(rc);
 775 }
 776
 777 static inline int llog_create(const struct lu_env *env,
 778                               struct llog_handle *handle, struct thandle *th)
 779 {
 780         struct llog_operations  *lop;
 781         int                      raised, rc;
 782
 783         ENTRY;
 784
 785         rc = llog_handle2ops(handle, &lop);
 786         if (rc)
 787                 RETURN(rc);
 788         if (lop->lop_create == NULL)
 789                 RETURN(-EOPNOTSUPP);
 790
 791         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 792         if (!raised)
 793                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 794         rc = lop->lop_create(env, handle, th);
 795         if (!raised)
 796                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 797         RETURN(rc);
 798 }
 799
 800 int lustre_process_log(struct super_block *sb, char *logname,
 801                        struct config_llog_instance *cfg);
 802 int lustre_end_log(struct super_block *sb, char *logname,
 803                    struct config_llog_instance *cfg);
 804 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
 805                      struct llog_handle **res, struct llog_logid *logid,
 806                      char *name);
 807 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
 808                struct llog_logid *logid, char *name);
 809 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
 810                struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
 811                int cookiecount, void *buf, int idx);
 812
 813 /** @} log */
 814
 815 #endif