/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*- * vim:expandtab:shiftwidth=8:tabstop=8: * * Copyright (C) 2001 Cluster File Systems, Inc. * * This file is part of Lustre, http://www.lustre.org. * * Lustre is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. * * Lustre is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Lustre; if not, write to the Free Software * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. * * Generic infrastructure for managing a collection of logs. * * These logs are used for: * * - orphan recovery: OST adds record on create * - mtime/size consistency: the OST adds a record on first write * - open/unlinked objects: OST adds a record on destroy * * - mds unlink log: the MDS adds an entry upon delete * * - raid1 replication log between OST's * - MDS replication logs */ #ifndef _LUSTRE_LOG_H #define _LUSTRE_LOG_H #include #include #define LOG_NAME_LIMIT(logname, name) \ snprintf(logname, sizeof(logname), "LOGS/%s", name) struct plain_handle_data { struct list_head phd_entry; struct llog_handle *phd_cat_handle; struct llog_cookie phd_cookie; /* cookie of this log in its cat */ int phd_last_idx; }; struct cat_handle_data { struct list_head chd_head; struct llog_handle *chd_current_log; /* currently open log */ }; /* In-memory descriptor for a log object or log catalog */ struct llog_handle { struct rw_semaphore lgh_lock; struct llog_logid lgh_id; /* id of this log */ struct llog_log_hdr *lgh_hdr; struct file *lgh_file; int lgh_last_idx; struct llog_ctxt *lgh_ctxt; union { struct plain_handle_data phd; struct cat_handle_data chd; } u; }; #define LLOG_EEMPTY 4711 /* llog.c - general API */ typedef int (*llog_cb_t)(struct llog_handle *, struct llog_rec_hdr *, void *); int llog_init_handle(struct llog_handle *handle, int flags, struct obd_uuid *uuid); int llog_process(struct llog_handle *loghandle, llog_cb_t cb, void *data); extern struct llog_handle *llog_alloc_handle(void); extern void llog_free_handle(struct llog_handle *handle); extern int llog_close(struct llog_handle *cathandle); extern int llog_cancel_rec(struct llog_handle *loghandle, int index); /* llog_cat.c - catalog api */ struct llog_process_data { void *lpd_data; llog_cb_t lpd_cb; }; int llog_cat_put(struct llog_handle *cathandle); int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec, struct llog_cookie *reccookie, void *buf); int llog_cat_cancel_records(struct llog_handle *cathandle, int count, struct llog_cookie *cookies); int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data); /* llog_obd.c */ int llog_setup(struct obd_device *obd, int index, struct obd_device *disk_obd, int count, struct llog_logid *logid, struct llog_operations *op); int llog_cleanup(struct llog_ctxt *); int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp); int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec, struct lov_stripe_md *lsm, struct llog_cookie *logcookies, int numcookies); int llog_cancel(struct llog_ctxt *, struct lov_stripe_md *lsm, int count, struct llog_cookie *cookies, int flags); int llog_obd_origin_setup(struct obd_device *obd, int index, struct obd_device *disk_obd, int count, struct llog_logid *logid); int llog_obd_origin_cleanup(struct llog_ctxt *ctxt); int llog_obd_origin_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec, struct lov_stripe_md *lsm, struct llog_cookie *logcookies, int numcookies); int llog_cat_initialize(struct obd_device *obd, int count); int obd_llog_init(struct obd_device *obd, struct obd_device *disk_obd, int count, struct llog_logid *logid); int obd_llog_finish(struct obd_device *obd, int count); /* llog_ioctl.c */ int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data); int llog_catlog_list(struct obd_device *obd, int count, struct obd_ioctl_data *data); /* llog_net.c */ int llog_initiator_connect(struct llog_ctxt *ctxt); int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp); int llog_origin_connect(struct llog_ctxt *ctxt, int count, struct llog_logid *logid, struct llog_ctxt_gen *gen); int llog_handle_connect(struct ptlrpc_request *req); /* recov_thread.c */ int llog_obd_repl_cancel(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm, int count, struct llog_cookie *cookies, int flags); int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp); int llog_repl_connect(struct llog_ctxt *ctxt, int count, struct llog_logid *logid, struct llog_ctxt_gen *gen); struct llog_operations { int (*lop_write_rec)(struct llog_handle *loghandle, struct llog_rec_hdr *rec, struct llog_cookie *logcookies, int numcookies, void *, int idx); int (*lop_destroy)(struct llog_handle *handle); int (*lop_next_block)(struct llog_handle *h, int *curr_idx, int next_idx, __u64 *offset, void *buf, int len); int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **, struct llog_logid *logid, char *name); int (*lop_close)(struct llog_handle *handle); int (*lop_read_header)(struct llog_handle *handle); int (*lop_setup)(struct obd_device *obd, int ctxt_idx, struct obd_device *disk_obd, int count, struct llog_logid *logid); int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp); int (*lop_cleanup)(struct llog_ctxt *ctxt); int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec, struct lov_stripe_md *lsm, struct llog_cookie *logcookies, int numcookies); int (*lop_cancel)(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm, int count, struct llog_cookie *cookies, int flags); int (*lop_connect)(struct llog_ctxt *ctxt, int count, struct llog_logid *logid, struct llog_ctxt_gen *gen); /* XXX add 2 more: commit callbacks and llog recovery functions */ }; extern struct llog_operations llog_lvfs_ops; struct llog_ctxt { int loc_idx; /* my index the obd array of ctxt's */ struct llog_ctxt_gen loc_gen; struct obd_device *loc_obd; /* points back to the containing obd*/ struct obd_export *loc_exp; struct obd_import *loc_imp; /* to use in RPC's: can be backward pointing import */ struct llog_operations *loc_logops; struct llog_handle *loc_handle; struct llog_canceld_ctxt *loc_llcd; struct semaphore loc_sem; /* protects loc_llcd */ void *llog_proc_cb; }; static inline void log_gen_init(struct llog_ctxt *ctxt) { struct obd_device *obd = ctxt->loc_exp->exp_obd; if (!strcmp(obd->obd_type->typ_name, "mds")) ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count; else if (!strstr(obd->obd_type->typ_name, "filter")) { ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count; } else ctxt->loc_gen.mnt_cnt = 0; } static inline int log_gen_lt(struct llog_ctxt_gen a, struct llog_ctxt_gen b) { if (a.mnt_cnt < b.mnt_cnt) return 1; if (a.mnt_cnt > b.mnt_cnt) return 0; return(a.conn_cnt < b.conn_cnt ? 1 : 0); } static inline int llog_obd2ops(struct llog_ctxt *ctxt, struct llog_operations **lop) { if (ctxt == NULL) return -ENOTCONN; *lop = ctxt->loc_logops; if (*lop == NULL) return -EOPNOTSUPP; return 0; } static inline int llog_handle2ops(struct llog_handle *loghandle, struct llog_operations **lop) { if (loghandle == NULL) return -EINVAL; return llog_obd2ops(loghandle->lgh_ctxt, lop); } static inline int llog_data_len(int len) { int mask = LLOG_MIN_REC_SIZE - 1; int remains = LLOG_MIN_REC_SIZE - sizeof(struct llog_rec_hdr) - sizeof(struct llog_rec_tail); return (len <= remains) ? remains : (((len + mask) & (~mask)) + remains); } static inline struct llog_ctxt *llog_get_context(struct obd_device *obd, int index) { if (index < 0 || index >= LLOG_MAX_CTXTS) return NULL; else return obd->obd_llog_ctxt[index]; } static inline int llog_write_rec(struct llog_handle *handle, struct llog_rec_hdr *rec, struct llog_cookie *logcookies, int numcookies, void *buf, int idx) { struct llog_operations *lop; int rc, buflen; ENTRY; rc = llog_handle2ops(handle, &lop); if (rc) RETURN(rc); if (lop->lop_write_rec == NULL) RETURN(-EOPNOTSUPP); if (buf) buflen = le32_to_cpu(rec->lrh_len) + sizeof(struct llog_rec_hdr) + sizeof(struct llog_rec_tail); else buflen = le32_to_cpu(rec->lrh_len); LASSERT((buflen % LLOG_MIN_REC_SIZE) == 0); rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx); RETURN(rc); } static inline int llog_read_header(struct llog_handle *handle) { struct llog_operations *lop; int rc; ENTRY; rc = llog_handle2ops(handle, &lop); if (rc) RETURN(rc); if (lop->lop_read_header == NULL) RETURN(-EOPNOTSUPP); rc = lop->lop_read_header(handle); RETURN(rc); } static inline int llog_destroy(struct llog_handle *handle) { struct llog_operations *lop; int rc; ENTRY; rc = llog_handle2ops(handle, &lop); if (rc) RETURN(rc); if (lop->lop_destroy == NULL) RETURN(-EOPNOTSUPP); rc = lop->lop_destroy(handle); RETURN(rc); } #if 0 static inline int llog_cancel(struct obd_export *exp, struct lov_stripe_md *lsm, int count, struct llog_cookie *cookies, int flags) { struct llog_operations *lop; int rc; ENTRY; rc = llog_handle2ops(loghandle, &lop); if (rc) RETURN(rc); if (lop->lop_cancel == NULL) RETURN(-EOPNOTSUPP); rc = lop->lop_cancel(exp, lsm, count, cookies, flags); RETURN(rc); } #endif static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx, int next_idx, __u64 *cur_offset, void *buf, int len) { struct llog_operations *lop; int rc; ENTRY; rc = llog_handle2ops(loghandle, &lop); if (rc) RETURN(rc); if (lop->lop_next_block == NULL) RETURN(-EOPNOTSUPP); rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf, len); RETURN(rc); } static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res, struct llog_logid *logid, char *name) { struct llog_operations *lop; int rc; ENTRY; rc = llog_obd2ops(ctxt, &lop); if (rc) RETURN(rc); if (lop->lop_create == NULL) RETURN(-EOPNOTSUPP); rc = lop->lop_create(ctxt, res, logid, name); RETURN(rc); } static inline int llog_connect(struct llog_ctxt *ctxt, int count, struct llog_logid *logid, struct llog_ctxt_gen *gen) { struct llog_operations *lop; int rc; ENTRY; rc = llog_obd2ops(ctxt, &lop); if (rc) RETURN(rc); if (lop->lop_connect == NULL) RETURN(-EOPNOTSUPP); rc = lop->lop_connect(ctxt, count, logid, gen); RETURN(rc); } #endif