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)
43 #define LLOG_EEMPTY 4711
47 struct plain_handle_data {
48 struct list_head phd_entry;
49 struct llog_handle *phd_cat_handle;
50 struct llog_cookie phd_cookie; /* cookie of this log in its cat */
54 struct cat_handle_data {
55 struct list_head chd_head;
56 struct llog_handle *chd_current_log; /* currently open log */
59 /* In-memory descriptor for a log object or log catalog */
61 struct rw_semaphore lgh_lock;
62 struct llog_logid lgh_id; /* id of this log */
63 struct llog_log_hdr *lgh_hdr;
64 struct file *lgh_file;
66 struct llog_ctxt *lgh_ctxt;
68 struct plain_handle_data phd;
69 struct cat_handle_data chd;
73 /* llog.c - general API */
74 typedef int (*llog_cb_t)(struct llog_handle *, struct llog_rec_hdr *, void *);
75 struct llog_handle *llog_alloc_handle(void);
76 void llog_free_handle(struct llog_handle *handle);
77 int llog_cancel_rec(struct llog_handle *loghandle, int index);
78 int llog_init_handle(struct llog_handle *handle, int flags,
79 struct obd_uuid *uuid);
80 int llog_close(struct llog_handle *cathandle);
81 int llog_process(struct llog_handle *loghandle, llog_cb_t cb,
82 void *data, void *catdata);
83 int llog_reverse_process(struct llog_handle *loghandle, llog_cb_t cb,
84 void *data, void *catdata);
86 /* llog_cat.c - catalog api */
87 struct llog_process_data {
92 struct llog_process_cat_data {
95 /* to process catalog across zero record */
98 int llog_cat_id2handle(struct llog_handle *cathandle, struct llog_handle **res,
99 struct llog_logid *logid);
100 int llog_cat_put(struct llog_handle *cathandle);
101 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
102 struct llog_cookie *reccookie, void *buf,
103 struct rw_semaphore **lock, int *lock_count);
104 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
105 struct llog_cookie *cookies);
106 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
107 int llog_cat_reverse_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
108 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index);
111 int llog_catalog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
112 void *buf, struct llog_cookie *reccookie, int, void *data,
113 struct rw_semaphore **lock, int *lock_count);
114 int llog_catalog_cancel(struct llog_ctxt *ctxt, int count, struct llog_cookie *,
115 int flags, void *data);
116 int llog_catalog_setup(struct llog_ctxt **res, char *name, struct obd_export *exp,
117 struct lvfs_run_ctxt *, struct fsfilt_operations *fsops,
118 struct dentry *logs_de, struct dentry *objects_de);
119 int llog_catalog_cleanup(struct llog_ctxt *ctxt);
120 int llog_cat_half_bottom(struct llog_cookie *, struct llog_handle *);
123 int llog_get_cat_list(struct lvfs_run_ctxt *, struct fsfilt_operations *,
124 const char *name, int count, struct llog_catid *idarray);
125 int llog_put_cat_list(struct lvfs_run_ctxt *, struct fsfilt_operations *,
126 const char *name, int count, struct llog_catid *idarray);
128 extern struct llog_operations llog_lvfs_ops;
130 int llog_obd_origin_setup(struct obd_device *, struct obd_llogs *, int,
131 struct obd_device *, int, struct llog_logid *);
133 int obd_llog_cat_initialize(struct obd_device *, struct obd_llogs *, int, const char *);
135 /* llog_obd.c - obd llog api */
136 int obd_llog_setup(struct obd_device *obd, struct obd_llogs *, int index,
137 struct obd_device *disk_obd, int count, struct llog_logid *logid,
138 struct llog_operations *op);
139 int obd_llog_init(struct obd_device *, struct obd_llogs *, struct obd_device *,
140 int, struct llog_catid *);
141 int obd_llog_cleanup(struct llog_ctxt *);
143 int obd_llog_finish(struct obd_device *, struct obd_llogs *, int);
146 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
147 int llog_catalog_list(struct obd_device *obd, int count,
148 struct obd_ioctl_data *data);
151 int llog_initiator_connect(struct llog_ctxt *ctxt);
152 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
153 int llog_origin_connect(struct llog_ctxt *ctxt, int count,
154 struct llog_logid *logid, struct llog_gen *gen,
155 struct obd_uuid *uuid);
156 int llog_handle_connect(struct ptlrpc_request *req);
159 int llog_obd_repl_cancel(struct llog_ctxt *ctxt, int count,
160 struct llog_cookie *cookies, int flags, void *data);
162 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
163 int llog_repl_connect(struct llog_ctxt *ctxt, int count,
164 struct llog_logid *logid, struct llog_gen *gen,
165 struct obd_uuid *uuid);
167 struct llog_operations {
168 int (*lop_setup)(struct obd_device *, struct obd_llogs *, int,
169 struct obd_device *, int, struct llog_logid *);
171 int (*lop_cleanup)(struct llog_ctxt *ctxt);
172 int (*lop_open)(struct llog_ctxt *ctxt, struct llog_handle **,
173 struct llog_logid *logid, char *name, int flags);
174 int (*lop_destroy)(struct llog_handle *handle);
175 int (*lop_close)(struct llog_handle *handle);
177 int (*lop_read_header)(struct llog_handle *handle);
178 int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
179 void *buf, struct llog_cookie *logcookies,
180 int numcookies, void *data, struct rw_semaphore **lock,
182 int (*lop_cancel)(struct llog_ctxt *ctxt, int count,
183 struct llog_cookie *cookies, int flags, void *data);
184 int (*lop_write_rec)(struct llog_handle *loghandle,
185 struct llog_rec_hdr *rec,
186 struct llog_cookie *logcookies, int numcookies,
188 int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
189 int next_idx, __u64 *offset, void *buf, int len);
190 int (*lop_prev_block)(struct llog_handle *h,
191 int prev_idx, void *buf, int len);
193 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp);
194 int (*lop_connect)(struct llog_ctxt *ctxt, int count,
195 struct llog_logid *logid, struct llog_gen *gen,
196 struct obd_uuid *uuid);
200 /* needed for lvfs based log */
201 struct llog_handle *loc_handle;
202 struct llog_operations *loc_logops;
203 struct fsfilt_operations *loc_fsops;
204 struct dentry *loc_logs_dir;
205 struct dentry *loc_objects_dir;
206 struct lvfs_run_ctxt *loc_lvfs_ctxt;
208 struct obd_device *loc_obd; /* points back to the containing obd */
209 struct llog_gen loc_gen;
210 int loc_idx; /* my index the obd array of ctxt's */
211 int loc_alone; /* is this llog ctxt has an obd? */
213 struct obd_export *loc_exp;
214 struct obd_import *loc_imp; /* to use in RPC's: can be backward
216 struct llog_canceld_ctxt *loc_llcd;
217 struct semaphore loc_sem; /* protects loc_llcd and loc_imp */
219 struct obd_llogs *loc_llogs;
222 struct llog_create_locks {
224 struct rw_semaphore *lcl_locks[0];
227 static inline void llog_gen_init(struct llog_ctxt *ctxt)
229 struct obd_device *obd = ctxt->loc_exp->exp_obd;
231 if (!strcmp(obd->obd_type->typ_name, "mds"))
232 ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count;
233 else if (!strstr(obd->obd_type->typ_name, "filter"))
234 ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count;
236 ctxt->loc_gen.mnt_cnt = 0;
239 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
241 if (a.mnt_cnt < b.mnt_cnt)
243 if (a.mnt_cnt > b.mnt_cnt)
245 return(a.conn_cnt < b.conn_cnt ? 1 : 0);
248 #define LLOG_GEN_INC(gen) ((gen).conn_cnt) ++
249 #define LLOG_PROC_BREAK 0x0001
250 #define LLOG_DEL_RECORD 0x0002
252 #define EQ_LOGID(a, b) (a.lgl_oid == b.lgl_oid && \
253 a.lgl_ogr == b.lgl_ogr && \
254 a.lgl_ogen == b.lgl_ogen)
256 /* Flags are in the bottom 16 bit */
257 #define LLOG_COOKIE_FLAG_MASK 0x0000ffff
258 #define LLOG_COOKIE_REPLAY_NEW 0x00000001
259 #define LLOG_COOKIE_REPLAY 0x00000002
261 static inline int llog_cookie_get_flags(struct llog_cookie *logcookie)
263 return(logcookie->lgc_flags & LLOG_COOKIE_FLAG_MASK);
266 static inline void llog_cookie_add_flags(struct llog_cookie *logcookie, int flags)
268 logcookie->lgc_flags |= LLOG_COOKIE_FLAG_MASK & flags;
271 static inline void llog_cookie_set_flags(struct llog_cookie *logcookie, int flags)
273 logcookie->lgc_flags &= ~LLOG_COOKIE_FLAG_MASK;
274 llog_cookie_add_flags(logcookie, flags);
277 static inline void llog_cookie_clear_flags(struct llog_cookie *logcookie, int flags)
279 logcookie->lgc_flags &= ~(LLOG_COOKIE_FLAG_MASK & flags);
282 static inline int llog_ctxt2ops(struct llog_ctxt *ctxt,
283 struct llog_operations **lop)
288 *lop = ctxt->loc_logops;
295 static inline int llog_handle2ops(struct llog_handle *loghandle,
296 struct llog_operations **lop)
298 if (loghandle == NULL)
301 return llog_ctxt2ops(loghandle->lgh_ctxt, lop);
304 static inline int llog_data_len(int len)
306 return size_round(len);
309 static inline struct llog_ctxt *llog_get_context(struct obd_llogs *llogs,
312 if (index < 0 || index >= LLOG_MAX_CTXTS)
315 return llogs->llog_ctxt[index];
318 static inline int llog_open(struct llog_ctxt *ctxt, struct llog_handle **res,
319 struct llog_logid *logid, char *name, int flags)
321 struct llog_operations *lop;
325 rc = llog_ctxt2ops(ctxt, &lop);
328 if (lop->lop_open == NULL)
331 rc = lop->lop_open(ctxt, res, logid, name, flags);
335 static inline int llog_destroy(struct llog_handle *handle)
337 struct llog_operations *lop;
341 rc = llog_handle2ops(handle, &lop);
344 if (lop->lop_destroy == NULL)
347 rc = lop->lop_destroy(handle);
351 static inline int llog_read_header(struct llog_handle *handle)
353 struct llog_operations *lop;
357 rc = llog_handle2ops(handle, &lop);
360 if (lop->lop_read_header == NULL)
363 rc = lop->lop_read_header(handle);
367 static inline int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
368 void *buf, struct llog_cookie *logcookies,
369 int numcookies, void *data,
370 struct rw_semaphore **lock, int *lock_count)
372 struct llog_operations *lop;
376 rc = llog_ctxt2ops(ctxt, &lop);
379 if (lop->lop_add == NULL)
382 rc = lop->lop_add(ctxt, rec, buf, logcookies, numcookies, data,
387 static inline int llog_cancel(struct llog_ctxt *ctxt, int count,
388 struct llog_cookie *cookies, int flags, void *data)
390 struct llog_operations *lop;
394 rc = llog_ctxt2ops(ctxt, &lop);
397 if (lop->lop_cancel == NULL)
400 rc = lop->lop_cancel(ctxt, count, cookies, flags, data);
404 static inline int llog_write_rec(struct llog_handle *handle,
405 struct llog_rec_hdr *rec,
406 struct llog_cookie *logcookies,
407 int numcookies, void *buf, int idx)
409 struct llog_operations *lop;
413 rc = llog_handle2ops(handle, &lop);
416 if (lop->lop_write_rec == NULL)
420 buflen = le32_to_cpu(rec->lrh_len) + sizeof(struct llog_rec_hdr)
421 + sizeof(struct llog_rec_tail);
423 buflen = le32_to_cpu(rec->lrh_len);
424 LASSERT(size_round(buflen) == buflen);
426 rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
430 static inline int llog_next_block(struct llog_handle *loghandle, int *curr_idx,
431 int next_idx, __u64 *curr_offset, void *buf,
434 struct llog_operations *lop;
438 rc = llog_handle2ops(loghandle, &lop);
441 if (lop->lop_next_block == NULL)
444 rc = lop->lop_next_block(loghandle, curr_idx, next_idx, curr_offset, buf,
449 static inline int llog_prev_block(struct llog_handle *loghandle,
450 int prev_idx, void *buf, int len)
452 struct llog_operations *lop;
456 rc = llog_handle2ops(loghandle, &lop);
459 if (lop->lop_prev_block == NULL)
462 rc = lop->lop_prev_block(loghandle, prev_idx, buf, len);
466 static inline int llog_connect(struct llog_ctxt *ctxt, int count,
467 struct llog_logid *logid, struct llog_gen *gen,
468 struct obd_uuid *uuid)
470 struct llog_operations *lop;
474 rc = llog_ctxt2ops(ctxt, &lop);
477 if (lop->lop_connect == NULL)
480 rc = lop->lop_connect(ctxt, count, logid, gen, uuid);
484 static inline int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp)
486 struct llog_operations *lop;
490 rc = llog_ctxt2ops(ctxt, &lop);
493 if (lop->lop_sync == NULL)
496 rc = lop->lop_sync(ctxt, exp);
500 static inline void llog_create_lock_free(struct llog_create_locks *lcl)
502 int size, offset = offsetof(struct llog_create_locks, lcl_locks);
506 for (i = 0; i < lcl->lcl_count; i ++) {
507 if (lcl->lcl_locks[i] != NULL) {
509 LASSERT(down_write_trylock(lcl->lcl_locks[i]) == 0);
511 up_write(lcl->lcl_locks[i]);
514 size = offset + sizeof(struct rw_semaphore *) * lcl->lcl_count;