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
  44 struct plain_handle_data {
  45         struct list_head    phd_entry;
  46         struct llog_handle *phd_cat_handle;
  47         struct llog_cookie  phd_cookie; /* cookie of this log in its cat */
  48         int                 phd_last_idx;
  49 };
  50
  51 struct cat_handle_data {
  52         struct list_head        chd_head;
  53         struct llog_handle     *chd_current_log; /* currently open log */
  54 };
  55
  56 /* In-memory descriptor for a log object or log catalog */
  57 struct llog_handle {
  58         struct rw_semaphore     lgh_lock;
  59         struct llog_logid       lgh_id;              /* id of this log */
  60         struct llog_log_hdr    *lgh_hdr;
  61         struct file            *lgh_file;
  62         int                     lgh_last_idx;
  63         struct llog_ctxt       *lgh_ctxt;
  64         union {
  65                 struct plain_handle_data phd;
  66                 struct cat_handle_data   chd;
  67         } u;
  68 };
  69
  70 #define LLOG_EEMPTY 4711
  71
  72 /* llog.c  -  general API */
  73 typedef int (*llog_cb_t)(struct llog_handle *, struct llog_rec_hdr *, void *);
  74 int llog_init_handle(struct llog_handle *handle, int flags,
  75                      struct obd_uuid *uuid);
  76 int llog_process(struct llog_handle *loghandle, llog_cb_t cb,
  77                  void *data, void *catdata);
  78 extern struct llog_handle *llog_alloc_handle(void);
  79 extern void llog_free_handle(struct llog_handle *handle);
  80 extern int llog_close(struct llog_handle *cathandle);
  81 extern int llog_cancel_rec(struct llog_handle *loghandle, int index);
  82
  83 /* llog_cat.c   -  catalog api */
  84 struct llog_process_data {
  85         void *lpd_data;
  86         llog_cb_t lpd_cb;
  87 };
  88
  89 struct llog_process_cat_data {
  90         int     first_idx;
  91         int     last_idx;
  92         /* to process catlog across zero record */
  93 };
  94
  95 int llog_cat_put(struct llog_handle *cathandle);
  96 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
  97                      struct llog_cookie *reccookie, void *buf);
  98 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
  99                             struct llog_cookie *cookies);
 100 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
 101 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index);
 102
 103 /* llog_obd.c */
 104 int llog_setup(struct obd_device *obd, int index, struct obd_device *disk_obd,
 105                int count,  struct llog_logid *logid,struct llog_operations *op);
 106 int llog_cleanup(struct llog_ctxt *);
 107 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
 108 int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
 109              struct lov_stripe_md *lsm, struct llog_cookie *logcookies,
 110              int numcookies);
 111 int llog_cancel(struct llog_ctxt *, struct lov_stripe_md *lsm,
 112                 int count, struct llog_cookie *cookies, int flags);
 113
 114 int llog_obd_origin_setup(struct obd_device *obd, int index,
 115                           struct obd_device *disk_obd, int count,
 116                           struct llog_logid *logid);
 117 int llog_obd_origin_cleanup(struct llog_ctxt *ctxt);
 118 int llog_obd_origin_add(struct llog_ctxt *ctxt,
 119                         struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
 120                         struct llog_cookie *logcookies, int numcookies);
 121
 122 int llog_cat_initialize(struct obd_device *obd, int count);
 123 int obd_llog_init(struct obd_device *obd, struct obd_device *disk_obd,
 124                   int count, struct llog_logid *logid);
 125
 126 int obd_llog_finish(struct obd_device *obd, int count);
 127
 128 /* llog_ioctl.c */
 129 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
 130 int llog_catlog_list(struct obd_device *obd, int count,
 131                      struct obd_ioctl_data *data);
 132
 133 /* llog_net.c */
 134 int llog_initiator_connect(struct llog_ctxt *ctxt);
 135 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
 136 int llog_origin_connect(struct llog_ctxt *ctxt, int count,
 137                         struct llog_logid *logid, struct llog_gen *gen);
 138 int llog_handle_connect(struct ptlrpc_request *req);
 139
 140 /* recov_thread.c */
 141 int llog_obd_repl_cancel(struct llog_ctxt *ctxt,
 142                          struct lov_stripe_md *lsm, int count,
 143                          struct llog_cookie *cookies, int flags);
 144 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
 145 int llog_repl_connect(struct llog_ctxt *ctxt, int count,
 146                       struct llog_logid *logid, struct llog_gen *gen);
 147
 148 struct llog_operations {
 149         int (*lop_write_rec)(struct llog_handle *loghandle,
 150                              struct llog_rec_hdr *rec,
 151                              struct llog_cookie *logcookies, int numcookies,
 152                              void *, int idx);
 153         int (*lop_destroy)(struct llog_handle *handle);
 154         int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
 155                               int next_idx, __u64 *offset, void *buf, int len);
 156         int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
 157                           struct llog_logid *logid, char *name);
 158         int (*lop_close)(struct llog_handle *handle);
 159         int (*lop_read_header)(struct llog_handle *handle);
 160
 161         int (*lop_setup)(struct obd_device *obd, int ctxt_idx,
 162                          struct obd_device *disk_obd, int count,
 163                          struct llog_logid *logid);
 164         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp);
 165         int (*lop_cleanup)(struct llog_ctxt *ctxt);
 166         int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
 167                        struct lov_stripe_md *lsm,
 168                        struct llog_cookie *logcookies, int numcookies);
 169         int (*lop_cancel)(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm,
 170                           int count, struct llog_cookie *cookies, int flags);
 171         int (*lop_connect)(struct llog_ctxt *ctxt, int count,
 172                            struct llog_logid *logid, struct llog_gen *gen);
 173         /* XXX add 2 more: commit callbacks and llog recovery functions */
 174 };
 175
 176 /* llog_lvfs.c */
 177 int llog_get_cat_list(struct obd_device *obd, struct obd_device *disk_obd,
 178                       char *name, int count, struct llog_logid *idarray);
 179 extern struct llog_operations llog_lvfs_ops;
 180
 181
 182 struct llog_ctxt {
 183         int                      loc_idx; /* my index the obd array of ctxt's */
 184         struct llog_gen          loc_gen;
 185         struct obd_device       *loc_obd; /* points back to the containing obd*/
 186         struct obd_export       *loc_exp;
 187         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
 188                                              pointing import */
 189         struct llog_operations  *loc_logops;
 190         struct llog_handle      *loc_handle;
 191         struct llog_canceld_ctxt *loc_llcd;
 192         struct semaphore         loc_sem; /* protects loc_llcd */
 193         void                    *llog_proc_cb;
 194 };
 195
 196 static inline void llog_gen_init(struct llog_ctxt *ctxt)
 197 {
 198         struct obd_device *obd = ctxt->loc_exp->exp_obd;
 199
 200         if (!strcmp(obd->obd_type->typ_name, "mds"))
 201                 ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count;
 202         else if (!strstr(obd->obd_type->typ_name, "filter"))
 203                 ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count;
 204         else
 205                 ctxt->loc_gen.mnt_cnt = 0;
 206 }
 207
 208 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
 209 {
 210         if (a.mnt_cnt < b.mnt_cnt)
 211                 return 1;
 212         if (a.mnt_cnt > b.mnt_cnt)
 213                 return 0;
 214         return(a.conn_cnt < b.conn_cnt ? 1 : 0);
 215 }
 216
 217 #define LLOG_GEN_INC(gen)  ((gen).conn_cnt) ++
 218 #define LLOG_PROC_BREAK 0x0001
 219
 220 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
 221                                struct llog_operations **lop)
 222 {
 223         if (ctxt == NULL)
 224                 return -ENOTCONN;
 225
 226         *lop = ctxt->loc_logops;
 227         if (*lop == NULL)
 228                 return -EOPNOTSUPP;
 229
 230         return 0;
 231 }
 232
 233 static inline int llog_handle2ops(struct llog_handle *loghandle,
 234                                   struct llog_operations **lop)
 235 {
 236         if (loghandle == NULL)
 237                 return -EINVAL;
 238
 239         return llog_obd2ops(loghandle->lgh_ctxt, lop);
 240 }
 241
 242 static inline int llog_data_len(int len)
 243 {
 244         return size_round(len);
 245 }
 246
 247 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
 248                                                  int index)
 249 {
 250         if (index < 0 || index >= LLOG_MAX_CTXTS)
 251                 return NULL;
 252
 253         return obd->obd_llog_ctxt[index];
 254 }
 255
 256 static inline int llog_write_rec(struct llog_handle *handle,
 257                                  struct llog_rec_hdr *rec,
 258                                  struct llog_cookie *logcookies,
 259                                  int numcookies, void *buf, int idx)
 260 {
 261         struct llog_operations *lop;
 262         int rc, buflen;
 263         ENTRY;
 264
 265         rc = llog_handle2ops(handle, &lop);
 266         if (rc)
 267                 RETURN(rc);
 268         if (lop->lop_write_rec == NULL)
 269                 RETURN(-EOPNOTSUPP);
 270
 271         if (buf)
 272                 buflen = le32_to_cpu(rec->lrh_len) + sizeof(struct llog_rec_hdr)
 273                                 + sizeof(struct llog_rec_tail);
 274         else
 275                 buflen = le32_to_cpu(rec->lrh_len);
 276         LASSERT(size_round(buflen) == buflen);
 277
 278         rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
 279         RETURN(rc);
 280 }
 281
 282 static inline int llog_read_header(struct llog_handle *handle)
 283 {
 284         struct llog_operations *lop;
 285         int rc;
 286         ENTRY;
 287
 288         rc = llog_handle2ops(handle, &lop);
 289         if (rc)
 290                 RETURN(rc);
 291         if (lop->lop_read_header == NULL)
 292                 RETURN(-EOPNOTSUPP);
 293
 294         rc = lop->lop_read_header(handle);
 295         RETURN(rc);
 296 }
 297
 298 static inline int llog_destroy(struct llog_handle *handle)
 299 {
 300         struct llog_operations *lop;
 301         int rc;
 302         ENTRY;
 303
 304         rc = llog_handle2ops(handle, &lop);
 305         if (rc)
 306                 RETURN(rc);
 307         if (lop->lop_destroy == NULL)
 308                 RETURN(-EOPNOTSUPP);
 309
 310         rc = lop->lop_destroy(handle);
 311         RETURN(rc);
 312 }
 313
 314 #if 0
 315 static inline int llog_cancel(struct obd_export *exp,
 316                               struct lov_stripe_md *lsm, int count,
 317                               struct llog_cookie *cookies, int flags)
 318 {
 319         struct llog_operations *lop;
 320         int rc;
 321         ENTRY;
 322
 323         rc = llog_handle2ops(loghandle, &lop);
 324         if (rc)
 325                 RETURN(rc);
 326         if (lop->lop_cancel == NULL)
 327                 RETURN(-EOPNOTSUPP);
 328
 329         rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
 330         RETURN(rc);
 331 }
 332 #endif
 333
 334 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
 335                                   int next_idx, __u64 *cur_offset, void *buf,
 336                                   int len)
 337 {
 338         struct llog_operations *lop;
 339         int rc;
 340         ENTRY;
 341
 342         rc = llog_handle2ops(loghandle, &lop);
 343         if (rc)
 344                 RETURN(rc);
 345         if (lop->lop_next_block == NULL)
 346                 RETURN(-EOPNOTSUPP);
 347
 348         rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
 349                                  len);
 350         RETURN(rc);
 351 }
 352
 353 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
 354                               struct llog_logid *logid, char *name)
 355 {
 356         struct llog_operations *lop;
 357         int rc;
 358         ENTRY;
 359
 360         rc = llog_obd2ops(ctxt, &lop);
 361         if (rc)
 362                 RETURN(rc);
 363         if (lop->lop_create == NULL)
 364                 RETURN(-EOPNOTSUPP);
 365
 366         rc = lop->lop_create(ctxt, res, logid, name);
 367         RETURN(rc);
 368 }
 369
 370 static inline int llog_connect(struct llog_ctxt *ctxt, int count,
 371                                struct llog_logid *logid, struct llog_gen *gen)
 372 {
 373         struct llog_operations *lop;
 374         int rc;
 375         ENTRY;
 376
 377         rc = llog_obd2ops(ctxt, &lop);
 378         if (rc)
 379                 RETURN(rc);
 380         if (lop->lop_connect == NULL)
 381                 RETURN(-EOPNOTSUPP);
 382
 383         rc = lop->lop_connect(ctxt, count, logid, gen);
 384         RETURN(rc);
 385 }
 386
 387 #endif