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_copy_handler(const struct lu_env *env, struct llog_handle *llh,
122 struct llog_rec_hdr *rec, void *data);
123 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
124 llog_cb_t cb, void *data, void *catdata);
125 int llog_process_or_fork(const struct lu_env *env,
126 struct llog_handle *loghandle,
127 llog_cb_t cb, void *data, void *catdata, bool fork);
128 int llog_reverse_process(const struct lu_env *env,
129 struct llog_handle *loghandle, llog_cb_t cb,
130 void *data, void *catdata);
131 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
133 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
134 struct llog_handle **lgh, struct llog_logid *logid,
135 char *name, enum llog_open_param open_param);
136 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
137 int llog_get_size(struct llog_handle *loghandle);
139 /* llog_process flags */
140 #define LLOG_FLAG_NODEAMON 0x0001
142 /* llog_cat.c - catalog api */
143 struct llog_process_data {
145 * Any useful data needed while processing catalog. This is
146 * passed later to process callback.
150 * Catalog process callback function, called for each record
155 * Start processing the catalog from startcat/startidx
161 struct llog_process_cat_data {
163 * Temporary stored first_idx while scanning log.
167 * Temporary stored last_idx while scanning log.
172 struct llog_process_cat_args {
174 * Llog context used in recovery thread on OST (recov_thread.c)
176 struct llog_ctxt *lpca_ctxt;
178 * Llog callback used in recovery thread on OST (recov_thread.c)
182 * Data pointer for llog callback.
187 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
188 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
189 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
190 void *buf, struct thandle *th);
191 int llog_cat_declare_add_rec(const struct lu_env *env,
192 struct llog_handle *cathandle,
193 struct llog_rec_hdr *rec, struct thandle *th);
194 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
195 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
197 int llog_cat_cancel_records(const struct lu_env *env,
198 struct llog_handle *cathandle, int count,
199 struct llog_cookie *cookies);
200 int llog_cat_process_or_fork(const struct lu_env *env,
201 struct llog_handle *cat_llh, llog_cb_t cb,
202 void *data, int startcat, int startidx, bool fork);
203 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
204 llog_cb_t cb, void *data, int startcat, int startidx);
205 int llog_cat_process_thread(void *data);
206 int llog_cat_reverse_process(const struct lu_env *env,
207 struct llog_handle *cat_llh, llog_cb_t cb,
209 int llog_cat_init_and_process(const struct lu_env *env,
210 struct llog_handle *llh);
213 int llog_setup(const struct lu_env *env, struct obd_device *obd,
214 struct obd_llog_group *olg, int index,
215 struct obd_device *disk_obd, struct llog_operations *op);
216 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
217 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
218 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
219 int llog_obd_add(const struct lu_env *env, struct llog_ctxt *ctxt,
220 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
221 struct llog_cookie *logcookies, int numcookies);
222 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
223 struct lov_stripe_md *lsm, int count,
224 struct llog_cookie *cookies, int flags);
225 int llog_obd_origin_add(const struct lu_env *env, struct llog_ctxt *ctxt,
226 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
227 struct llog_cookie *logcookies, int numcookies);
229 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
230 struct obd_device *disk_obd, int *idx);
232 int obd_llog_finish(struct obd_device *obd, int count);
235 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
236 struct obd_ioctl_data *data);
237 int llog_catalog_list(struct obd_device *obd, int count,
238 struct obd_ioctl_data *data);
241 int llog_initiator_connect(struct llog_ctxt *ctxt);
242 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
243 int llog_origin_connect(struct llog_ctxt *ctxt,
244 struct llog_logid *logid, struct llog_gen *gen,
245 struct obd_uuid *uuid);
246 int llog_handle_connect(struct ptlrpc_request *req);
249 int llog_obd_repl_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
250 struct lov_stripe_md *lsm, int count,
251 struct llog_cookie *cookies, int flags);
252 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp,
254 int llog_obd_repl_connect(struct llog_ctxt *ctxt,
255 struct llog_logid *logid, struct llog_gen *gen,
256 struct obd_uuid *uuid);
258 struct llog_operations {
259 int (*lop_destroy)(const struct lu_env *env,
260 struct llog_handle *handle);
261 int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
262 int *curr_idx, int next_idx, __u64 *offset,
264 int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
265 int prev_idx, void *buf, int len);
266 int (*lop_read_header)(const struct lu_env *env,
267 struct llog_handle *handle);
268 int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
269 struct obd_llog_group *olg, int ctxt_idx,
270 struct obd_device *disk_obd);
271 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
273 int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
274 int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
275 struct lov_stripe_md *lsm, int count,
276 struct llog_cookie *cookies, int flags);
277 int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
278 struct llog_gen *gen, struct obd_uuid *uuid);
280 * Any llog file must be opened first using llog_open(). Llog can be
281 * opened by name, logid or without both, in last case the new logid
284 int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
285 struct llog_logid *logid, char *name,
286 enum llog_open_param);
288 * Opened llog may not exist and this must be checked where needed using
289 * the llog_exist() call.
291 int (*lop_exist)(struct llog_handle *lgh);
293 * Close llog file and calls llog_free_handle() implicitly.
294 * Any opened llog must be closed by llog_close() call.
296 int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
298 * Create new llog file. The llog must be opened.
299 * Must be used only for local llog operations.
301 int (*lop_declare_create)(const struct lu_env *env,
302 struct llog_handle *handle,
304 int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
307 * write new record in llog. It appends records usually but can edit
308 * existing records too.
310 int (*lop_declare_write_rec)(const struct lu_env *env,
311 struct llog_handle *lgh,
312 struct llog_rec_hdr *rec,
313 int idx, struct thandle *th);
314 int (*lop_write_rec)(const struct lu_env *env,
315 struct llog_handle *loghandle,
316 struct llog_rec_hdr *rec,
317 struct llog_cookie *cookie, int cookiecount,
318 void *buf, int idx, struct thandle *th);
320 * Add new record in llog catalog. Does the same as llog_write_rec()
321 * but using llog catalog.
323 int (*lop_declare_add)(const struct lu_env *env,
324 struct llog_handle *lgh,
325 struct llog_rec_hdr *rec, struct thandle *th);
326 int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
327 struct llog_rec_hdr *rec, struct llog_cookie *cookie,
328 void *buf, struct thandle *th);
329 /* Old llog_add version, used in MDS-LOV-OSC now and will gone with
330 * LOD/OSP replacement */
331 int (*lop_obd_add)(const struct lu_env *env, struct llog_ctxt *ctxt,
332 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
333 struct llog_cookie *logcookies, int numcookies);
336 /* In-memory descriptor for a log object or log catalog */
338 struct rw_semaphore lgh_lock;
339 spinlock_t lgh_hdr_lock; /* protect lgh_hdr data */
340 struct llog_logid lgh_id; /* id of this log */
341 struct llog_log_hdr *lgh_hdr;
342 struct file *lgh_file;
343 struct dt_object *lgh_obj;
345 int lgh_cur_idx; /* used during llog_process */
346 __u64 lgh_cur_offset; /* used during llog_process */
347 struct llog_ctxt *lgh_ctxt;
349 struct plain_handle_data phd;
350 struct cat_handle_data chd;
354 struct llog_operations *lgh_logops;
355 cfs_atomic_t lgh_refcount;
359 extern struct llog_operations llog_lvfs_ops;
360 int llog_get_cat_list(struct obd_device *disk_obd,
361 char *name, int idx, int count,
362 struct llog_catid *idarray);
364 int llog_put_cat_list(struct obd_device *disk_obd,
365 char *name, int idx, int count, struct llog_catid *idarray);
368 extern struct llog_operations llog_osd_ops;
369 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
370 int idx, int count, struct llog_catid *idarray);
371 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
372 int idx, int count, struct llog_catid *idarray);
374 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
375 #define LLOG_CTXT_FLAG_STOP 0x00000002
378 int loc_idx; /* my index the obd array of ctxt's */
379 struct llog_gen loc_gen;
380 struct obd_device *loc_obd; /* points back to the containing obd*/
381 struct obd_llog_group *loc_olg; /* group containing that ctxt */
382 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
383 struct obd_import *loc_imp; /* to use in RPC's: can be backward
385 struct llog_operations *loc_logops;
386 struct llog_handle *loc_handle;
387 struct llog_commit_master *loc_lcm;
388 struct llog_canceld_ctxt *loc_llcd;
389 struct mutex loc_mutex; /* protect loc_llcd and loc_imp */
390 cfs_atomic_t loc_refcount;
392 long loc_flags; /* flags, see above defines */
393 struct dt_object *loc_dir;
396 #define LCM_NAME_SIZE 64
398 struct llog_commit_master {
400 * Thread control flags (start, stop, etc.)
404 * Number of llcds onthis lcm.
406 cfs_atomic_t lcm_count;
408 * The refcount for lcm
410 cfs_atomic_t lcm_refcount;
412 * Thread control structure. Used for control commit thread.
414 struct ptlrpcd_ctl lcm_pc;
416 * Lock protecting list of llcds.
420 * Llcds in flight for debugging purposes.
422 cfs_list_t lcm_llcds;
424 * Commit thread name buffer. Only used for thread start.
426 char lcm_name[LCM_NAME_SIZE];
429 static inline struct llog_commit_master
430 *lcm_get(struct llog_commit_master *lcm)
432 cfs_atomic_inc(&lcm->lcm_refcount);
437 lcm_put(struct llog_commit_master *lcm)
439 LASSERT_ATOMIC_POS(&lcm->lcm_refcount);
440 if (cfs_atomic_dec_and_test(&lcm->lcm_refcount))
444 struct llog_canceld_ctxt {
446 * Llog context this llcd is attached to. Used for accessing
447 * ->loc_import and others in process of canceling cookies
448 * gathered in this llcd.
450 struct llog_ctxt *llcd_ctxt;
452 * Cancel thread control stucture pointer. Used for accessing
453 * it to see if should stop processing and other needs.
455 struct llog_commit_master *llcd_lcm;
457 * Maximal llcd size. Used in calculations on how much of room
458 * left in llcd to cookie comming cookies.
462 * Link to lcm llcds list.
464 cfs_list_t llcd_list;
466 * Current llcd size while gathering cookies. This should not be
467 * more than ->llcd_size. Used for determining if we need to
468 * send this llcd (if full) and allocate new one. This is also
469 * used for copying new cookie at the end of buffer.
471 int llcd_cookiebytes;
473 * Pointer to the start of cookies buffer.
475 struct llog_cookie llcd_cookies[0];
478 /* ptlrpc/recov_thread.c */
479 extern struct llog_commit_master *llog_recov_thread_init(char *name);
480 extern void llog_recov_thread_fini(struct llog_commit_master *lcm,
482 extern int llog_recov_thread_start(struct llog_commit_master *lcm);
483 extern void llog_recov_thread_stop(struct llog_commit_master *lcm,
486 static inline void llog_gen_init(struct llog_ctxt *ctxt)
488 struct obd_device *obd = ctxt->loc_exp->exp_obd;
490 LASSERTF(obd->u.obt.obt_magic == OBT_MAGIC,
491 "%s: wrong obt magic %#x\n",
492 obd->obd_name, obd->u.obt.obt_magic);
493 ctxt->loc_gen.mnt_cnt = obd->u.obt.obt_mount_count;
494 ctxt->loc_gen.conn_cnt++;
497 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
499 if (a.mnt_cnt < b.mnt_cnt)
501 if (a.mnt_cnt > b.mnt_cnt)
503 return(a.conn_cnt < b.conn_cnt ? 1 : 0);
506 #define LLOG_PROC_BREAK 0x0001
507 #define LLOG_DEL_RECORD 0x0002
509 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
510 struct llog_operations **lop)
515 *lop = ctxt->loc_logops;
522 static inline int llog_handle2ops(struct llog_handle *loghandle,
523 struct llog_operations **lop)
525 if (loghandle == NULL || loghandle->lgh_logops == NULL)
528 *lop = loghandle->lgh_logops;
532 static inline int llog_data_len(int len)
534 return cfs_size_round(len);
537 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
539 cfs_atomic_inc(&ctxt->loc_refcount);
540 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
541 cfs_atomic_read(&ctxt->loc_refcount));
545 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
549 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
550 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
551 cfs_atomic_read(&ctxt->loc_refcount) - 1);
552 __llog_ctxt_put(NULL, ctxt);
555 static inline void llog_group_init(struct obd_llog_group *olg, int group)
557 cfs_waitq_init(&olg->olg_waitq);
558 spin_lock_init(&olg->olg_lock);
559 mutex_init(&olg->olg_cat_processing);
560 olg->olg_seq = group;
563 static inline void llog_group_set_export(struct obd_llog_group *olg,
564 struct obd_export *exp)
566 LASSERT(exp != NULL);
568 spin_lock(&olg->olg_lock);
569 if (olg->olg_exp != NULL && olg->olg_exp != exp)
570 CWARN("%s: export for group %d is changed: 0x%p -> 0x%p\n",
571 exp->exp_obd->obd_name, olg->olg_seq,
574 spin_unlock(&olg->olg_lock);
577 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
578 struct llog_ctxt *ctxt, int index)
580 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
582 spin_lock(&olg->olg_lock);
583 if (olg->olg_ctxts[index] != NULL) {
584 spin_unlock(&olg->olg_lock);
587 olg->olg_ctxts[index] = ctxt;
588 spin_unlock(&olg->olg_lock);
592 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
595 struct llog_ctxt *ctxt;
597 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
599 spin_lock(&olg->olg_lock);
600 if (olg->olg_ctxts[index] == NULL)
603 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
604 spin_unlock(&olg->olg_lock);
608 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
610 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
611 spin_lock(&olg->olg_lock);
612 olg->olg_ctxts[index] = NULL;
613 spin_unlock(&olg->olg_lock);
616 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
619 return llog_group_get_ctxt(&obd->obd_olg, index);
622 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
624 return (olg->olg_ctxts[index] == NULL);
627 static inline int llog_ctxt_null(struct obd_device *obd, int index)
629 return (llog_group_ctxt_null(&obd->obd_olg, index));
632 static inline int llog_destroy(const struct lu_env *env,
633 struct llog_handle *handle)
635 struct llog_operations *lop;
640 rc = llog_handle2ops(handle, &lop);
643 if (lop->lop_destroy == NULL)
646 rc = lop->lop_destroy(env, handle);
650 static inline int llog_next_block(const struct lu_env *env,
651 struct llog_handle *loghandle, int *cur_idx,
652 int next_idx, __u64 *cur_offset, void *buf,
655 struct llog_operations *lop;
660 rc = llog_handle2ops(loghandle, &lop);
663 if (lop->lop_next_block == NULL)
666 rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
667 cur_offset, buf, len);
671 static inline int llog_prev_block(const struct lu_env *env,
672 struct llog_handle *loghandle,
673 int prev_idx, void *buf, int len)
675 struct llog_operations *lop;
680 rc = llog_handle2ops(loghandle, &lop);
683 if (lop->lop_prev_block == NULL)
686 rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
690 static inline int llog_connect(struct llog_ctxt *ctxt,
691 struct llog_logid *logid, struct llog_gen *gen,
692 struct obd_uuid *uuid)
694 struct llog_operations *lop;
699 rc = llog_obd2ops(ctxt, &lop);
702 if (lop->lop_connect == NULL)
705 rc = lop->lop_connect(ctxt, logid, gen, uuid);
710 int llog_exist(struct llog_handle *loghandle);
711 int llog_declare_create(const struct lu_env *env,
712 struct llog_handle *loghandle, struct thandle *th);
713 int llog_create(const struct lu_env *env, struct llog_handle *handle,
715 int llog_declare_write_rec(const struct lu_env *env,
716 struct llog_handle *handle,
717 struct llog_rec_hdr *rec, int idx,
719 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
720 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
721 int numcookies, void *buf, int idx, struct thandle *th);
722 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
723 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
724 void *buf, struct thandle *th);
725 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
726 struct llog_rec_hdr *rec, struct thandle *th);
727 int lustre_process_log(struct super_block *sb, char *logname,
728 struct config_llog_instance *cfg);
729 int lustre_end_log(struct super_block *sb, char *logname,
730 struct config_llog_instance *cfg);
731 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
732 struct llog_handle **res, struct llog_logid *logid,
734 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
735 struct llog_logid *logid, char *name);
736 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
737 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
738 int cookiecount, void *buf, int idx);