1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001 Cluster File Systems, Inc. <info@clusterfs.com>
6 * This file is part of Lustre, http://www.lustre.org.
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.
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.
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.
21 * Generic infrastructure for managing a collection of logs.
23 * These logs are used for:
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
29 * - mds unlink log: the MDS adds an entry upon delete
31 * - raid1 replication log between OST's
32 * - MDS replication logs
38 #include <linux/obd.h>
39 #include <linux/lustre_idl.h>
41 #define LOG_NAME_LIMIT(logname, name) \
42 snprintf(logname, sizeof(logname), "LOGS/%s", name)
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 */
51 struct cat_handle_data {
52 struct list_head chd_head;
53 struct llog_handle *chd_current_log; /* currently open log */
56 /* In-memory descriptor for a log object or log catalog */
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;
63 struct llog_ctxt *lgh_ctxt;
65 struct plain_handle_data phd;
66 struct cat_handle_data chd;
70 #define LLOG_EEMPTY 4711
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,
77 void *data, void *catdata);
78 extern struct llog_handle *llog_alloc_handle(void);
79 extern void llog_free_handle(struct llog_handle *handle);
80 extern int llog_close(struct llog_handle *cathandle);
81 extern int llog_cancel_rec(struct llog_handle *loghandle, int index);
83 /* llog_cat.c - catalog api */
84 struct llog_process_data {
89 struct llog_process_cat_data {
92 /* to process catlog across zero record */
95 int llog_cat_put(struct llog_handle *cathandle);
96 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
97 struct llog_cookie *reccookie, void *buf);
98 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
99 struct llog_cookie *cookies);
100 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
101 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index);
104 int llog_setup(struct obd_device *obd, int index, struct obd_device *disk_obd,
105 int count, struct llog_logid *logid,struct llog_operations *op);
106 int llog_cleanup(struct llog_ctxt *);
107 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
108 int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
109 struct lov_stripe_md *lsm, struct llog_cookie *logcookies,
111 int llog_cancel(struct llog_ctxt *, struct lov_stripe_md *lsm,
112 int count, struct llog_cookie *cookies, int flags);
114 int llog_obd_origin_setup(struct obd_device *obd, int index,
115 struct obd_device *disk_obd, int count,
116 struct llog_logid *logid);
117 int llog_obd_origin_cleanup(struct llog_ctxt *ctxt);
118 int llog_obd_origin_add(struct llog_ctxt *ctxt,
119 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
120 struct llog_cookie *logcookies, int numcookies);
122 int llog_cat_initialize(struct obd_device *obd, int count);
123 int obd_llog_init(struct obd_device *obd, struct obd_device *disk_obd,
124 int count, struct llog_catid *logid);
126 int obd_llog_finish(struct obd_device *obd, int count);
129 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
130 int llog_catlog_list(struct obd_device *obd, int count,
131 struct obd_ioctl_data *data);
134 int llog_initiator_connect(struct llog_ctxt *ctxt);
135 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
136 int llog_origin_connect(struct llog_ctxt *ctxt, int count,
137 struct llog_logid *logid, struct llog_gen *gen,
138 struct obd_uuid *uuid);
139 int llog_handle_connect(struct ptlrpc_request *req);
142 int llog_obd_repl_cancel(struct llog_ctxt *ctxt,
143 struct lov_stripe_md *lsm, int count,
144 struct llog_cookie *cookies, int flags);
145 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
146 int llog_repl_connect(struct llog_ctxt *ctxt, int count,
147 struct llog_logid *logid, struct llog_gen *gen,
148 struct obd_uuid *uuid);
150 struct llog_operations {
151 int (*lop_write_rec)(struct llog_handle *loghandle,
152 struct llog_rec_hdr *rec,
153 struct llog_cookie *logcookies, int numcookies,
155 int (*lop_destroy)(struct llog_handle *handle);
156 int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
157 int next_idx, __u64 *offset, void *buf, int len);
158 int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
159 struct llog_logid *logid, char *name);
160 int (*lop_close)(struct llog_handle *handle);
161 int (*lop_read_header)(struct llog_handle *handle);
163 int (*lop_setup)(struct obd_device *obd, int ctxt_idx,
164 struct obd_device *disk_obd, int count,
165 struct llog_logid *logid);
166 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp);
167 int (*lop_cleanup)(struct llog_ctxt *ctxt);
168 int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
169 struct lov_stripe_md *lsm,
170 struct llog_cookie *logcookies, int numcookies);
171 int (*lop_cancel)(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm,
172 int count, struct llog_cookie *cookies, int flags);
173 int (*lop_connect)(struct llog_ctxt *ctxt, int count,
174 struct llog_logid *logid, struct llog_gen *gen,
175 struct obd_uuid *uuid);
176 /* XXX add 2 more: commit callbacks and llog recovery functions */
180 extern struct llog_operations llog_lvfs_ops;
181 int llog_get_cat_list(struct obd_device *obd, struct obd_device *disk_obd,
182 char *name, int count, struct llog_catid *idarray);
185 int loc_idx; /* my index the obd array of ctxt's */
186 struct llog_gen loc_gen;
187 struct obd_device *loc_obd; /* points back to the containing obd*/
188 struct obd_export *loc_exp;
189 struct obd_import *loc_imp; /* to use in RPC's: can be backward
191 struct llog_operations *loc_logops;
192 struct llog_handle *loc_handle;
193 struct llog_canceld_ctxt *loc_llcd;
194 struct semaphore loc_sem; /* protects loc_llcd */
198 static inline void llog_gen_init(struct llog_ctxt *ctxt)
200 struct obd_device *obd = ctxt->loc_exp->exp_obd;
202 if (!strcmp(obd->obd_type->typ_name, "mds"))
203 ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count;
204 else if (!strstr(obd->obd_type->typ_name, "filter"))
205 ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count;
207 ctxt->loc_gen.mnt_cnt = 0;
210 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
212 if (a.mnt_cnt < b.mnt_cnt)
214 if (a.mnt_cnt > b.mnt_cnt)
216 return(a.conn_cnt < b.conn_cnt ? 1 : 0);
219 #define LLOG_GEN_INC(gen) ((gen).conn_cnt) ++
220 #define LLOG_PROC_BREAK 0x0001
222 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
223 struct llog_operations **lop)
228 *lop = ctxt->loc_logops;
235 static inline int llog_handle2ops(struct llog_handle *loghandle,
236 struct llog_operations **lop)
238 if (loghandle == NULL)
241 return llog_obd2ops(loghandle->lgh_ctxt, lop);
244 static inline int llog_data_len(int len)
246 return size_round(len);
249 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
252 if (index < 0 || index >= LLOG_MAX_CTXTS)
255 return obd->obd_llog_ctxt[index];
258 static inline int llog_write_rec(struct llog_handle *handle,
259 struct llog_rec_hdr *rec,
260 struct llog_cookie *logcookies,
261 int numcookies, void *buf, int idx)
263 struct llog_operations *lop;
267 rc = llog_handle2ops(handle, &lop);
270 if (lop->lop_write_rec == NULL)
274 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr)
275 + sizeof(struct llog_rec_tail);
277 buflen = rec->lrh_len;
278 LASSERT(size_round(buflen) == buflen);
280 rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
284 static inline int llog_read_header(struct llog_handle *handle)
286 struct llog_operations *lop;
290 rc = llog_handle2ops(handle, &lop);
293 if (lop->lop_read_header == NULL)
296 rc = lop->lop_read_header(handle);
300 static inline int llog_destroy(struct llog_handle *handle)
302 struct llog_operations *lop;
306 rc = llog_handle2ops(handle, &lop);
309 if (lop->lop_destroy == NULL)
312 rc = lop->lop_destroy(handle);
317 static inline int llog_cancel(struct obd_export *exp,
318 struct lov_stripe_md *lsm, int count,
319 struct llog_cookie *cookies, int flags)
321 struct llog_operations *lop;
325 rc = llog_handle2ops(loghandle, &lop);
328 if (lop->lop_cancel == NULL)
331 rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
336 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
337 int next_idx, __u64 *cur_offset, void *buf,
340 struct llog_operations *lop;
344 rc = llog_handle2ops(loghandle, &lop);
347 if (lop->lop_next_block == NULL)
350 rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
355 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
356 struct llog_logid *logid, char *name)
358 struct llog_operations *lop;
362 rc = llog_obd2ops(ctxt, &lop);
365 if (lop->lop_create == NULL)
368 rc = lop->lop_create(ctxt, res, logid, name);
372 static inline int llog_connect(struct llog_ctxt *ctxt, int count,
373 struct llog_logid *logid, struct llog_gen *gen,
374 struct obd_uuid *uuid)
376 struct llog_operations *lop;
380 rc = llog_obd2ops(ctxt, &lop);
383 if (lop->lop_connect == NULL)
386 rc = lop->lop_connect(ctxt, count, logid, gen, uuid);