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 struct llog_ctxt *lgh_ctxt;
77 struct plain_handle_data phd;
78 struct cat_handle_data chd;
82 /* llog.c - general API */
83 typedef int (*llog_cb_t)(struct llog_handle *, struct llog_rec_hdr *, void *);
84 typedef int (*llog_fill_rec_cb_t)(struct llog_rec_hdr *rec, void *data);
85 extern struct llog_handle *llog_alloc_handle(void);
86 int llog_init_handle(struct llog_handle *handle, int flags,
87 struct obd_uuid *uuid);
88 extern void llog_free_handle(struct llog_handle *handle);
89 int llog_process(struct llog_handle *loghandle, llog_cb_t cb,
90 void *data, void *catdata);
91 int llog_reverse_process(struct llog_handle *loghandle, llog_cb_t cb,
92 void *data, void *catdata);
93 extern int llog_cancel_rec(struct llog_handle *loghandle, int index);
94 extern int llog_close(struct llog_handle *cathandle);
95 extern int llog_get_size(struct llog_handle *loghandle);
97 /* llog_cat.c - catalog api */
98 struct llog_process_data {
103 struct llog_process_cat_data {
106 /* to process catalog across zero record */
109 int llog_cat_put(struct llog_handle *cathandle);
110 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
111 struct llog_cookie *reccookie, void *buf);
112 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
113 struct llog_cookie *cookies);
114 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
115 int llog_cat_reverse_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
116 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index);
119 int llog_setup(struct obd_device *obd, struct obd_llogs *llogs, int index,
120 struct obd_device *disk_obd, int count, struct llog_logid *logid,
121 struct llog_operations *op);
122 int llog_cleanup(struct llog_ctxt *);
123 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
124 int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
125 struct lov_stripe_md *lsm, struct llog_cookie *logcookies,
127 int llog_cancel(struct llog_ctxt *, struct lov_stripe_md *lsm,
128 int count, struct llog_cookie *cookies, int flags);
130 int llog_obd_origin_setup(struct obd_device *obd, int index,
131 struct obd_device *disk_obd, int count,
132 struct llog_logid *logid);
133 int llog_obd_origin_cleanup(struct llog_ctxt *ctxt);
134 int llog_obd_origin_add(struct llog_ctxt *ctxt,
135 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
136 struct llog_cookie *logcookies, int numcookies);
138 int llog_cat_initialize(struct obd_device *obd, struct obd_llogs *llogs,
139 int count, struct obd_uuid *uuid);
140 int obd_llog_init(struct obd_device *obd, struct obd_llogs *llogs,
141 struct obd_device *disk_obd, int count,
142 struct llog_catid *logid, struct obd_uuid *uuid);
144 int obd_llog_finish(struct obd_device *obd, int count);
147 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
148 int llog_catalog_list(struct obd_device *obd, int count,
149 struct obd_ioctl_data *data);
152 int llog_initiator_connect(struct llog_ctxt *ctxt);
153 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
154 int llog_origin_connect(struct llog_ctxt *ctxt, int count,
155 struct llog_logid *logid, struct llog_gen *gen,
156 struct obd_uuid *uuid);
157 int llog_handle_connect(struct ptlrpc_request *req);
160 int llog_obd_repl_cancel(struct llog_ctxt *ctxt,
161 struct lov_stripe_md *lsm, int count,
162 struct llog_cookie *cookies, int flags);
163 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
164 int llog_repl_connect(struct llog_ctxt *ctxt, int count,
165 struct llog_logid *logid, struct llog_gen *gen,
166 struct obd_uuid *uuid);
168 struct llog_operations {
169 int (*lop_write_rec)(struct llog_handle *loghandle,
170 struct llog_rec_hdr *rec,
171 struct llog_cookie *logcookies, int numcookies,
173 int (*lop_destroy)(struct llog_handle *handle);
174 int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
175 int next_idx, __u64 *offset, void *buf, int len);
176 int (*lop_prev_block)(struct llog_handle *h,
177 int prev_idx, void *buf, int len);
178 int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
179 struct llog_logid *logid, char *name);
180 int (*lop_close)(struct llog_handle *handle);
181 int (*lop_read_header)(struct llog_handle *handle);
183 int (*lop_setup)(struct obd_device *obd, int ctxt_idx,
184 struct obd_device *disk_obd, int count,
185 struct llog_logid *logid);
186 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp);
187 int (*lop_cleanup)(struct llog_ctxt *ctxt);
188 int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
189 struct lov_stripe_md *lsm,
190 struct llog_cookie *logcookies, int numcookies);
191 int (*lop_cancel)(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm,
192 int count, struct llog_cookie *cookies, int flags);
193 int (*lop_connect)(struct llog_ctxt *ctxt, int count,
194 struct llog_logid *logid, struct llog_gen *gen,
195 struct obd_uuid *uuid);
196 /* XXX add 2 more: commit callbacks and llog recovery functions */
200 extern struct llog_operations llog_lvfs_ops;
201 int llog_get_cat_list(struct obd_device *obd, struct obd_device *disk_obd,
202 char *name, int count, struct llog_catid *idarray);
205 int loc_idx; /* my index the obd array of ctxt's */
206 struct llog_gen loc_gen;
207 struct obd_device *loc_obd; /* points back to the containing obd*/
208 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
209 struct obd_import *loc_imp; /* to use in RPC's: can be backward
211 struct llog_operations *loc_logops;
212 struct llog_handle *loc_handle;
213 struct llog_canceld_ctxt *loc_llcd;
214 struct semaphore loc_sem; /* protects loc_llcd and loc_imp */
218 static inline void llog_gen_init(struct llog_ctxt *ctxt)
220 struct obd_device *obd = ctxt->loc_exp->exp_obd;
222 if (!strcmp(obd->obd_type->typ_name, LUSTRE_MDS_NAME))
223 ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count;
224 else if (!strstr(obd->obd_type->typ_name, LUSTRE_OST_NAME))
225 ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count;
227 ctxt->loc_gen.mnt_cnt = 0;
230 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
232 if (a.mnt_cnt < b.mnt_cnt)
234 if (a.mnt_cnt > b.mnt_cnt)
236 return(a.conn_cnt < b.conn_cnt ? 1 : 0);
239 #define LLOG_GEN_INC(gen) ((gen).conn_cnt ++)
240 #define LLOG_PROC_BREAK 0x0001
241 #define LLOG_DEL_RECORD 0x0002
243 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
244 struct llog_operations **lop)
249 *lop = ctxt->loc_logops;
256 static inline int llog_handle2ops(struct llog_handle *loghandle,
257 struct llog_operations **lop)
259 if (loghandle == NULL)
262 return llog_obd2ops(loghandle->lgh_ctxt, lop);
265 static inline int llog_data_len(int len)
267 return size_round(len);
270 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
273 if (index < 0 || index >= LLOG_MAX_CTXTS)
276 return obd->obd_llog_ctxt[index];
279 static inline int llog_write_rec(struct llog_handle *handle,
280 struct llog_rec_hdr *rec,
281 struct llog_cookie *logcookies,
282 int numcookies, void *buf, int idx)
284 struct llog_operations *lop;
288 rc = llog_handle2ops(handle, &lop);
291 if (lop->lop_write_rec == NULL)
295 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr)
296 + sizeof(struct llog_rec_tail);
298 buflen = rec->lrh_len;
299 LASSERT(size_round(buflen) == buflen);
301 rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
305 static inline int llog_read_header(struct llog_handle *handle)
307 struct llog_operations *lop;
311 rc = llog_handle2ops(handle, &lop);
314 if (lop->lop_read_header == NULL)
317 rc = lop->lop_read_header(handle);
321 static inline int llog_destroy(struct llog_handle *handle)
323 struct llog_operations *lop;
327 rc = llog_handle2ops(handle, &lop);
330 if (lop->lop_destroy == NULL)
333 rc = lop->lop_destroy(handle);
338 static inline int llog_cancel(struct obd_export *exp,
339 struct lov_stripe_md *lsm, int count,
340 struct llog_cookie *cookies, int flags)
342 struct llog_operations *lop;
346 rc = llog_handle2ops(loghandle, &lop);
349 if (lop->lop_cancel == NULL)
352 rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
357 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
358 int next_idx, __u64 *cur_offset, void *buf,
361 struct llog_operations *lop;
365 rc = llog_handle2ops(loghandle, &lop);
368 if (lop->lop_next_block == NULL)
371 rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
376 static inline int llog_prev_block(struct llog_handle *loghandle,
377 int prev_idx, void *buf, int len)
379 struct llog_operations *lop;
383 rc = llog_handle2ops(loghandle, &lop);
386 if (lop->lop_prev_block == NULL)
389 rc = lop->lop_prev_block(loghandle, prev_idx, buf, len);
393 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
394 struct llog_logid *logid, char *name)
396 struct llog_operations *lop;
400 rc = llog_obd2ops(ctxt, &lop);
403 if (lop->lop_create == NULL)
406 rc = lop->lop_create(ctxt, res, logid, name);
410 static inline int llog_connect(struct llog_ctxt *ctxt, int count,
411 struct llog_logid *logid, struct llog_gen *gen,
412 struct obd_uuid *uuid)
414 struct llog_operations *lop;
418 rc = llog_obd2ops(ctxt, &lop);
421 if (lop->lop_connect == NULL)
424 rc = lop->lop_connect(ctxt, count, logid, gen, uuid);