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, struct obd_llogs *llogs, int index,
 122                struct obd_device *disk_obd, int count,  struct llog_logid *logid,
 123                struct llog_operations *op);
 124 int llog_cleanup(struct llog_ctxt *);
 125 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
 126 int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
 127              struct lov_stripe_md *lsm, struct llog_cookie *logcookies,
 128              int numcookies);
 129 int llog_cancel(struct llog_ctxt *, struct lov_stripe_md *lsm,
 130                 int count, struct llog_cookie *cookies, int flags);
 131
 132 int llog_obd_origin_setup(struct obd_device *obd, struct obd_llogs *llogs,
 133                           int index, struct obd_device *disk_obd, int count,
 134                           struct llog_logid *logid);
 135 int llog_obd_origin_cleanup(struct llog_ctxt *ctxt);
 136 int llog_obd_origin_add(struct llog_ctxt *ctxt,
 137                         struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
 138                         struct llog_cookie *logcookies, int numcookies);
 139
 140 int llog_cat_initialize(struct obd_device *obd, struct obd_llogs *llogs,
 141                         int count, struct obd_uuid *uuid);
 142 int obd_llog_init(struct obd_device *obd, struct obd_llogs *llogs,
 143                   struct obd_device *disk_obd, int count,
 144                   struct llog_catid *logid, struct obd_uuid *uuid);
 145
 146 int obd_llog_finish(struct obd_device *obd, int count);
 147
 148 /* llog_ioctl.c */
 149 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
 150 int llog_catalog_list(struct obd_device *obd, int count,
 151                       struct obd_ioctl_data *data);
 152
 153 /* llog_net.c */
 154 int llog_initiator_connect(struct llog_ctxt *ctxt);
 155 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
 156 int llog_origin_connect(struct llog_ctxt *ctxt, int count,
 157                         struct llog_logid *logid, struct llog_gen *gen,
 158                         struct obd_uuid *uuid);
 159 int llog_handle_connect(struct ptlrpc_request *req);
 160
 161 /* recov_thread.c */
 162 int llog_obd_repl_cancel(struct llog_ctxt *ctxt,
 163                          struct lov_stripe_md *lsm, int count,
 164                          struct llog_cookie *cookies, int flags);
 165 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
 166 int llog_repl_connect(struct llog_ctxt *ctxt, int count,
 167                       struct llog_logid *logid, struct llog_gen *gen,
 168                       struct obd_uuid *uuid);
 169
 170 struct llog_operations {
 171         int (*lop_write_rec)(struct llog_handle *loghandle,
 172                              struct llog_rec_hdr *rec,
 173                              struct llog_cookie *logcookies, int numcookies,
 174                              void *, int idx);
 175         int (*lop_destroy)(struct llog_handle *handle);
 176         int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
 177                               int next_idx, __u64 *offset, void *buf, int len);
 178         int (*lop_prev_block)(struct llog_handle *h,
 179                               int prev_idx, void *buf, int len);
 180         int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
 181                           struct llog_logid *logid, char *name);
 182         int (*lop_close)(struct llog_handle *handle);
 183         int (*lop_read_header)(struct llog_handle *handle);
 184
 185         int (*lop_setup)(struct obd_device *obd, struct obd_llogs *llogs,
 186                          int ctxt_idx, struct obd_device *disk_obd, int count,
 187                          struct llog_logid *logid);
 188         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp);
 189         int (*lop_cleanup)(struct llog_ctxt *ctxt);
 190         int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
 191                        struct lov_stripe_md *lsm,
 192                        struct llog_cookie *logcookies, int numcookies);
 193         int (*lop_cancel)(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm,
 194                           int count, struct llog_cookie *cookies, int flags);
 195         int (*lop_connect)(struct llog_ctxt *ctxt, int count,
 196                            struct llog_logid *logid, struct llog_gen *gen,
 197                            struct obd_uuid *uuid);
 198         /* XXX add 2 more: commit callbacks and llog recovery functions */
 199 };
 200
 201 /* llog_lvfs.c */
 202 extern struct llog_operations llog_lvfs_ops;
 203 int llog_get_cat_list(struct obd_device *obd, struct obd_device *disk_obd,
 204                       char *name, int count, struct llog_catid *idarray);
 205
 206 struct llog_ctxt {
 207         int                      loc_idx; /* my index the obd array of ctxt's */
 208         struct llog_gen          loc_gen;
 209         struct obd_device       *loc_obd; /* points back to the containing obd*/
 210         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
 211         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
 212                                              pointing import */
 213         struct llog_operations  *loc_logops;
 214         struct llog_handle      *loc_handle;
 215         struct llog_canceld_ctxt *loc_llcd;
 216         struct semaphore         loc_sem; /* protects loc_llcd and loc_imp */
 217         void                    *llog_proc_cb;
 218 };
 219
 220 #ifndef __KERNEL__
 221
 222 #define cap_raise(c, flag) do {} while(0)
 223
 224 #define CAP_SYS_RESOURCE 24
 225
 226 #endif   /* !__KERNEL__ */
 227
 228 static inline void llog_gen_init(struct llog_ctxt *ctxt)
 229 {
 230         struct obd_device *obd = ctxt->loc_exp->exp_obd;
 231
 232         if (!strcmp(obd->obd_type->typ_name, LUSTRE_MDS_NAME))
 233                 ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count;
 234         else if (!strstr(obd->obd_type->typ_name, LUSTRE_OST_NAME))
 235                 ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count;
 236         else
 237                 ctxt->loc_gen.mnt_cnt = 0;
 238 }
 239
 240 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
 241 {
 242         if (a.mnt_cnt < b.mnt_cnt)
 243                 return 1;
 244         if (a.mnt_cnt > b.mnt_cnt)
 245                 return 0;
 246         return(a.conn_cnt < b.conn_cnt ? 1 : 0);
 247 }
 248
 249 #define LLOG_GEN_INC(gen)  ((gen).conn_cnt ++)
 250 #define LLOG_PROC_BREAK 0x0001
 251 #define LLOG_DEL_RECORD 0x0002
 252
 253 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
 254                                struct llog_operations **lop)
 255 {
 256         if (ctxt == NULL)
 257                 return -ENOTCONN;
 258
 259         *lop = ctxt->loc_logops;
 260         if (*lop == NULL)
 261                 return -EOPNOTSUPP;
 262
 263         return 0;
 264 }
 265
 266 static inline int llog_handle2ops(struct llog_handle *loghandle,
 267                                   struct llog_operations **lop)
 268 {
 269         if (loghandle == NULL)
 270                 return -EINVAL;
 271
 272         return llog_obd2ops(loghandle->lgh_ctxt, lop);
 273 }
 274
 275 static inline int llog_data_len(int len)
 276 {
 277         return size_round(len);
 278 }
 279
 280 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
 281                                                  int index)
 282 {
 283         if (index < 0 || index >= LLOG_MAX_CTXTS)
 284                 return NULL;
 285
 286         return obd->obd_llog_ctxt[index];
 287 }
 288
 289 static inline struct llog_ctxt *
 290 llog_get_context_from_llogs(struct obd_llogs *llogs, int index)
 291 {
 292         if (index < 0 || index >= LLOG_MAX_CTXTS)
 293                 return NULL;
 294         return llogs->llog_ctxt[index];
 295 }
 296
 297 static inline int llog_write_rec(struct llog_handle *handle,
 298                                  struct llog_rec_hdr *rec,
 299                                  struct llog_cookie *logcookies,
 300                                  int numcookies, void *buf, int idx)
 301 {
 302         struct llog_operations *lop;
 303         __u32 cap;
 304         int rc, buflen;
 305         ENTRY;
 306
 307         rc = llog_handle2ops(handle, &lop);
 308         if (rc)
 309                 RETURN(rc);
 310         LASSERT(lop);
 311         if (lop->lop_write_rec == NULL)
 312                 RETURN(-EOPNOTSUPP);
 313
 314         if (buf)
 315                 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr)
 316                                 + sizeof(struct llog_rec_tail);
 317         else
 318                 buflen = rec->lrh_len;
 319         LASSERT(size_round(buflen) == buflen);
 320
 321         cap = current->cap_effective;
 322         cap_raise(current->cap_effective, CAP_SYS_RESOURCE);
 323         rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
 324         current->cap_effective = cap;
 325         RETURN(rc);
 326 }
 327
 328 static inline int llog_read_header(struct llog_handle *handle)
 329 {
 330         struct llog_operations *lop;
 331         int rc;
 332         ENTRY;
 333
 334         rc = llog_handle2ops(handle, &lop);
 335         if (rc)
 336                 RETURN(rc);
 337         if (lop->lop_read_header == NULL)
 338                 RETURN(-EOPNOTSUPP);
 339
 340         rc = lop->lop_read_header(handle);
 341         RETURN(rc);
 342 }
 343
 344 static inline int llog_destroy(struct llog_handle *handle)
 345 {
 346         struct llog_operations *lop;
 347         int rc;
 348         ENTRY;
 349
 350         rc = llog_handle2ops(handle, &lop);
 351         if (rc)
 352                 RETURN(rc);
 353         if (lop->lop_destroy == NULL)
 354                 RETURN(-EOPNOTSUPP);
 355
 356         rc = lop->lop_destroy(handle);
 357         RETURN(rc);
 358 }
 359
 360 #if 0
 361 static inline int llog_cancel(struct obd_export *exp,
 362                               struct lov_stripe_md *lsm, int count,
 363                               struct llog_cookie *cookies, int flags)
 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_cancel == NULL)
 373                 RETURN(-EOPNOTSUPP);
 374
 375         rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
 376         RETURN(rc);
 377 }
 378 #endif
 379
 380 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
 381                                   int next_idx, __u64 *cur_offset, void *buf,
 382                                   int len)
 383 {
 384         struct llog_operations *lop;
 385         int rc;
 386         ENTRY;
 387
 388         rc = llog_handle2ops(loghandle, &lop);
 389         if (rc)
 390                 RETURN(rc);
 391         if (lop->lop_next_block == NULL)
 392                 RETURN(-EOPNOTSUPP);
 393
 394         rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
 395                                  len);
 396         RETURN(rc);
 397 }
 398
 399 static inline int llog_prev_block(struct llog_handle *loghandle,
 400                                   int prev_idx, void *buf, int len)
 401 {
 402         struct llog_operations *lop;
 403         int rc;
 404         ENTRY;
 405
 406         rc = llog_handle2ops(loghandle, &lop);
 407         if (rc)
 408                 RETURN(rc);
 409         if (lop->lop_prev_block == NULL)
 410                 RETURN(-EOPNOTSUPP);
 411
 412         rc = lop->lop_prev_block(loghandle, prev_idx, buf, len);
 413         RETURN(rc);
 414 }
 415
 416 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
 417                               struct llog_logid *logid, char *name)
 418 {
 419         struct llog_operations *lop;
 420         __u32 cap;
 421         int rc;
 422         ENTRY;
 423
 424         rc = llog_obd2ops(ctxt, &lop);
 425         if (rc)
 426                 RETURN(rc);
 427         if (lop->lop_create == NULL)
 428                 RETURN(-EOPNOTSUPP);
 429
 430         cap = current->cap_effective;
 431         cap_raise(current->cap_effective, CAP_SYS_RESOURCE);
 432         rc = lop->lop_create(ctxt, res, logid, name);
 433         current->cap_effective = cap;
 434         RETURN(rc);
 435 }
 436
 437 static inline int llog_connect(struct llog_ctxt *ctxt, int count,
 438                                struct llog_logid *logid, struct llog_gen *gen,
 439                                struct obd_uuid *uuid)
 440 {
 441         struct llog_operations *lop;
 442         int rc;
 443         ENTRY;
 444
 445         rc = llog_obd2ops(ctxt, &lop);
 446         if (rc)
 447                 RETURN(rc);
 448         if (lop->lop_connect == NULL)
 449                 RETURN(-EOPNOTSUPP);
 450
 451         rc = lop->lop_connect(ctxt, count, logid, gen, uuid);
 452         RETURN(rc);
 453 }
 454
 455 #endif