lustre/include/linux/lustre_log.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001 Cluster File Systems, Inc. <info@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * Generic infrastructure for managing a collection of logs.
  22  *
  23  * These logs are used for:
  24  *
  25  * - orphan recovery: OST adds record on create
  26  * - mtime/size consistency: the OST adds a record on first write
  27  * - open/unlinked objects: OST adds a record on destroy
  28  *
  29  * - mds unlink log: the MDS adds an entry upon delete
  30  *
  31  * - raid1 replication log between OST's
  32  * - MDS replication logs
  33  */
  34
  35 #ifndef _LUSTRE_LOG_H
  36 #define _LUSTRE_LOG_H
  37
  38 #include <linux/obd.h>
  39 #include <linux/lustre_idl.h>
  40
  41 #define LOG_NAME_LIMIT(logname, name)                   \
  42         snprintf(logname, sizeof(logname), "LOGS/%s", name)
  43 #define LLOG_EEMPTY 4711
  44
  45 struct plain_handle_data {
  46         struct list_head    phd_entry;
  47         struct llog_handle *phd_cat_handle;
  48         struct llog_cookie  phd_cookie; /* cookie of this log in its cat */
  49         int                 phd_last_idx;
  50 };
  51
  52 struct cat_handle_data {
  53         struct list_head        chd_head;
  54         struct llog_handle     *chd_current_log; /* currently open log */
  55 };
  56
  57 /* In-memory descriptor for a log object or log catalog */
  58 struct llog_handle {
  59         struct rw_semaphore     lgh_lock;
  60         struct llog_logid       lgh_id;              /* id of this log */
  61         struct llog_log_hdr    *lgh_hdr;
  62         struct file            *lgh_file;
  63         int                     lgh_last_idx;
  64         struct llog_ctxt       *lgh_ctxt;
  65         union {
  66                 struct plain_handle_data phd;
  67                 struct cat_handle_data   chd;
  68         } u;
  69 };
  70
  71 /* llog.c  -  general API */
  72 typedef int (*llog_cb_t)(struct llog_handle *, struct llog_rec_hdr *, void *);
  73 struct llog_handle *llog_alloc_handle(void);
  74 void llog_free_handle(struct llog_handle *handle);
  75 int llog_cancel_rec(struct llog_handle *loghandle, int index);
  76 int llog_init_handle(struct llog_handle *handle, int flags,
  77                      struct obd_uuid *uuid);
  78 int llog_close(struct llog_handle *cathandle);
  79 int llog_process(struct llog_handle *loghandle, llog_cb_t cb,
  80                  void *data, void *catdata);
  81 int llog_reverse_process(struct llog_handle *loghandle, llog_cb_t cb,
  82                          void *data, void *catdata);
  83
  84 /* llog_cat.c   -  catalog api */
  85 struct llog_process_data {
  86         void *lpd_data;
  87         llog_cb_t lpd_cb;
  88 };
  89
  90 struct llog_process_cat_data {
  91         int     first_idx;
  92         int     last_idx;
  93         /* to process catalog across zero record */
  94 };
  95
  96 int llog_cat_id2handle(struct llog_handle *cathandle, struct llog_handle **res,
  97                        struct llog_logid *logid);
  98 int llog_cat_put(struct llog_handle *cathandle);
  99 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
 100                      struct llog_cookie *reccookie, void *buf);
 101 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
 102                             struct llog_cookie *cookies);
 103 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
 104 int llog_cat_reverse_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
 105 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index);
 106
 107 int llog_catalog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
 108                      void *buf, struct llog_cookie *reccookie, int, void *data);
 109 int llog_catalog_cancel(struct llog_ctxt *ctxt, int count, struct llog_cookie *,
 110                         int flags, void *data);
 111 int llog_catalog_setup(struct llog_ctxt **res, char *name, struct lvfs_run_ctxt *,
 112                        struct fsfilt_operations *fsops, struct dentry *logs_de,
 113                        struct dentry *objects_de);
 114 int llog_catalog_cleanup(struct llog_ctxt *ctxt);
 115 int llog_cat_half_bottom(struct llog_cookie *, struct llog_handle *);
 116
 117 /* llog_lvfs.c */
 118 int llog_get_cat_list(struct lvfs_run_ctxt *, struct fsfilt_operations *,
 119                       char *name, int count, struct llog_catid *idarray);
 120 int llog_put_cat_list(struct lvfs_run_ctxt *, struct fsfilt_operations *,
 121                       char *name, int count, struct llog_catid *idarray);
 122 extern struct llog_operations llog_lvfs_ops;
 123
 124 /* llog_obd.c - obd llog api */
 125 int obd_llog_setup(struct obd_device *obd, int index, struct obd_device *disk_obd,
 126                    int count,  struct llog_logid *logid,struct llog_operations *op);
 127 int obd_llog_cleanup(struct llog_ctxt *);
 128 int llog_obd_origin_setup(struct obd_device *obd, int index,
 129                           struct obd_device *disk_obd, int count,
 130                           struct llog_logid *logid);
 131 int obd_llog_cat_initialize(struct obd_device *obd, int count, char *name);
 132 int obd_llog_init(struct obd_device *obd, struct obd_device *disk_obd,
 133                   int count, struct llog_catid *logid);
 134
 135 int obd_llog_finish(struct obd_device *obd, int count);
 136
 137 /* llog_ioctl.c */
 138 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
 139 int llog_catalog_list(struct obd_device *obd, int count,
 140                      struct obd_ioctl_data *data);
 141
 142 /* llog_net.c */
 143 int llog_initiator_connect(struct llog_ctxt *ctxt);
 144 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
 145 int llog_origin_connect(struct llog_ctxt *ctxt, int count,
 146                         struct llog_logid *logid, struct llog_gen *gen,
 147                         struct obd_uuid *uuid);
 148 int llog_handle_connect(struct ptlrpc_request *req);
 149
 150 /* recov_thread.c */
 151 int llog_obd_repl_cancel(struct llog_ctxt *ctxt, int count,
 152                          struct llog_cookie *cookies, int flags, void *data);
 153
 154 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
 155 int llog_repl_connect(struct llog_ctxt *ctxt, int count,
 156                       struct llog_logid *logid, struct llog_gen *gen,
 157                       struct obd_uuid *uuid);
 158
 159 struct llog_operations {
 160         int (*lop_setup)(struct obd_device *obd, int ctxt_idx,
 161                          struct obd_device *disk_obd, int count,
 162                          struct llog_logid *logid);
 163         int (*lop_cleanup)(struct llog_ctxt *ctxt);
 164         int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
 165                           struct llog_logid *logid, char *name);
 166         int (*lop_destroy)(struct llog_handle *handle);
 167         int (*lop_close)(struct llog_handle *handle);
 168
 169         int (*lop_read_header)(struct llog_handle *handle);
 170         int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
 171                        void *buf, struct llog_cookie *logcookies,
 172                        int numcookies, void *data);
 173         int (*lop_cancel)(struct llog_ctxt *ctxt, int count,
 174                           struct llog_cookie *cookies, int flags, void *data);
 175         int (*lop_write_rec)(struct llog_handle *loghandle,
 176                              struct llog_rec_hdr *rec,
 177                              struct llog_cookie *logcookies, int numcookies,
 178                              void *, int idx);
 179         int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
 180                               int next_idx, __u64 *offset, void *buf, int len);
 181         int (*lop_prev_block)(struct llog_handle *h,
 182                               int prev_idx, void *buf, int len);
 183
 184         /* XXX add 2 more: commit callbacks and llog recovery functions */
 185         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp);
 186         int (*lop_connect)(struct llog_ctxt *ctxt, int count,
 187                            struct llog_logid *logid, struct llog_gen *gen,
 188                            struct obd_uuid *uuid);
 189 };
 190
 191 struct llog_ctxt {
 192         /* needed for lvfs based log */
 193         struct llog_handle      *loc_handle;
 194         struct llog_operations  *loc_logops;
 195         struct fsfilt_operations *loc_fsops;
 196         struct dentry           *loc_logs_dir;
 197         struct dentry           *loc_objects_dir;
 198         struct lvfs_run_ctxt    *loc_lvfs_ctxt;
 199
 200         struct obd_device       *loc_obd; /* points back to the containing obd*/
 201         struct llog_gen          loc_gen;
 202         int                      loc_idx; /* my index the obd array of ctxt's */
 203
 204         struct obd_export       *loc_exp;
 205         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
 206                                              pointing import */
 207         struct llog_canceld_ctxt *loc_llcd;
 208         struct semaphore         loc_sem; /* protects loc_llcd */
 209         void                    *loc_proc_cb; /* cb for recovery */
 210 };
 211
 212 static inline void llog_gen_init(struct llog_ctxt *ctxt)
 213 {
 214         struct obd_device *obd = ctxt->loc_exp->exp_obd;
 215
 216         if (!strcmp(obd->obd_type->typ_name, "mds"))
 217                 ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count;
 218         else if (!strstr(obd->obd_type->typ_name, "filter"))
 219                 ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count;
 220         else
 221                 ctxt->loc_gen.mnt_cnt = 0;
 222 }
 223
 224 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
 225 {
 226         if (a.mnt_cnt < b.mnt_cnt)
 227                 return 1;
 228         if (a.mnt_cnt > b.mnt_cnt)
 229                 return 0;
 230         return(a.conn_cnt < b.conn_cnt ? 1 : 0);
 231 }
 232
 233 #define LLOG_GEN_INC(gen)  ((gen).conn_cnt) ++
 234 #define LLOG_PROC_BREAK 0x0001
 235
 236 static inline int llog_ctxt2ops(struct llog_ctxt *ctxt,
 237                                struct llog_operations **lop)
 238 {
 239         if (ctxt == NULL)
 240                 return -ENOTCONN;
 241
 242         *lop = ctxt->loc_logops;
 243         if (*lop == NULL)
 244                 return -EOPNOTSUPP;
 245
 246         return 0;
 247 }
 248
 249 static inline int llog_handle2ops(struct llog_handle *loghandle,
 250                                   struct llog_operations **lop)
 251 {
 252         if (loghandle == NULL)
 253                 return -EINVAL;
 254
 255         return llog_ctxt2ops(loghandle->lgh_ctxt, lop);
 256 }
 257
 258 static inline int llog_data_len(int len)
 259 {
 260         return size_round(len);
 261 }
 262
 263 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
 264                                                  int index)
 265 {
 266         if (index < 0 || index >= LLOG_MAX_CTXTS)
 267                 return NULL;
 268
 269         return obd->obd_llog_ctxt[index];
 270 }
 271
 272 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
 273                               struct llog_logid *logid, char *name)
 274 {
 275         struct llog_operations *lop;
 276         int rc;
 277         ENTRY;
 278
 279         rc = llog_ctxt2ops(ctxt, &lop);
 280         if (rc)
 281                 RETURN(rc);
 282         if (lop->lop_create == NULL)
 283                 RETURN(-EOPNOTSUPP);
 284
 285         rc = lop->lop_create(ctxt, res, logid, name);
 286         RETURN(rc);
 287 }
 288
 289 static inline int llog_destroy(struct llog_handle *handle)
 290 {
 291         struct llog_operations *lop;
 292         int rc;
 293         ENTRY;
 294
 295         rc = llog_handle2ops(handle, &lop);
 296         if (rc)
 297                 RETURN(rc);
 298         if (lop->lop_destroy == NULL)
 299                 RETURN(-EOPNOTSUPP);
 300
 301         rc = lop->lop_destroy(handle);
 302         RETURN(rc);
 303 }
 304
 305 static inline int llog_read_header(struct llog_handle *handle)
 306 {
 307         struct llog_operations *lop;
 308         int rc;
 309         ENTRY;
 310
 311         rc = llog_handle2ops(handle, &lop);
 312         if (rc)
 313                 RETURN(rc);
 314         if (lop->lop_read_header == NULL)
 315                 RETURN(-EOPNOTSUPP);
 316
 317         rc = lop->lop_read_header(handle);
 318         RETURN(rc);
 319 }
 320
 321 static inline int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
 322                            void *buf, struct llog_cookie *logcookies,
 323                            int numcookies, void *data)
 324 {
 325         struct llog_operations *lop;
 326         int rc;
 327         ENTRY;
 328
 329         rc = llog_ctxt2ops(ctxt, &lop);
 330         if (rc)
 331                 RETURN(rc);
 332         if (lop->lop_add == NULL)
 333                 RETURN(-EOPNOTSUPP);
 334
 335         rc = lop->lop_add(ctxt, rec, buf, logcookies, numcookies, data);
 336         RETURN(rc);
 337 }
 338
 339 static inline int llog_cancel(struct llog_ctxt *ctxt, int count,
 340                               struct llog_cookie *cookies, int flags, void *data)
 341 {
 342         struct llog_operations *lop;
 343         int rc;
 344         ENTRY;
 345
 346         rc = llog_ctxt2ops(ctxt, &lop);
 347         if (rc)
 348                 RETURN(rc);
 349         if (lop->lop_cancel == NULL)
 350                 RETURN(-EOPNOTSUPP);
 351
 352         rc = lop->lop_cancel(ctxt, count, cookies, flags, data);
 353         RETURN(rc);
 354 }
 355
 356 static inline int llog_write_rec(struct llog_handle *handle,
 357                                  struct llog_rec_hdr *rec,
 358                                  struct llog_cookie *logcookies,
 359                                  int numcookies, void *buf, int idx)
 360 {
 361         struct llog_operations *lop;
 362         int rc, buflen;
 363         ENTRY;
 364
 365         rc = llog_handle2ops(handle, &lop);
 366         if (rc)
 367                 RETURN(rc);
 368         if (lop->lop_write_rec == NULL)
 369                 RETURN(-EOPNOTSUPP);
 370
 371         if (buf)
 372                 buflen = le32_to_cpu(rec->lrh_len) + sizeof(struct llog_rec_hdr)
 373                                 + sizeof(struct llog_rec_tail);
 374         else
 375                 buflen = le32_to_cpu(rec->lrh_len);
 376         LASSERT(size_round(buflen) == buflen);
 377
 378         rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
 379         RETURN(rc);
 380 }
 381
 382 static inline int llog_next_block(struct llog_handle *loghandle, int *curr_idx,
 383                                   int next_idx, __u64 *curr_offset, void *buf,
 384                                   int len)
 385 {
 386         struct llog_operations *lop;
 387         int rc;
 388         ENTRY;
 389
 390         rc = llog_handle2ops(loghandle, &lop);
 391         if (rc)
 392                 RETURN(rc);
 393         if (lop->lop_next_block == NULL)
 394                 RETURN(-EOPNOTSUPP);
 395
 396         rc = lop->lop_next_block(loghandle, curr_idx, next_idx, curr_offset, buf,
 397                                  len);
 398         RETURN(rc);
 399 }
 400
 401 static inline int llog_prev_block(struct llog_handle *loghandle,
 402                                   int prev_idx, void *buf, int len)
 403 {
 404         struct llog_operations *lop;
 405         int rc;
 406         ENTRY;
 407
 408         rc = llog_handle2ops(loghandle, &lop);
 409         if (rc)
 410                 RETURN(rc);
 411         if (lop->lop_prev_block == NULL)
 412                 RETURN(-EOPNOTSUPP);
 413
 414         rc = lop->lop_prev_block(loghandle, prev_idx, buf, len);
 415         RETURN(rc);
 416 }
 417
 418 static inline int llog_connect(struct llog_ctxt *ctxt, int count,
 419                                struct llog_logid *logid, struct llog_gen *gen,
 420                                struct obd_uuid *uuid)
 421 {
 422         struct llog_operations *lop;
 423         int rc;
 424         ENTRY;
 425
 426         rc = llog_ctxt2ops(ctxt, &lop);
 427         if (rc)
 428                 RETURN(rc);
 429         if (lop->lop_connect == NULL)
 430                 RETURN(-EOPNOTSUPP);
 431
 432         rc = lop->lop_connect(ctxt, count, logid, gen, uuid);
 433         RETURN(rc);
 434 }
 435
 436 static inline int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp)
 437 {
 438         struct llog_operations *lop;
 439         int rc;
 440         ENTRY;
 441
 442         rc = llog_ctxt2ops(ctxt, &lop);
 443         if (rc)
 444                 RETURN(rc);
 445         if (lop->lop_sync == NULL)
 446                 RETURN(-EOPNOTSUPP);
 447
 448         rc = lop->lop_sync(ctxt, exp);
 449         RETURN(rc);
 450 }
 451
 452 #endif