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