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, 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_oseq;
102 fid->f_oid = id->lgl_oid;
105 lu_igif_build(fid, id->lgl_oid, id->lgl_ogen);
109 static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
111 id->lgl_oseq = fid->f_seq;
112 id->lgl_oid = fid->f_oid;
118 /* llog.c - general API */
119 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
120 int flags, struct obd_uuid *uuid);
121 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
122 llog_cb_t cb, void *data, void *catdata);
123 int llog_process_or_fork(const struct lu_env *env,
124 struct llog_handle *loghandle,
125 llog_cb_t cb, void *data, void *catdata, bool fork);
126 int llog_reverse_process(const struct lu_env *env,
127 struct llog_handle *loghandle, llog_cb_t cb,
128 void *data, void *catdata);
129 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
131 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
132 struct llog_handle **lgh, struct llog_logid *logid,
133 char *name, enum llog_open_param open_param);
134 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
135 int llog_get_size(struct llog_handle *loghandle);
137 /* llog_process flags */
138 #define LLOG_FLAG_NODEAMON 0x0001
140 /* llog_cat.c - catalog api */
141 struct llog_process_data {
143 * Any useful data needed while processing catalog. This is
144 * passed later to process callback.
148 * Catalog process callback function, called for each record
153 * Start processing the catalog from startcat/startidx
159 struct llog_process_cat_data {
161 * Temporary stored first_idx while scanning log.
165 * Temporary stored last_idx while scanning log.
170 struct llog_process_cat_args {
172 * Llog context used in recovery thread on OST (recov_thread.c)
174 struct llog_ctxt *lpca_ctxt;
176 * Llog callback used in recovery thread on OST (recov_thread.c)
180 * Data pointer for llog callback.
185 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
186 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
187 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
188 void *buf, struct thandle *th);
189 int llog_cat_declare_add_rec(const struct lu_env *env,
190 struct llog_handle *cathandle,
191 struct llog_rec_hdr *rec, struct thandle *th);
192 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
193 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
195 int llog_cat_cancel_records(const struct lu_env *env,
196 struct llog_handle *cathandle, int count,
197 struct llog_cookie *cookies);
198 int llog_cat_process_or_fork(const struct lu_env *env,
199 struct llog_handle *cat_llh, llog_cb_t cb,
200 void *data, int startcat, int startidx, bool fork);
201 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
202 llog_cb_t cb, void *data, int startcat, int startidx);
203 int llog_cat_process_thread(void *data);
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);
223 int llog_obd_origin_add(const struct lu_env *env, struct llog_ctxt *ctxt,
224 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
225 struct llog_cookie *logcookies, int numcookies);
227 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
228 struct obd_device *disk_obd, int *idx);
230 int obd_llog_finish(struct obd_device *obd, int count);
233 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
234 struct obd_ioctl_data *data);
235 int llog_catalog_list(struct obd_device *obd, int count,
236 struct obd_ioctl_data *data);
239 int llog_initiator_connect(struct llog_ctxt *ctxt);
240 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
241 int llog_origin_connect(struct llog_ctxt *ctxt,
242 struct llog_logid *logid, struct llog_gen *gen,
243 struct obd_uuid *uuid);
244 int llog_handle_connect(struct ptlrpc_request *req);
247 int llog_obd_repl_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
248 struct lov_stripe_md *lsm, int count,
249 struct llog_cookie *cookies, int flags);
250 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp,
252 int llog_obd_repl_connect(struct llog_ctxt *ctxt,
253 struct llog_logid *logid, struct llog_gen *gen,
254 struct obd_uuid *uuid);
256 struct llog_operations {
257 int (*lop_destroy)(const struct lu_env *env,
258 struct llog_handle *handle);
259 int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
260 int *curr_idx, int next_idx, __u64 *offset,
262 int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
263 int prev_idx, void *buf, int len);
264 int (*lop_read_header)(const struct lu_env *env,
265 struct llog_handle *handle);
266 int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
267 struct obd_llog_group *olg, int ctxt_idx,
268 struct obd_device *disk_obd);
269 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
271 int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
272 int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
273 struct lov_stripe_md *lsm, int count,
274 struct llog_cookie *cookies, int flags);
275 int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
276 struct llog_gen *gen, struct obd_uuid *uuid);
278 * Any llog file must be opened first using llog_open(). Llog can be
279 * opened by name, logid or without both, in last case the new logid
282 int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
283 struct llog_logid *logid, char *name,
284 enum llog_open_param);
286 * Opened llog may not exist and this must be checked where needed using
287 * the llog_exist() call.
289 int (*lop_exist)(struct llog_handle *lgh);
291 * Close llog file and calls llog_free_handle() implicitly.
292 * Any opened llog must be closed by llog_close() call.
294 int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
296 * Create new llog file. The llog must be opened.
297 * Must be used only for local llog operations.
299 int (*lop_declare_create)(const struct lu_env *env,
300 struct llog_handle *handle,
302 int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
305 * write new record in llog. It appends records usually but can edit
306 * existing records too.
308 int (*lop_declare_write_rec)(const struct lu_env *env,
309 struct llog_handle *lgh,
310 struct llog_rec_hdr *rec,
311 int idx, struct thandle *th);
312 int (*lop_write_rec)(const struct lu_env *env,
313 struct llog_handle *loghandle,
314 struct llog_rec_hdr *rec,
315 struct llog_cookie *cookie, int cookiecount,
316 void *buf, int idx, struct thandle *th);
318 * Add new record in llog catalog. Does the same as llog_write_rec()
319 * but using llog catalog.
321 int (*lop_declare_add)(const struct lu_env *env,
322 struct llog_handle *lgh,
323 struct llog_rec_hdr *rec, struct thandle *th);
324 int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
325 struct llog_rec_hdr *rec, struct llog_cookie *cookie,
326 void *buf, struct thandle *th);
327 /* Old llog_add version, used in MDS-LOV-OSC now and will gone with
328 * LOD/OSP replacement */
329 int (*lop_obd_add)(const struct lu_env *env, struct llog_ctxt *ctxt,
330 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
331 struct llog_cookie *logcookies, int numcookies);
334 /* In-memory descriptor for a log object or log catalog */
336 struct rw_semaphore lgh_lock;
337 spinlock_t lgh_hdr_lock; /* protect lgh_hdr data */
338 struct llog_logid lgh_id; /* id of this log */
339 struct llog_log_hdr *lgh_hdr;
340 struct file *lgh_file;
341 struct dt_object *lgh_obj;
343 int lgh_cur_idx; /* used during llog_process */
344 __u64 lgh_cur_offset; /* used during llog_process */
345 struct llog_ctxt *lgh_ctxt;
347 struct plain_handle_data phd;
348 struct cat_handle_data chd;
352 struct llog_operations *lgh_logops;
356 extern struct llog_operations llog_lvfs_ops;
357 int llog_get_cat_list(struct obd_device *disk_obd,
358 char *name, int idx, int count,
359 struct llog_catid *idarray);
361 int llog_put_cat_list(struct obd_device *disk_obd,
362 char *name, int idx, int count, struct llog_catid *idarray);
365 extern struct llog_operations llog_osd_ops;
366 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
367 int idx, int count, struct llog_catid *idarray);
368 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
369 int idx, int count, struct llog_catid *idarray);
371 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
372 #define LLOG_CTXT_FLAG_STOP 0x00000002
375 int loc_idx; /* my index the obd array of ctxt's */
376 struct llog_gen loc_gen;
377 struct obd_device *loc_obd; /* points back to the containing obd*/
378 struct obd_llog_group *loc_olg; /* group containing that ctxt */
379 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
380 struct obd_import *loc_imp; /* to use in RPC's: can be backward
382 struct llog_operations *loc_logops;
383 struct llog_handle *loc_handle;
384 struct llog_commit_master *loc_lcm;
385 struct llog_canceld_ctxt *loc_llcd;
386 struct mutex loc_mutex; /* protect loc_llcd and loc_imp */
387 cfs_atomic_t loc_refcount;
389 long loc_flags; /* flags, see above defines */
390 struct dt_object *loc_dir;
393 #define LCM_NAME_SIZE 64
395 struct llog_commit_master {
397 * Thread control flags (start, stop, etc.)
401 * Number of llcds onthis lcm.
403 cfs_atomic_t lcm_count;
405 * The refcount for lcm
407 cfs_atomic_t lcm_refcount;
409 * Thread control structure. Used for control commit thread.
411 struct ptlrpcd_ctl lcm_pc;
413 * Lock protecting list of llcds.
417 * Llcds in flight for debugging purposes.
419 cfs_list_t lcm_llcds;
421 * Commit thread name buffer. Only used for thread start.
423 char lcm_name[LCM_NAME_SIZE];
426 static inline struct llog_commit_master
427 *lcm_get(struct llog_commit_master *lcm)
429 cfs_atomic_inc(&lcm->lcm_refcount);
434 lcm_put(struct llog_commit_master *lcm)
436 LASSERT_ATOMIC_POS(&lcm->lcm_refcount);
437 if (cfs_atomic_dec_and_test(&lcm->lcm_refcount))
441 struct llog_canceld_ctxt {
443 * Llog context this llcd is attached to. Used for accessing
444 * ->loc_import and others in process of canceling cookies
445 * gathered in this llcd.
447 struct llog_ctxt *llcd_ctxt;
449 * Cancel thread control stucture pointer. Used for accessing
450 * it to see if should stop processing and other needs.
452 struct llog_commit_master *llcd_lcm;
454 * Maximal llcd size. Used in calculations on how much of room
455 * left in llcd to cookie comming cookies.
459 * Link to lcm llcds list.
461 cfs_list_t llcd_list;
463 * Current llcd size while gathering cookies. This should not be
464 * more than ->llcd_size. Used for determining if we need to
465 * send this llcd (if full) and allocate new one. This is also
466 * used for copying new cookie at the end of buffer.
468 int llcd_cookiebytes;
470 * Pointer to the start of cookies buffer.
472 struct llog_cookie llcd_cookies[0];
475 /* ptlrpc/recov_thread.c */
476 extern struct llog_commit_master *llog_recov_thread_init(char *name);
477 extern void llog_recov_thread_fini(struct llog_commit_master *lcm,
479 extern int llog_recov_thread_start(struct llog_commit_master *lcm);
480 extern void llog_recov_thread_stop(struct llog_commit_master *lcm,
483 static inline void llog_gen_init(struct llog_ctxt *ctxt)
485 struct obd_device *obd = ctxt->loc_exp->exp_obd;
487 LASSERTF(obd->u.obt.obt_magic == OBT_MAGIC,
488 "%s: wrong obt magic %#x\n",
489 obd->obd_name, obd->u.obt.obt_magic);
490 ctxt->loc_gen.mnt_cnt = obd->u.obt.obt_mount_count;
491 ctxt->loc_gen.conn_cnt++;
494 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
496 if (a.mnt_cnt < b.mnt_cnt)
498 if (a.mnt_cnt > b.mnt_cnt)
500 return(a.conn_cnt < b.conn_cnt ? 1 : 0);
503 #define LLOG_PROC_BREAK 0x0001
504 #define LLOG_DEL_RECORD 0x0002
506 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
507 struct llog_operations **lop)
512 *lop = ctxt->loc_logops;
519 static inline int llog_handle2ops(struct llog_handle *loghandle,
520 struct llog_operations **lop)
522 if (loghandle == NULL || loghandle->lgh_logops == NULL)
525 *lop = loghandle->lgh_logops;
529 static inline int llog_data_len(int len)
531 return cfs_size_round(len);
534 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
536 cfs_atomic_inc(&ctxt->loc_refcount);
537 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
538 cfs_atomic_read(&ctxt->loc_refcount));
542 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
546 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
547 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
548 cfs_atomic_read(&ctxt->loc_refcount) - 1);
549 __llog_ctxt_put(NULL, ctxt);
552 static inline void llog_group_init(struct obd_llog_group *olg, int group)
554 cfs_waitq_init(&olg->olg_waitq);
555 spin_lock_init(&olg->olg_lock);
556 mutex_init(&olg->olg_cat_processing);
557 olg->olg_seq = group;
560 static inline void llog_group_set_export(struct obd_llog_group *olg,
561 struct obd_export *exp)
563 LASSERT(exp != NULL);
565 spin_lock(&olg->olg_lock);
566 if (olg->olg_exp != NULL && olg->olg_exp != exp)
567 CWARN("%s: export for group %d is changed: 0x%p -> 0x%p\n",
568 exp->exp_obd->obd_name, olg->olg_seq,
571 spin_unlock(&olg->olg_lock);
574 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
575 struct llog_ctxt *ctxt, int index)
577 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
579 spin_lock(&olg->olg_lock);
580 if (olg->olg_ctxts[index] != NULL) {
581 spin_unlock(&olg->olg_lock);
584 olg->olg_ctxts[index] = ctxt;
585 spin_unlock(&olg->olg_lock);
589 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
592 struct llog_ctxt *ctxt;
594 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
596 spin_lock(&olg->olg_lock);
597 if (olg->olg_ctxts[index] == NULL)
600 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
601 spin_unlock(&olg->olg_lock);
605 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
607 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
608 spin_lock(&olg->olg_lock);
609 olg->olg_ctxts[index] = NULL;
610 spin_unlock(&olg->olg_lock);
613 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
616 return llog_group_get_ctxt(&obd->obd_olg, index);
619 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
621 return (olg->olg_ctxts[index] == NULL);
624 static inline int llog_ctxt_null(struct obd_device *obd, int index)
626 return (llog_group_ctxt_null(&obd->obd_olg, index));
629 static inline int llog_destroy(const struct lu_env *env,
630 struct llog_handle *handle)
632 struct llog_operations *lop;
637 rc = llog_handle2ops(handle, &lop);
640 if (lop->lop_destroy == NULL)
643 rc = lop->lop_destroy(env, handle);
647 static inline int llog_next_block(const struct lu_env *env,
648 struct llog_handle *loghandle, int *cur_idx,
649 int next_idx, __u64 *cur_offset, void *buf,
652 struct llog_operations *lop;
657 rc = llog_handle2ops(loghandle, &lop);
660 if (lop->lop_next_block == NULL)
663 rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
664 cur_offset, buf, len);
668 static inline int llog_prev_block(const struct lu_env *env,
669 struct llog_handle *loghandle,
670 int prev_idx, void *buf, int len)
672 struct llog_operations *lop;
677 rc = llog_handle2ops(loghandle, &lop);
680 if (lop->lop_prev_block == NULL)
683 rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
687 static inline int llog_connect(struct llog_ctxt *ctxt,
688 struct llog_logid *logid, struct llog_gen *gen,
689 struct obd_uuid *uuid)
691 struct llog_operations *lop;
696 rc = llog_obd2ops(ctxt, &lop);
699 if (lop->lop_connect == NULL)
702 rc = lop->lop_connect(ctxt, logid, gen, uuid);
707 int llog_exist(struct llog_handle *loghandle);
708 int llog_declare_create(const struct lu_env *env,
709 struct llog_handle *loghandle, struct thandle *th);
710 int llog_create(const struct lu_env *env, struct llog_handle *handle,
712 int llog_declare_write_rec(const struct lu_env *env,
713 struct llog_handle *handle,
714 struct llog_rec_hdr *rec, int idx,
716 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
717 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
718 int numcookies, void *buf, int idx, struct thandle *th);
719 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
720 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
721 void *buf, struct thandle *th);
722 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
723 struct llog_rec_hdr *rec, struct thandle *th);
724 int lustre_process_log(struct super_block *sb, char *logname,
725 struct config_llog_instance *cfg);
726 int lustre_end_log(struct super_block *sb, char *logname,
727 struct config_llog_instance *cfg);
728 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
729 struct llog_handle **res, struct llog_logid *logid,
731 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
732 struct llog_logid *logid, char *name);
733 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
734 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
735 int cookiecount, void *buf, int idx);