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