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, Whamcloud, Inc.
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 struct plain_handle_data {
80 struct llog_handle *phd_cat_handle;
81 struct llog_cookie phd_cookie; /* cookie of this log in its cat */
84 struct cat_handle_data {
86 struct llog_handle *chd_current_log; /* currently open log */
87 struct llog_handle *chd_next_log; /* llog to be used next */
90 static inline void logid_to_fid(struct llog_logid *id, struct lu_fid *fid)
92 /* For compatibility purposes we identify pre-OSD (~< 2.3.51 MDS)
93 * logid's by non-zero ogen (inode generation) and convert them
95 if (id->lgl_ogen == 0) {
96 fid->f_seq = id->lgl_oseq;
97 fid->f_oid = id->lgl_oid;
100 lu_igif_build(fid, id->lgl_oid, id->lgl_ogen);
104 static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
106 id->lgl_oseq = fid->f_seq;
107 id->lgl_oid = fid->f_oid;
113 /* llog.c - general API */
114 typedef int (*llog_cb_t)(struct llog_handle *, struct llog_rec_hdr *, void *);
115 typedef int (*llog_fill_rec_cb_t)(struct llog_rec_hdr *rec, void *data);
116 extern struct llog_handle *llog_alloc_handle(void);
117 int llog_init_handle(struct llog_handle *handle, int flags,
118 struct obd_uuid *uuid);
119 extern void llog_free_handle(struct llog_handle *handle);
120 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
121 llog_cb_t cb, void *data, void *catdata);
122 int llog_reverse_process(const struct lu_env *env,
123 struct llog_handle *loghandle, llog_cb_t cb,
124 void *data, void *catdata);
125 extern int llog_cancel_rec(struct llog_handle *loghandle, int index);
126 extern int llog_close(struct llog_handle *cathandle);
127 extern int llog_get_size(struct llog_handle *loghandle);
129 /* llog_process flags */
130 #define LLOG_FLAG_NODEAMON 0x0001
132 /* llog_cat.c - catalog api */
133 struct llog_process_data {
135 * Any useful data needed while processing catalog. This is
136 * passed later to process callback.
140 * Catalog process callback function, called for each record
145 * Start processing the catalog from startcat/startidx
151 struct llog_process_cat_data {
153 * Temporary stored first_idx while scanning log.
157 * Temporary stored last_idx while scanning log.
162 struct llog_process_cat_args {
164 * Llog context used in recovery thread on OST (recov_thread.c)
166 struct llog_ctxt *lpca_ctxt;
168 * Llog callback used in recovery thread on OST (recov_thread.c)
172 * Data pointer for llog callback.
177 int llog_cat_put(struct llog_handle *cathandle);
178 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
179 struct llog_cookie *reccookie, void *buf);
180 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
181 struct llog_cookie *cookies);
182 int __llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
183 llog_cb_t cb, void *data, int startcat, int startidx,
185 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
186 llog_cb_t cb, void *data, int startcat, int startidx);
187 int llog_cat_process_thread(void *data);
188 int llog_cat_reverse_process(const struct lu_env *env,
189 struct llog_handle *cat_llh, llog_cb_t cb,
191 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index);
194 int llog_setup_named(struct obd_device *obd, struct obd_llog_group *olg,
195 int index, struct obd_device *disk_obd, int count,
196 struct llog_logid *logid, const char *logname,
197 struct llog_operations *op);
198 int llog_setup(struct obd_device *obd, struct obd_llog_group *olg, int index,
199 struct obd_device *disk_obd, int count, struct llog_logid *logid,
200 struct llog_operations *op);
201 int __llog_ctxt_put(struct llog_ctxt *ctxt);
202 int llog_cleanup(struct llog_ctxt *);
203 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
204 int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
205 struct lov_stripe_md *lsm, struct llog_cookie *logcookies,
207 int llog_cancel(struct llog_ctxt *, struct lov_stripe_md *lsm,
208 int count, struct llog_cookie *cookies, int flags);
210 int llog_obd_origin_setup(struct obd_device *obd, struct obd_llog_group *olg,
211 int index, struct obd_device *disk_obd, int count,
212 struct llog_logid *logid, const char *name);
213 int llog_obd_origin_cleanup(struct llog_ctxt *ctxt);
214 int llog_obd_origin_add(struct llog_ctxt *ctxt,
215 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
216 struct llog_cookie *logcookies, int numcookies);
218 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
219 struct obd_device *disk_obd, int *idx);
221 int obd_llog_finish(struct obd_device *obd, int count);
224 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
225 int llog_catalog_list(struct obd_device *obd, int count,
226 struct obd_ioctl_data *data);
229 int llog_initiator_connect(struct llog_ctxt *ctxt);
230 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
231 int llog_origin_connect(struct llog_ctxt *ctxt,
232 struct llog_logid *logid, struct llog_gen *gen,
233 struct obd_uuid *uuid);
234 int llog_handle_connect(struct ptlrpc_request *req);
237 int llog_obd_repl_cancel(struct llog_ctxt *ctxt,
238 struct lov_stripe_md *lsm, int count,
239 struct llog_cookie *cookies, int flags);
240 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp,
242 int llog_obd_repl_connect(struct llog_ctxt *ctxt,
243 struct llog_logid *logid, struct llog_gen *gen,
244 struct obd_uuid *uuid);
246 struct llog_operations {
247 int (*lop_write_rec)(struct llog_handle *loghandle,
248 struct llog_rec_hdr *rec,
249 struct llog_cookie *logcookies, int numcookies,
251 int (*lop_destroy)(struct llog_handle *handle);
252 int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
253 int next_idx, __u64 *offset, void *buf, int len);
254 int (*lop_prev_block)(struct llog_handle *h,
255 int prev_idx, void *buf, int len);
256 int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
257 struct llog_logid *logid, char *name);
258 int (*lop_close)(struct llog_handle *handle);
259 int (*lop_read_header)(struct llog_handle *handle);
261 int (*lop_setup)(struct obd_device *obd, struct obd_llog_group *olg,
262 int ctxt_idx, struct obd_device *disk_obd, int count,
263 struct llog_logid *logid, const char *name);
264 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
266 int (*lop_cleanup)(struct llog_ctxt *ctxt);
267 int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
268 struct lov_stripe_md *lsm,
269 struct llog_cookie *logcookies, int numcookies);
270 int (*lop_cancel)(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm,
271 int count, struct llog_cookie *cookies, int flags);
272 int (*lop_connect)(struct llog_ctxt *ctxt,
273 struct llog_logid *logid, struct llog_gen *gen,
274 struct obd_uuid *uuid);
275 /* XXX add 2 more: commit callbacks and llog recovery functions */
278 /* In-memory descriptor for a log object or log catalog */
280 cfs_rw_semaphore_t lgh_lock;
281 struct llog_logid lgh_id; /* id of this log */
282 struct llog_log_hdr *lgh_hdr;
283 cfs_spinlock_t lgh_hdr_lock; /* protect lgh_hdr data */
285 struct file *lgh_file;
286 struct dt_object *lgh_obj;
289 int lgh_cur_idx; /* used during llog_process */
290 __u64 lgh_cur_offset; /* used during llog_process */
291 struct llog_ctxt *lgh_ctxt;
293 struct plain_handle_data phd;
294 struct cat_handle_data chd;
298 struct llog_operations *lgh_logops;
302 extern struct llog_operations llog_lvfs_ops;
303 int llog_get_cat_list(struct obd_device *disk_obd,
304 char *name, int idx, int count,
305 struct llog_catid *idarray);
307 int llog_put_cat_list(struct obd_device *disk_obd,
308 char *name, int idx, int count, struct llog_catid *idarray);
310 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
311 #define LLOG_CTXT_FLAG_STOP 0x00000002
314 int loc_idx; /* my index the obd array of ctxt's */
315 struct llog_gen loc_gen;
316 struct obd_device *loc_obd; /* points back to the containing obd*/
317 struct obd_llog_group *loc_olg; /* group containing that ctxt */
318 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
319 struct obd_import *loc_imp; /* to use in RPC's: can be backward
321 struct llog_operations *loc_logops;
322 struct llog_handle *loc_handle;
323 struct llog_commit_master *loc_lcm;
324 struct llog_canceld_ctxt *loc_llcd;
325 cfs_mutex_t loc_mutex; /* protects loc_llcd and loc_imp */
326 cfs_atomic_t loc_refcount;
328 long loc_flags; /* flags, see above defines */
329 struct dt_object *loc_dir;
332 #define LCM_NAME_SIZE 64
334 struct llog_commit_master {
336 * Thread control flags (start, stop, etc.)
340 * Number of llcds onthis lcm.
342 cfs_atomic_t lcm_count;
344 * The refcount for lcm
346 cfs_atomic_t lcm_refcount;
348 * Thread control structure. Used for control commit thread.
350 struct ptlrpcd_ctl lcm_pc;
352 * Lock protecting list of llcds.
354 cfs_spinlock_t lcm_lock;
356 * Llcds in flight for debugging purposes.
358 cfs_list_t lcm_llcds;
360 * Commit thread name buffer. Only used for thread start.
362 char lcm_name[LCM_NAME_SIZE];
365 static inline struct llog_commit_master
366 *lcm_get(struct llog_commit_master *lcm)
368 cfs_atomic_inc(&lcm->lcm_refcount);
373 lcm_put(struct llog_commit_master *lcm)
375 LASSERT_ATOMIC_POS(&lcm->lcm_refcount);
376 if (cfs_atomic_dec_and_test(&lcm->lcm_refcount))
380 struct llog_canceld_ctxt {
382 * Llog context this llcd is attached to. Used for accessing
383 * ->loc_import and others in process of canceling cookies
384 * gathered in this llcd.
386 struct llog_ctxt *llcd_ctxt;
388 * Cancel thread control stucture pointer. Used for accessing
389 * it to see if should stop processing and other needs.
391 struct llog_commit_master *llcd_lcm;
393 * Maximal llcd size. Used in calculations on how much of room
394 * left in llcd to cookie comming cookies.
398 * Link to lcm llcds list.
400 cfs_list_t llcd_list;
402 * Current llcd size while gathering cookies. This should not be
403 * more than ->llcd_size. Used for determining if we need to
404 * send this llcd (if full) and allocate new one. This is also
405 * used for copying new cookie at the end of buffer.
407 int llcd_cookiebytes;
409 * Pointer to the start of cookies buffer.
411 struct llog_cookie llcd_cookies[0];
414 /* ptlrpc/recov_thread.c */
415 extern struct llog_commit_master *llog_recov_thread_init(char *name);
416 extern void llog_recov_thread_fini(struct llog_commit_master *lcm,
418 extern int llog_recov_thread_start(struct llog_commit_master *lcm);
419 extern void llog_recov_thread_stop(struct llog_commit_master *lcm,
422 static inline void llog_gen_init(struct llog_ctxt *ctxt)
424 struct obd_device *obd = ctxt->loc_exp->exp_obd;
426 LASSERTF(obd->u.obt.obt_magic == OBT_MAGIC,
427 "%s: wrong obt magic %#x\n",
428 obd->obd_name, obd->u.obt.obt_magic);
429 ctxt->loc_gen.mnt_cnt = obd->u.obt.obt_mount_count;
430 ctxt->loc_gen.conn_cnt++;
433 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
435 if (a.mnt_cnt < b.mnt_cnt)
437 if (a.mnt_cnt > b.mnt_cnt)
439 return(a.conn_cnt < b.conn_cnt ? 1 : 0);
442 #define LLOG_PROC_BREAK 0x0001
443 #define LLOG_DEL_RECORD 0x0002
445 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
446 struct llog_operations **lop)
451 *lop = ctxt->loc_logops;
458 static inline int llog_handle2ops(struct llog_handle *loghandle,
459 struct llog_operations **lop)
461 if (loghandle == NULL)
464 return llog_obd2ops(loghandle->lgh_ctxt, lop);
467 static inline int llog_data_len(int len)
469 return cfs_size_round(len);
472 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
474 cfs_atomic_inc(&ctxt->loc_refcount);
475 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
476 cfs_atomic_read(&ctxt->loc_refcount));
480 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
484 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
485 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
486 cfs_atomic_read(&ctxt->loc_refcount) - 1);
487 __llog_ctxt_put(ctxt);
490 static inline void llog_group_init(struct obd_llog_group *olg, int group)
492 cfs_waitq_init(&olg->olg_waitq);
493 cfs_spin_lock_init(&olg->olg_lock);
494 cfs_mutex_init(&olg->olg_cat_processing);
495 olg->olg_seq = group;
498 static inline void llog_group_set_export(struct obd_llog_group *olg,
499 struct obd_export *exp)
501 LASSERT(exp != NULL);
503 cfs_spin_lock(&olg->olg_lock);
504 if (olg->olg_exp != NULL && olg->olg_exp != exp)
505 CWARN("%s: export for group %d is changed: 0x%p -> 0x%p\n",
506 exp->exp_obd->obd_name, olg->olg_seq,
509 cfs_spin_unlock(&olg->olg_lock);
512 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
513 struct llog_ctxt *ctxt, int index)
515 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
517 cfs_spin_lock(&olg->olg_lock);
518 if (olg->olg_ctxts[index] != NULL) {
519 cfs_spin_unlock(&olg->olg_lock);
522 olg->olg_ctxts[index] = ctxt;
523 cfs_spin_unlock(&olg->olg_lock);
527 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
530 struct llog_ctxt *ctxt;
532 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
534 cfs_spin_lock(&olg->olg_lock);
535 if (olg->olg_ctxts[index] == NULL) {
538 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
540 cfs_spin_unlock(&olg->olg_lock);
544 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
547 return llog_group_get_ctxt(&obd->obd_olg, index);
550 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
552 return (olg->olg_ctxts[index] == NULL);
555 static inline int llog_ctxt_null(struct obd_device *obd, int index)
557 return (llog_group_ctxt_null(&obd->obd_olg, index));
560 static inline int llog_write_rec(struct llog_handle *handle,
561 struct llog_rec_hdr *rec,
562 struct llog_cookie *logcookies,
563 int numcookies, void *buf, int idx)
565 struct llog_operations *lop;
566 int raised, rc, buflen;
569 rc = llog_handle2ops(handle, &lop);
573 if (lop->lop_write_rec == NULL)
576 /* FIXME: Why doesn't caller just set the right lrh_len itself? */
578 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr)
579 + sizeof(struct llog_rec_tail);
581 buflen = rec->lrh_len;
582 LASSERT(cfs_size_round(buflen) == buflen);
584 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
586 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
587 rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
589 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
593 static inline int llog_read_header(struct llog_handle *handle)
595 struct llog_operations *lop;
599 rc = llog_handle2ops(handle, &lop);
602 if (lop->lop_read_header == NULL)
605 rc = lop->lop_read_header(handle);
609 static inline int llog_destroy(struct llog_handle *handle)
611 struct llog_operations *lop;
615 rc = llog_handle2ops(handle, &lop);
618 if (lop->lop_destroy == NULL)
621 rc = lop->lop_destroy(handle);
626 static inline int llog_cancel(struct obd_export *exp,
627 struct lov_stripe_md *lsm, int count,
628 struct llog_cookie *cookies, int flags)
630 struct llog_operations *lop;
634 rc = llog_handle2ops(loghandle, &lop);
637 if (lop->lop_cancel == NULL)
640 rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
645 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
646 int next_idx, __u64 *cur_offset, void *buf,
649 struct llog_operations *lop;
653 rc = llog_handle2ops(loghandle, &lop);
656 if (lop->lop_next_block == NULL)
659 rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
664 static inline int llog_prev_block(struct llog_handle *loghandle,
665 int prev_idx, void *buf, int len)
667 struct llog_operations *lop;
671 rc = llog_handle2ops(loghandle, &lop);
674 if (lop->lop_prev_block == NULL)
677 rc = lop->lop_prev_block(loghandle, prev_idx, buf, len);
681 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
682 struct llog_logid *logid, char *name)
684 struct llog_operations *lop;
688 rc = llog_obd2ops(ctxt, &lop);
691 if (lop->lop_create == NULL)
694 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
696 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
697 rc = lop->lop_create(ctxt, res, logid, name);
699 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
703 static inline int llog_connect(struct llog_ctxt *ctxt,
704 struct llog_logid *logid, struct llog_gen *gen,
705 struct obd_uuid *uuid)
707 struct llog_operations *lop;
711 rc = llog_obd2ops(ctxt, &lop);
714 if (lop->lop_connect == NULL)
717 rc = lop->lop_connect(ctxt, logid, gen, uuid);
721 int lustre_process_log(struct super_block *sb, char *logname,
722 struct config_llog_instance *cfg);
723 int lustre_end_log(struct super_block *sb, char *logname,
724 struct config_llog_instance *cfg);