4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre_log.h
38 * Generic infrastructure for managing a collection of logs.
39 * These logs are used for:
41 * - orphan recovery: OST adds record on create
42 * - mtime/size consistency: the OST adds a record on first write
43 * - open/unlinked objects: OST adds a record on destroy
45 * - mds unlink log: the MDS adds an entry upon delete
47 * - raid1 replication log between OST's
48 * - MDS replication logs
59 #if defined(__linux__)
60 #include <linux/lustre_log.h>
61 #elif defined(__APPLE__)
62 #include <darwin/lustre_log.h>
63 #elif defined(__WINNT__)
64 #include <winnt/lustre_log.h>
66 #error Unsupported operating system.
69 #include <obd_class.h>
71 #include <lustre/lustre_idl.h>
72 #include <dt_object.h>
74 #define LOG_NAME_LIMIT(logname, name) \
75 snprintf(logname, sizeof(logname), "LOGS/%s", name)
76 #define LLOG_EEMPTY 4711
78 enum llog_open_param {
79 LLOG_OPEN_EXISTS = 0x0000,
80 LLOG_OPEN_NEW = 0x0001,
83 struct plain_handle_data {
85 struct llog_handle *phd_cat_handle;
86 struct llog_cookie phd_cookie; /* cookie of this log in its cat */
89 struct cat_handle_data {
91 struct llog_handle *chd_current_log; /* currently open log */
92 struct llog_handle *chd_next_log; /* llog to be used next */
95 static inline void logid_to_fid(struct llog_logid *id, struct lu_fid *fid)
97 /* For compatibility purposes we identify pre-OSD (~< 2.3.51 MDS)
98 * logid's by non-zero ogen (inode generation) and convert them
100 if (id->lgl_ogen == 0) {
101 fid->f_seq = id->lgl_oi.oi.oi_seq;
102 fid->f_oid = id->lgl_oi.oi.oi_id;
105 lu_igif_build(fid, id->lgl_oi.oi.oi_id, id->lgl_ogen);
109 static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
111 id->lgl_oi.oi.oi_seq = fid->f_seq;
112 id->lgl_oi.oi.oi_id = fid->f_oid;
116 static inline void logid_set_id(struct llog_logid *log_id, __u64 id)
118 log_id->lgl_oi.oi.oi_id = id;
121 static inline __u64 logid_id(struct llog_logid *log_id)
123 return log_id->lgl_oi.oi.oi_id;
128 /* llog.c - general API */
129 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
130 int flags, struct obd_uuid *uuid);
131 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
132 struct llog_rec_hdr *rec, void *data);
133 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
134 llog_cb_t cb, void *data, void *catdata);
135 int llog_process_or_fork(const struct lu_env *env,
136 struct llog_handle *loghandle,
137 llog_cb_t cb, void *data, void *catdata, bool fork);
138 int llog_reverse_process(const struct lu_env *env,
139 struct llog_handle *loghandle, llog_cb_t cb,
140 void *data, void *catdata);
141 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
143 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
144 struct llog_handle **lgh, struct llog_logid *logid,
145 char *name, enum llog_open_param open_param);
146 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
147 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
149 int llog_backup(const struct lu_env *env, struct obd_device *obd,
150 struct llog_ctxt *ctxt, struct llog_ctxt *bak_ctxt,
151 char *name, char *backup);
153 /* llog_process flags */
154 #define LLOG_FLAG_NODEAMON 0x0001
156 /* llog_cat.c - catalog api */
157 struct llog_process_data {
159 * Any useful data needed while processing catalog. This is
160 * passed later to process callback.
164 * Catalog process callback function, called for each record
169 * Start processing the catalog from startcat/startidx
175 struct llog_process_cat_data {
177 * Temporary stored first_idx while scanning log.
181 * Temporary stored last_idx while scanning log.
186 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
187 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
188 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
189 void *buf, struct thandle *th);
190 int llog_cat_declare_add_rec(const struct lu_env *env,
191 struct llog_handle *cathandle,
192 struct llog_rec_hdr *rec, struct thandle *th);
193 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
194 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
196 int llog_cat_cancel_records(const struct lu_env *env,
197 struct llog_handle *cathandle, int count,
198 struct llog_cookie *cookies);
199 int llog_cat_process_or_fork(const struct lu_env *env,
200 struct llog_handle *cat_llh, llog_cb_t cb,
201 void *data, int startcat, int startidx, bool fork);
202 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
203 llog_cb_t cb, void *data, int startcat, int startidx);
204 int llog_cat_reverse_process(const struct lu_env *env,
205 struct llog_handle *cat_llh, llog_cb_t cb,
207 int llog_cat_init_and_process(const struct lu_env *env,
208 struct llog_handle *llh);
211 int llog_setup(const struct lu_env *env, struct obd_device *obd,
212 struct obd_llog_group *olg, int index,
213 struct obd_device *disk_obd, struct llog_operations *op);
214 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
215 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
216 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
217 int llog_obd_add(const struct lu_env *env, struct llog_ctxt *ctxt,
218 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
219 struct llog_cookie *logcookies, int numcookies);
220 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
221 struct lov_stripe_md *lsm, int count,
222 struct llog_cookie *cookies, int flags);
224 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
225 struct obd_device *disk_obd, int *idx);
227 int obd_llog_finish(struct obd_device *obd, int count);
230 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
231 struct obd_ioctl_data *data);
232 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
233 int count, struct obd_ioctl_data *data);
236 int llog_initiator_connect(struct llog_ctxt *ctxt);
238 struct llog_operations {
239 int (*lop_destroy)(const struct lu_env *env,
240 struct llog_handle *handle);
241 int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
242 int *curr_idx, int next_idx, __u64 *offset,
244 int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
245 int prev_idx, void *buf, int len);
246 int (*lop_read_header)(const struct lu_env *env,
247 struct llog_handle *handle);
248 int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
249 struct obd_llog_group *olg, int ctxt_idx,
250 struct obd_device *disk_obd);
251 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
253 int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
254 int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
255 struct lov_stripe_md *lsm, int count,
256 struct llog_cookie *cookies, int flags);
257 int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
258 struct llog_gen *gen, struct obd_uuid *uuid);
260 * Any llog file must be opened first using llog_open(). Llog can be
261 * opened by name, logid or without both, in last case the new logid
264 int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
265 struct llog_logid *logid, char *name,
266 enum llog_open_param);
268 * Opened llog may not exist and this must be checked where needed using
269 * the llog_exist() call.
271 int (*lop_exist)(struct llog_handle *lgh);
273 * Close llog file and calls llog_free_handle() implicitly.
274 * Any opened llog must be closed by llog_close() call.
276 int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
278 * Create new llog file. The llog must be opened.
279 * Must be used only for local llog operations.
281 int (*lop_declare_create)(const struct lu_env *env,
282 struct llog_handle *handle,
284 int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
287 * write new record in llog. It appends records usually but can edit
288 * existing records too.
290 int (*lop_declare_write_rec)(const struct lu_env *env,
291 struct llog_handle *lgh,
292 struct llog_rec_hdr *rec,
293 int idx, struct thandle *th);
294 int (*lop_write_rec)(const struct lu_env *env,
295 struct llog_handle *loghandle,
296 struct llog_rec_hdr *rec,
297 struct llog_cookie *cookie, int cookiecount,
298 void *buf, int idx, struct thandle *th);
300 * Add new record in llog catalog. Does the same as llog_write_rec()
301 * but using llog catalog.
303 int (*lop_declare_add)(const struct lu_env *env,
304 struct llog_handle *lgh,
305 struct llog_rec_hdr *rec, struct thandle *th);
306 int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
307 struct llog_rec_hdr *rec, struct llog_cookie *cookie,
308 void *buf, struct thandle *th);
309 /* Old llog_add version, used in MDS-LOV-OSC now and will gone with
310 * LOD/OSP replacement */
311 int (*lop_obd_add)(const struct lu_env *env, struct llog_ctxt *ctxt,
312 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
313 struct llog_cookie *logcookies, int numcookies);
316 /* In-memory descriptor for a log object or log catalog */
318 struct rw_semaphore lgh_lock;
319 spinlock_t lgh_hdr_lock; /* protect lgh_hdr data */
320 struct llog_logid lgh_id; /* id of this log */
321 struct llog_log_hdr *lgh_hdr;
322 struct dt_object *lgh_obj;
324 int lgh_cur_idx; /* used during llog_process */
325 __u64 lgh_cur_offset; /* used during llog_process */
326 struct llog_ctxt *lgh_ctxt;
328 struct plain_handle_data phd;
329 struct cat_handle_data chd;
333 struct llog_operations *lgh_logops;
334 atomic_t lgh_refcount;
338 extern struct llog_operations llog_osd_ops;
339 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
341 struct llog_catid *idarray);
342 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
344 struct llog_catid *idarray);
346 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
347 #define LLOG_CTXT_FLAG_STOP 0x00000002
350 int loc_idx; /* my index the obd array of ctxt's */
351 struct obd_device *loc_obd; /* points back to the containing obd*/
352 struct obd_llog_group *loc_olg; /* group containing that ctxt */
353 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
354 struct obd_import *loc_imp; /* to use in RPC's: can be backward
356 struct llog_operations *loc_logops;
357 struct llog_handle *loc_handle;
358 struct mutex loc_mutex; /* protect loc_imp */
359 atomic_t loc_refcount;
360 long loc_flags; /* flags, see above defines */
361 struct dt_object *loc_dir;
364 #define LLOG_PROC_BREAK 0x0001
365 #define LLOG_DEL_RECORD 0x0002
367 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
368 struct llog_operations **lop)
373 *lop = ctxt->loc_logops;
380 static inline int llog_handle2ops(struct llog_handle *loghandle,
381 struct llog_operations **lop)
383 if (loghandle == NULL || loghandle->lgh_logops == NULL)
386 *lop = loghandle->lgh_logops;
390 static inline int llog_data_len(int len)
392 return cfs_size_round(len);
395 static inline int llog_get_size(struct llog_handle *loghandle)
397 if (loghandle && loghandle->lgh_hdr)
398 return loghandle->lgh_hdr->llh_count;
402 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
404 atomic_inc(&ctxt->loc_refcount);
405 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
406 atomic_read(&ctxt->loc_refcount));
410 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
414 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
415 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
416 atomic_read(&ctxt->loc_refcount) - 1);
417 __llog_ctxt_put(NULL, ctxt);
420 static inline void llog_group_init(struct obd_llog_group *olg, int group)
422 init_waitqueue_head(&olg->olg_waitq);
423 spin_lock_init(&olg->olg_lock);
424 mutex_init(&olg->olg_cat_processing);
425 olg->olg_seq = group;
428 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
429 struct llog_ctxt *ctxt, int index)
431 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
433 spin_lock(&olg->olg_lock);
434 if (olg->olg_ctxts[index] != NULL) {
435 spin_unlock(&olg->olg_lock);
438 olg->olg_ctxts[index] = ctxt;
439 spin_unlock(&olg->olg_lock);
443 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
446 struct llog_ctxt *ctxt;
448 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
450 spin_lock(&olg->olg_lock);
451 if (olg->olg_ctxts[index] == NULL)
454 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
455 spin_unlock(&olg->olg_lock);
459 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
461 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
462 spin_lock(&olg->olg_lock);
463 olg->olg_ctxts[index] = NULL;
464 spin_unlock(&olg->olg_lock);
467 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
470 return llog_group_get_ctxt(&obd->obd_olg, index);
473 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
475 return (olg->olg_ctxts[index] == NULL);
478 static inline int llog_ctxt_null(struct obd_device *obd, int index)
480 return (llog_group_ctxt_null(&obd->obd_olg, index));
483 static inline int llog_destroy(const struct lu_env *env,
484 struct llog_handle *handle)
486 struct llog_operations *lop;
491 rc = llog_handle2ops(handle, &lop);
494 if (lop->lop_destroy == NULL)
497 rc = lop->lop_destroy(env, handle);
501 static inline int llog_next_block(const struct lu_env *env,
502 struct llog_handle *loghandle, int *cur_idx,
503 int next_idx, __u64 *cur_offset, void *buf,
506 struct llog_operations *lop;
511 rc = llog_handle2ops(loghandle, &lop);
514 if (lop->lop_next_block == NULL)
517 rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
518 cur_offset, buf, len);
522 static inline int llog_prev_block(const struct lu_env *env,
523 struct llog_handle *loghandle,
524 int prev_idx, void *buf, int len)
526 struct llog_operations *lop;
531 rc = llog_handle2ops(loghandle, &lop);
534 if (lop->lop_prev_block == NULL)
537 rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
541 static inline int llog_connect(struct llog_ctxt *ctxt,
542 struct llog_logid *logid, struct llog_gen *gen,
543 struct obd_uuid *uuid)
545 struct llog_operations *lop;
550 rc = llog_obd2ops(ctxt, &lop);
553 if (lop->lop_connect == NULL)
556 rc = lop->lop_connect(ctxt, logid, gen, uuid);
561 int llog_exist(struct llog_handle *loghandle);
562 int llog_declare_create(const struct lu_env *env,
563 struct llog_handle *loghandle, struct thandle *th);
564 int llog_create(const struct lu_env *env, struct llog_handle *handle,
566 int llog_declare_write_rec(const struct lu_env *env,
567 struct llog_handle *handle,
568 struct llog_rec_hdr *rec, int idx,
570 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
571 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
572 int numcookies, void *buf, int idx, struct thandle *th);
573 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
574 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
575 void *buf, struct thandle *th);
576 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
577 struct llog_rec_hdr *rec, struct thandle *th);
578 int lustre_process_log(struct super_block *sb, char *logname,
579 struct config_llog_instance *cfg);
580 int lustre_end_log(struct super_block *sb, char *logname,
581 struct config_llog_instance *cfg);
582 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
583 struct llog_handle **res, struct llog_logid *logid,
585 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
586 struct llog_logid *logid, char *name);
587 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
588 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
589 int cookiecount, void *buf, int idx);