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)
46 struct plain_handle_data {
47 struct list_head phd_entry;
48 struct llog_handle *phd_cat_handle;
49 struct llog_cookie phd_cookie; /* cookie of this log in its cat */
53 struct cat_handle_data {
54 struct list_head chd_head;
55 struct llog_handle *chd_current_log; /* currently open log */
58 /* In-memory descriptor for a log object or log catalog */
60 struct rw_semaphore lgh_lock;
61 struct llog_logid lgh_id; /* id of this log */
62 struct llog_log_hdr *lgh_hdr;
63 struct file *lgh_file;
65 struct llog_ctxt *lgh_ctxt;
67 struct plain_handle_data phd;
68 struct cat_handle_data chd;
72 #define LLOG_EEMPTY 4711
74 /* llog.c - general API */
75 typedef int (*llog_cb_t)(struct llog_handle *, struct llog_rec_hdr *, void *);
76 int llog_init_handle(struct llog_handle *handle, int flags,
77 struct obd_uuid *uuid);
78 int llog_process(struct llog_handle *loghandle, llog_cb_t cb,
79 void *data, void *catdata);
80 extern struct llog_handle *llog_alloc_handle(void);
81 extern void llog_free_handle(struct llog_handle *handle);
82 extern int llog_close(struct llog_handle *cathandle);
83 extern int llog_cancel_rec(struct llog_handle *loghandle, int index);
85 /* llog_cat.c - catalog api */
86 struct llog_process_data {
91 struct llog_process_cat_data {
94 /* to process catlog across zero record */
97 int llog_cat_put(struct llog_handle *cathandle);
98 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
99 struct llog_cookie *reccookie, void *buf);
100 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
101 struct llog_cookie *cookies);
102 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
103 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index);
106 int llog_setup(struct obd_device *, struct obd_llogs *, int, struct obd_device *,
107 int, struct llog_logid *, struct llog_operations *);
108 int llog_cleanup(struct llog_ctxt *);
109 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
110 int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
111 struct lov_stripe_md *lsm, struct llog_cookie *logcookies,
113 int llog_cancel(struct llog_ctxt *, struct lov_stripe_md *lsm,
114 int count, struct llog_cookie *cookies, int flags);
116 int llog_obd_origin_setup(struct obd_device *, struct obd_llogs *, int,
117 struct obd_device *, int, struct llog_logid *);
118 int llog_obd_origin_cleanup(struct llog_ctxt *ctxt);
119 int llog_obd_origin_add(struct llog_ctxt *ctxt,
120 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
121 struct llog_cookie *logcookies, int numcookies);
123 int llog_cat_initialize(struct obd_device *, struct obd_llogs *, int);
124 int obd_llog_init(struct obd_device *, struct obd_llogs *, struct obd_device *,
125 int, struct llog_catid *);
127 int obd_llog_finish(struct obd_device *, struct obd_llogs *, int);
130 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
131 int llog_catlog_list(struct obd_device *obd, int count,
132 struct obd_ioctl_data *data);
135 int llog_initiator_connect(struct llog_ctxt *ctxt);
136 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
137 int llog_origin_connect(struct llog_ctxt *ctxt, int count,
138 struct llog_logid *logid, struct llog_gen *gen,
139 struct obd_uuid *uuid);
140 int llog_handle_connect(struct ptlrpc_request *req);
143 int llog_obd_repl_cancel(struct llog_ctxt *ctxt,
144 struct lov_stripe_md *lsm, int count,
145 struct llog_cookie *cookies, int flags);
146 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
147 int llog_repl_connect(struct llog_ctxt *ctxt, int count,
148 struct llog_logid *logid, struct llog_gen *gen,
149 struct obd_uuid *uuid);
151 struct llog_operations {
152 int (*lop_write_rec)(struct llog_handle *loghandle,
153 struct llog_rec_hdr *rec,
154 struct llog_cookie *logcookies, int numcookies,
156 int (*lop_destroy)(struct llog_handle *handle);
157 int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
158 int next_idx, __u64 *offset, void *buf, int len);
159 int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
160 struct llog_logid *logid, char *name);
161 int (*lop_close)(struct llog_handle *handle);
162 int (*lop_read_header)(struct llog_handle *handle);
164 int (*lop_setup)(struct obd_device *, struct obd_llogs *, int,
165 struct obd_device *, int, struct llog_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 */
196 struct obd_llogs *loc_llogs;
199 static inline void llog_gen_init(struct llog_ctxt *ctxt)
201 struct obd_device *obd = ctxt->loc_exp->exp_obd;
203 if (!strcmp(obd->obd_type->typ_name, "mds"))
204 ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count;
205 else if (!strstr(obd->obd_type->typ_name, "filter"))
206 ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count;
208 ctxt->loc_gen.mnt_cnt = 0;
211 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
213 if (a.mnt_cnt < b.mnt_cnt)
215 if (a.mnt_cnt > b.mnt_cnt)
217 return(a.conn_cnt < b.conn_cnt ? 1 : 0);
220 #define LLOG_GEN_INC(gen) ((gen).conn_cnt) ++
221 #define LLOG_PROC_BREAK 0x0001
223 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
224 struct llog_operations **lop)
229 *lop = ctxt->loc_logops;
236 static inline int llog_handle2ops(struct llog_handle *loghandle,
237 struct llog_operations **lop)
239 if (loghandle == NULL)
242 return llog_obd2ops(loghandle->lgh_ctxt, lop);
245 static inline int llog_data_len(int len)
247 return size_round(len);
250 static inline struct llog_ctxt *llog_get_context(struct obd_llogs *llogs,
253 if (index < 0 || index >= LLOG_MAX_CTXTS)
256 return llogs->llog_ctxt[index];
259 static inline int llog_write_rec(struct llog_handle *handle,
260 struct llog_rec_hdr *rec,
261 struct llog_cookie *logcookies,
262 int numcookies, void *buf, int idx)
264 struct llog_operations *lop;
268 rc = llog_handle2ops(handle, &lop);
271 if (lop->lop_write_rec == NULL)
275 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr)
276 + sizeof(struct llog_rec_tail);
278 buflen = rec->lrh_len;
279 LASSERT(size_round(buflen) == buflen);
281 rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
285 static inline int llog_read_header(struct llog_handle *handle)
287 struct llog_operations *lop;
291 rc = llog_handle2ops(handle, &lop);
294 if (lop->lop_read_header == NULL)
297 rc = lop->lop_read_header(handle);
301 static inline int llog_destroy(struct llog_handle *handle)
303 struct llog_operations *lop;
307 rc = llog_handle2ops(handle, &lop);
310 if (lop->lop_destroy == NULL)
313 rc = lop->lop_destroy(handle);
318 static inline int llog_cancel(struct obd_export *exp,
319 struct lov_stripe_md *lsm, int count,
320 struct llog_cookie *cookies, int flags)
322 struct llog_operations *lop;
326 rc = llog_handle2ops(loghandle, &lop);
329 if (lop->lop_cancel == NULL)
332 rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
337 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
338 int next_idx, __u64 *cur_offset, void *buf,
341 struct llog_operations *lop;
345 rc = llog_handle2ops(loghandle, &lop);
348 if (lop->lop_next_block == NULL)
351 rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
356 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
357 struct llog_logid *logid, char *name)
359 struct llog_operations *lop;
363 rc = llog_obd2ops(ctxt, &lop);
366 if (lop->lop_create == NULL)
369 rc = lop->lop_create(ctxt, res, logid, name);
373 static inline int llog_connect(struct llog_ctxt *ctxt, int count,
374 struct llog_logid *logid, struct llog_gen *gen,
375 struct obd_uuid *uuid)
377 struct llog_operations *lop;
381 rc = llog_obd2ops(ctxt, &lop);
384 if (lop->lop_connect == NULL)
387 rc = lop->lop_connect(ctxt, count, logid, gen, uuid);