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