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