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 #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>
45 #error Unsupported operating system.
50 #include <lustre/lustre_idl.h>
52 #define LOG_NAME_LIMIT(logname, name) \
53 snprintf(logname, sizeof(logname), "LOGS/%s", name)
54 #define LLOG_EEMPTY 4711
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 */
63 struct cat_handle_data {
64 struct list_head chd_head;
65 struct llog_handle *chd_current_log; /* currently open log */
68 /* In-memory descriptor for a log object or log catalog */
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;
75 int lgh_cur_idx; /* used during llog_process */
76 __u64 lgh_cur_offset; /* used during llog_process */
77 struct llog_ctxt *lgh_ctxt;
79 struct plain_handle_data phd;
80 struct cat_handle_data chd;
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);
99 /* llog_cat.c - catalog api */
100 struct llog_process_data {
105 struct llog_process_cat_data {
108 /* to process catalog across zero record */
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);
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,
129 int llog_cancel(struct llog_ctxt *, struct lov_stripe_md *lsm,
130 int count, struct llog_cookie *cookies, int flags);
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);
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);
146 int obd_llog_finish(struct obd_device *obd, int count);
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);
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);
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);
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,
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);
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 */
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);
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
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 */
222 #define cap_raise(c, flag) do {} while(0)
224 #define CAP_SYS_RESOURCE 24
226 #endif /* !__KERNEL__ */
228 static inline void llog_gen_init(struct llog_ctxt *ctxt)
230 struct obd_device *obd = ctxt->loc_exp->exp_obd;
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;
237 ctxt->loc_gen.mnt_cnt = 0;
240 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
242 if (a.mnt_cnt < b.mnt_cnt)
244 if (a.mnt_cnt > b.mnt_cnt)
246 return(a.conn_cnt < b.conn_cnt ? 1 : 0);
249 #define LLOG_GEN_INC(gen) ((gen).conn_cnt ++)
250 #define LLOG_PROC_BREAK 0x0001
251 #define LLOG_DEL_RECORD 0x0002
253 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
254 struct llog_operations **lop)
259 *lop = ctxt->loc_logops;
266 static inline int llog_handle2ops(struct llog_handle *loghandle,
267 struct llog_operations **lop)
269 if (loghandle == NULL)
272 return llog_obd2ops(loghandle->lgh_ctxt, lop);
275 static inline int llog_data_len(int len)
277 return size_round(len);
280 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
283 if (index < 0 || index >= LLOG_MAX_CTXTS)
286 return obd->obd_llog_ctxt[index];
289 static inline struct llog_ctxt *
290 llog_get_context_from_llogs(struct obd_llogs *llogs, int index)
292 if (index < 0 || index >= LLOG_MAX_CTXTS)
294 return llogs->llog_ctxt[index];
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)
302 struct llog_operations *lop;
307 rc = llog_handle2ops(handle, &lop);
311 if (lop->lop_write_rec == NULL)
315 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr)
316 + sizeof(struct llog_rec_tail);
318 buflen = rec->lrh_len;
319 LASSERT(size_round(buflen) == buflen);
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;
328 static inline int llog_read_header(struct llog_handle *handle)
330 struct llog_operations *lop;
334 rc = llog_handle2ops(handle, &lop);
337 if (lop->lop_read_header == NULL)
340 rc = lop->lop_read_header(handle);
344 static inline int llog_destroy(struct llog_handle *handle)
346 struct llog_operations *lop;
350 rc = llog_handle2ops(handle, &lop);
353 if (lop->lop_destroy == NULL)
356 rc = lop->lop_destroy(handle);
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)
365 struct llog_operations *lop;
369 rc = llog_handle2ops(loghandle, &lop);
372 if (lop->lop_cancel == NULL)
375 rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
380 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
381 int next_idx, __u64 *cur_offset, void *buf,
384 struct llog_operations *lop;
388 rc = llog_handle2ops(loghandle, &lop);
391 if (lop->lop_next_block == NULL)
394 rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
399 static inline int llog_prev_block(struct llog_handle *loghandle,
400 int prev_idx, void *buf, int len)
402 struct llog_operations *lop;
406 rc = llog_handle2ops(loghandle, &lop);
409 if (lop->lop_prev_block == NULL)
412 rc = lop->lop_prev_block(loghandle, prev_idx, buf, len);
416 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
417 struct llog_logid *logid, char *name)
419 struct llog_operations *lop;
424 rc = llog_obd2ops(ctxt, &lop);
427 if (lop->lop_create == NULL)
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;
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)
441 struct llog_operations *lop;
445 rc = llog_obd2ops(ctxt, &lop);
448 if (lop->lop_connect == NULL)
451 rc = lop->lop_connect(ctxt, count, logid, gen, uuid);