/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*- * vim:expandtab:shiftwidth=8:tabstop=8: * * GPL HEADER START * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 only, * as published by the Free Software Foundation. * * This program 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 version 2 for more details (a copy is included * in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU General Public License * version 2 along with this program; If not, see [sun.com URL with a * copy of GPLv2]. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, * CA 95054 USA or visit www.sun.com if you need additional information or * have any questions. * * GPL HEADER END */ /* * Copyright 2008 Sun Microsystems, Inc. All rights reserved * Use is subject to license terms. */ /* * This file is part of Lustre, http://www.lustre.org/ * Lustre is a trademark of Sun Microsystems, Inc. * * lustre/include/lustre_log.h * * 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 #if defined(__linux__) #include #elif defined(__APPLE__) #include #elif defined(__WINNT__) #include #else #error Unsupported operating system. #endif #include #include #include #define LOG_NAME_LIMIT(logname, name) \ snprintf(logname, sizeof(logname), "LOGS/%s", name) #define LLOG_EEMPTY 4711 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; int lgh_cur_idx; /* used during llog_process */ __u64 lgh_cur_offset; /* used during llog_process */ struct llog_ctxt *lgh_ctxt; union { struct plain_handle_data phd; struct cat_handle_data chd; } u; }; /* llog.c - general API */ typedef int (*llog_cb_t)(struct llog_handle *, struct llog_rec_hdr *, void *); typedef int (*llog_fill_rec_cb_t)(struct llog_rec_hdr *rec, void *data); extern struct llog_handle *llog_alloc_handle(void); int llog_init_handle(struct llog_handle *handle, int flags, struct obd_uuid *uuid); extern void llog_free_handle(struct llog_handle *handle); int llog_process(struct llog_handle *loghandle, llog_cb_t cb, void *data, void *catdata); int llog_reverse_process(struct llog_handle *loghandle, llog_cb_t cb, void *data, void *catdata); extern int llog_cancel_rec(struct llog_handle *loghandle, int index); extern int llog_close(struct llog_handle *cathandle); extern int llog_get_size(struct llog_handle *loghandle); /* llog_cat.c - catalog api */ struct llog_process_data { /** * Any useful data needed while processing catalog. This is * passed later to process callback. */ void *lpd_data; /** * Catalog process callback function, called for each record * in catalog. */ llog_cb_t lpd_cb; }; struct llog_process_cat_data { /** * Temporary stored first_idx while scanning log. */ int lpcd_first_idx; /** * Temporary stored last_idx while scanning log. */ int lpcd_last_idx; }; struct llog_process_cat_args { /** * Llog context used in recovery thread on OST (recov_thread.c) */ struct llog_ctxt *lpca_ctxt; /** * Llog callback used in recovery thread on OST (recov_thread.c) */ void *lpca_cb; /** * Data pointer for llog callback. */ void *lpca_arg; }; 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); int llog_cat_process_thread(void *data); int llog_cat_reverse_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data); int llog_cat_set_first_idx(struct llog_handle *cathandle, int index); /* llog_obd.c */ int llog_setup(struct obd_device *obd, struct obd_llog_group *olg, int index, struct obd_device *disk_obd, int count, struct llog_logid *logid, struct llog_operations *op); int __llog_ctxt_put(struct llog_ctxt *ctxt); 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, struct obd_llog_group *olg, 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, struct obd_llog_group *olg, int count, struct obd_uuid *uuid); int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg, struct obd_device *disk_obd, int count, struct llog_catid *logid, struct obd_uuid *uuid); 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_catalog_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_gen *gen, struct obd_uuid *uuid); 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_obd_repl_connect(struct llog_ctxt *ctxt, int count, struct llog_logid *logid, struct llog_gen *gen, struct obd_uuid *uuid); 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_prev_block)(struct llog_handle *h, int prev_idx, 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, struct obd_llog_group *olg, 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_gen *gen, struct obd_uuid *uuid); /* XXX add 2 more: commit callbacks and llog recovery functions */ }; /* llog_lvfs.c */ extern struct llog_operations llog_lvfs_ops; int llog_get_cat_list(struct obd_device *obd, struct obd_device *disk_obd, char *name, int count, struct llog_catid *idarray); struct llog_ctxt { int loc_idx; /* my index the obd array of ctxt's */ struct llog_gen loc_gen; struct obd_device *loc_obd; /* points back to the containing obd*/ struct obd_llog_group *loc_olg; /* group containing that ctxt */ struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */ 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_commit_master *loc_lcm; struct llog_canceld_ctxt *loc_llcd; struct semaphore loc_sem; /* protects loc_llcd and loc_imp */ atomic_t loc_refcount; void *llog_proc_cb; }; #define LCM_NAME_SIZE 64 struct llog_commit_master { /** * Thread control flags (start, stop, etc.) */ long lcm_flags; /** * Number of llcds onthis lcm. */ atomic_t lcm_count; /** * Ptlrpc requests set. All cancel rpcs go via this request set. */ struct ptlrpc_request_set *lcm_set; /** * Thread control structure. Used for control commit thread. */ struct ptlrpcd_ctl lcm_pc; /** * Commit thread name buffer. Only used for thread start. */ char lcm_name[LCM_NAME_SIZE]; }; struct llog_canceld_ctxt { /** * Llog context this llcd is attached to. Used for accessing * ->loc_import and others in process of canceling cookies * gathered in this llcd. */ struct llog_ctxt *llcd_ctxt; /** * Cancel thread control stucture pointer. Used for accessing * it to see if should stop processing and other needs. */ struct llog_commit_master *llcd_lcm; /** * Maximal llcd size. Used in calculations on how much of room * left in llcd to cookie comming cookies. */ int llcd_size; /** * Current llcd size while gathering cookies. This should not be * more than ->llcd_size. Used for determining if we need to * send this llcd (if full) and allocate new one. This is also * used for copying new cookie at the end of buffer. */ int llcd_cookiebytes; /** * Pointer to the start of cookies buffer. */ struct llog_cookie llcd_cookies[0]; }; /* ptlrpc/recov_thread.c */ extern struct llog_commit_master *llog_recov_thread_init(char *name); extern void llog_recov_thread_fini(struct llog_commit_master *lcm, int force); extern int llog_recov_thread_start(struct llog_commit_master *lcm); extern void llog_recov_thread_stop(struct llog_commit_master *lcm, int force); #ifndef __KERNEL__ #define cap_raise(c, flag) do {} while(0) #define CAP_SYS_RESOURCE 24 #endif /* !__KERNEL__ */ static inline void llog_gen_init(struct llog_ctxt *ctxt) { struct obd_device *obd = ctxt->loc_exp->exp_obd; if (!strcmp(obd->obd_type->typ_name, LUSTRE_MDS_NAME)) ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count; else if (!strstr(obd->obd_type->typ_name, LUSTRE_OST_NAME)) ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count; else ctxt->loc_gen.mnt_cnt = 0; } static inline int llog_gen_lt(struct llog_gen a, struct llog_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); } #define LLOG_GEN_INC(gen) ((gen).conn_cnt ++) #define LLOG_PROC_BREAK 0x0001 #define LLOG_DEL_RECORD 0x0002 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) { return size_round(len); } static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt) { LASSERT(atomic_read(&ctxt->loc_refcount) > 0); atomic_inc(&ctxt->loc_refcount); CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt, atomic_read(&ctxt->loc_refcount)); return ctxt; } static inline void llog_ctxt_put(struct llog_ctxt *ctxt) { if (ctxt == NULL) return; LASSERT(atomic_read(&ctxt->loc_refcount) > 0); LASSERT(atomic_read(&ctxt->loc_refcount) < 0x5a5a5a); CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt, atomic_read(&ctxt->loc_refcount) - 1); __llog_ctxt_put(ctxt); } static inline void llog_group_init(struct obd_llog_group *olg, int group) { cfs_waitq_init(&olg->olg_waitq); spin_lock_init(&olg->olg_lock); olg->olg_group = group; } static inline void llog_group_set_export(struct obd_llog_group *olg, struct obd_export *exp) { LASSERT(exp != NULL); spin_lock(&olg->olg_lock); if (olg->olg_exp != NULL && olg->olg_exp != exp) CWARN("%s: export for group %d is changed: 0x%p -> 0x%p\n", exp->exp_obd->obd_name, olg->olg_group, olg->olg_exp, exp); olg->olg_exp = exp; spin_unlock(&olg->olg_lock); } static inline int llog_group_set_ctxt(struct obd_llog_group *olg, struct llog_ctxt *ctxt, int index) { LASSERT(index >= 0 && index < LLOG_MAX_CTXTS); spin_lock(&olg->olg_lock); if (olg->olg_ctxts[index] != NULL) { spin_unlock(&olg->olg_lock); return -EEXIST; } olg->olg_ctxts[index] = ctxt; spin_unlock(&olg->olg_lock); return 0; } static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg, int index) { struct llog_ctxt *ctxt; LASSERT(index >= 0 && index < LLOG_MAX_CTXTS); spin_lock(&olg->olg_lock); if (olg->olg_ctxts[index] == NULL) { ctxt = NULL; } else { ctxt = llog_ctxt_get(olg->olg_ctxts[index]); } spin_unlock(&olg->olg_lock); return ctxt; } static inline struct llog_ctxt *llog_get_context(struct obd_device *obd, int index) { return llog_group_get_ctxt(&obd->obd_olg, index); } static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index) { return (olg->olg_ctxts[index] == NULL); } static inline int llog_ctxt_null(struct obd_device *obd, int index) { return (llog_group_ctxt_null(&obd->obd_olg, 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; __u32 cap; int rc, buflen; ENTRY; rc = llog_handle2ops(handle, &lop); if (rc) RETURN(rc); LASSERT(lop); if (lop->lop_write_rec == NULL) RETURN(-EOPNOTSUPP); if (buf) buflen = rec->lrh_len + sizeof(struct llog_rec_hdr) + sizeof(struct llog_rec_tail); else buflen = rec->lrh_len; LASSERT(size_round(buflen) == buflen); cap = current->cap_effective; cap_raise(current->cap_effective, CAP_SYS_RESOURCE); rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx); current->cap_effective = cap; 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_prev_block(struct llog_handle *loghandle, int prev_idx, void *buf, int len) { struct llog_operations *lop; int rc; ENTRY; rc = llog_handle2ops(loghandle, &lop); if (rc) RETURN(rc); if (lop->lop_prev_block == NULL) RETURN(-EOPNOTSUPP); rc = lop->lop_prev_block(loghandle, prev_idx, 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; __u32 cap; int rc; ENTRY; rc = llog_obd2ops(ctxt, &lop); if (rc) RETURN(rc); if (lop->lop_create == NULL) RETURN(-EOPNOTSUPP); cap = current->cap_effective; cap_raise(current->cap_effective, CAP_SYS_RESOURCE); rc = lop->lop_create(ctxt, res, logid, name); current->cap_effective = cap; RETURN(rc); } static inline int llog_connect(struct llog_ctxt *ctxt, int count, struct llog_logid *logid, struct llog_gen *gen, struct obd_uuid *uuid) { 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, uuid); RETURN(rc); } #endif