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_catid *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                         struct obd_uuid *uuid);
 139 int llog_handle_connect(struct ptlrpc_request *req);
 140
 141 /* recov_thread.c */
 142 int llog_obd_repl_cancel(struct llog_ctxt *ctxt,
 143                          struct lov_stripe_md *lsm, int count,
 144                          struct llog_cookie *cookies, int flags);
 145 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
 146 int llog_repl_connect(struct llog_ctxt *ctxt, int count,
 147                       struct llog_logid *logid, struct llog_gen *gen,
 148                       struct obd_uuid *uuid);
 149
 150 struct llog_operations {
 151         int (*lop_write_rec)(struct llog_handle *loghandle,
 152                              struct llog_rec_hdr *rec,
 153                              struct llog_cookie *logcookies, int numcookies,
 154                              void *, int idx);
 155         int (*lop_destroy)(struct llog_handle *handle);
 156         int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
 157                               int next_idx, __u64 *offset, void *buf, int len);
 158         int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
 159                           struct llog_logid *logid, char *name);
 160         int (*lop_close)(struct llog_handle *handle);
 161         int (*lop_read_header)(struct llog_handle *handle);
 162
 163         int (*lop_setup)(struct obd_device *obd, int ctxt_idx,
 164                          struct obd_device *disk_obd, int count,
 165                          struct llog_logid *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 };
 197
 198 static inline void llog_gen_init(struct llog_ctxt *ctxt)
 199 {
 200         struct obd_device *obd = ctxt->loc_exp->exp_obd;
 201
 202         if (!strcmp(obd->obd_type->typ_name, "mds"))
 203                 ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count;
 204         else if (!strstr(obd->obd_type->typ_name, "filter"))
 205                 ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count;
 206         else
 207                 ctxt->loc_gen.mnt_cnt = 0;
 208 }
 209
 210 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
 211 {
 212         if (a.mnt_cnt < b.mnt_cnt)
 213                 return 1;
 214         if (a.mnt_cnt > b.mnt_cnt)
 215                 return 0;
 216         return(a.conn_cnt < b.conn_cnt ? 1 : 0);
 217 }
 218
 219 #define LLOG_GEN_INC(gen)  ((gen).conn_cnt) ++
 220 #define LLOG_PROC_BREAK 0x0001
 221
 222 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
 223                                struct llog_operations **lop)
 224 {
 225        if (ctxt == NULL)
 226                 return -ENOTCONN;
 227
 228         *lop = ctxt->loc_logops;
 229         if (*lop == NULL)
 230                 return -EOPNOTSUPP;
 231
 232         return 0;
 233 }
 234
 235 static inline int llog_handle2ops(struct llog_handle *loghandle,
 236                                   struct llog_operations **lop)
 237 {
 238         if (loghandle == NULL)
 239                 return -EINVAL;
 240
 241         return llog_obd2ops(loghandle->lgh_ctxt, lop);
 242 }
 243
 244 static inline int llog_data_len(int len)
 245 {
 246         return size_round(len);
 247 }
 248
 249 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
 250                                                  int index)
 251 {
 252         if (index < 0 || index >= LLOG_MAX_CTXTS)
 253                 return NULL;
 254
 255         return obd->obd_llog_ctxt[index];
 256 }
 257
 258 static inline int llog_write_rec(struct llog_handle *handle,
 259                                  struct llog_rec_hdr *rec,
 260                                  struct llog_cookie *logcookies,
 261                                  int numcookies, void *buf, int idx)
 262 {
 263         struct llog_operations *lop;
 264         int rc, buflen;
 265         ENTRY;
 266
 267         rc = llog_handle2ops(handle, &lop);
 268         if (rc)
 269                 RETURN(rc);
 270         if (lop->lop_write_rec == NULL)
 271                 RETURN(-EOPNOTSUPP);
 272
 273         if (buf)
 274                 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr)
 275                                 + sizeof(struct llog_rec_tail);
 276         else
 277                 buflen = rec->lrh_len;
 278         LASSERT(size_round(buflen) == buflen);
 279
 280         rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
 281         RETURN(rc);
 282 }
 283
 284 static inline int llog_read_header(struct llog_handle *handle)
 285 {
 286         struct llog_operations *lop;
 287         int rc;
 288         ENTRY;
 289
 290         rc = llog_handle2ops(handle, &lop);
 291         if (rc)
 292                 RETURN(rc);
 293         if (lop->lop_read_header == NULL)
 294                 RETURN(-EOPNOTSUPP);
 295
 296         rc = lop->lop_read_header(handle);
 297         RETURN(rc);
 298 }
 299
 300 static inline int llog_destroy(struct llog_handle *handle)
 301 {
 302         struct llog_operations *lop;
 303         int rc;
 304         ENTRY;
 305
 306         rc = llog_handle2ops(handle, &lop);
 307         if (rc)
 308                 RETURN(rc);
 309         if (lop->lop_destroy == NULL)
 310                 RETURN(-EOPNOTSUPP);
 311
 312         rc = lop->lop_destroy(handle);
 313         RETURN(rc);
 314 }
 315
 316 #if 0
 317 static inline int llog_cancel(struct obd_export *exp,
 318                               struct lov_stripe_md *lsm, int count,
 319                               struct llog_cookie *cookies, int flags)
 320 {
 321         struct llog_operations *lop;
 322         int rc;
 323         ENTRY;
 324
 325         rc = llog_handle2ops(loghandle, &lop);
 326         if (rc)
 327                 RETURN(rc);
 328         if (lop->lop_cancel == NULL)
 329                 RETURN(-EOPNOTSUPP);
 330
 331         rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
 332         RETURN(rc);
 333 }
 334 #endif
 335
 336 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
 337                                   int next_idx, __u64 *cur_offset, void *buf,
 338                                   int len)
 339 {
 340         struct llog_operations *lop;
 341         int rc;
 342         ENTRY;
 343
 344         rc = llog_handle2ops(loghandle, &lop);
 345         if (rc)
 346                 RETURN(rc);
 347         if (lop->lop_next_block == NULL)
 348                 RETURN(-EOPNOTSUPP);
 349
 350         rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
 351                                  len);
 352         RETURN(rc);
 353 }
 354
 355 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
 356                               struct llog_logid *logid, char *name)
 357 {
 358         struct llog_operations *lop;
 359         int rc;
 360         ENTRY;
 361
 362         rc = llog_obd2ops(ctxt, &lop);
 363         if (rc)
 364                 RETURN(rc);
 365         if (lop->lop_create == NULL)
 366                 RETURN(-EOPNOTSUPP);
 367
 368         rc = lop->lop_create(ctxt, res, logid, name);
 369         RETURN(rc);
 370 }
 371
 372 static inline int llog_connect(struct llog_ctxt *ctxt, int count,
 373                                struct llog_logid *logid, struct llog_gen *gen,
 374                                struct obd_uuid *uuid)
 375 {
 376         struct llog_operations *lop;
 377         int rc;
 378         ENTRY;
 379
 380         rc = llog_obd2ops(ctxt, &lop);
 381         if (rc)
 382                 RETURN(rc);
 383         if (lop->lop_connect == NULL)
 384                 RETURN(-EOPNOTSUPP);
 385
 386         rc = lop->lop_connect(ctxt, count, logid, gen, uuid);
 387         RETURN(rc);
 388 }
 389
 390 #endif