1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
32 * Copyright (c) 2012, Whamcloud, Inc.
35 * This file is part of Lustre, http://www.lustre.org/
36 * Lustre is a trademark of Sun Microsystems, Inc.
38 * lustre/include/lustre_log.h
40 * Generic infrastructure for managing a collection of logs.
41 * These logs are used for:
43 * - orphan recovery: OST adds record on create
44 * - mtime/size consistency: the OST adds a record on first write
45 * - open/unlinked objects: OST adds a record on destroy
47 * - mds unlink log: the MDS adds an entry upon delete
49 * - raid1 replication log between OST's
50 * - MDS replication logs
61 #if defined(__linux__)
62 #include <linux/lustre_log.h>
63 #elif defined(__APPLE__)
64 #include <darwin/lustre_log.h>
65 #elif defined(__WINNT__)
66 #include <winnt/lustre_log.h>
68 #error Unsupported operating system.
71 #include <obd_class.h>
73 #include <lustre/lustre_idl.h>
75 #define LOG_NAME_LIMIT(logname, name) \
76 snprintf(logname, sizeof(logname), "LOGS/%s", name)
77 #define LLOG_EEMPTY 4711
79 struct plain_handle_data {
81 struct llog_handle *phd_cat_handle;
82 struct llog_cookie phd_cookie; /* cookie of this log in its cat */
86 struct cat_handle_data {
88 struct llog_handle *chd_current_log; /* currently open log */
91 /* In-memory descriptor for a log object or log catalog */
93 cfs_rw_semaphore_t lgh_lock;
94 struct llog_logid lgh_id; /* id of this log */
95 struct llog_log_hdr *lgh_hdr;
96 struct file *lgh_file;
98 int lgh_cur_idx; /* used during llog_process */
99 __u64 lgh_cur_offset; /* used during llog_process */
100 struct llog_ctxt *lgh_ctxt;
102 struct plain_handle_data phd;
103 struct cat_handle_data chd;
107 /* llog.c - general API */
108 typedef int (*llog_cb_t)(struct llog_handle *, struct llog_rec_hdr *, void *);
109 typedef int (*llog_fill_rec_cb_t)(struct llog_rec_hdr *rec, void *data);
110 extern struct llog_handle *llog_alloc_handle(void);
111 int llog_init_handle(struct llog_handle *handle, int flags,
112 struct obd_uuid *uuid);
113 extern void llog_free_handle(struct llog_handle *handle);
114 int llog_process(struct llog_handle *loghandle, llog_cb_t cb,
115 void *data, void *catdata);
116 int llog_process_flags(struct llog_handle *loghandle, llog_cb_t cb,
117 void *data, void *catdata, int flags);
118 int llog_reverse_process(struct llog_handle *loghandle, llog_cb_t cb,
119 void *data, void *catdata);
120 extern int llog_cancel_rec(struct llog_handle *loghandle, int index);
121 extern int llog_close(struct llog_handle *cathandle);
122 extern int llog_get_size(struct llog_handle *loghandle);
124 /* llog_process flags */
125 #define LLOG_FLAG_NODEAMON 0x0001
127 /* llog_cat.c - catalog api */
128 struct llog_process_data {
130 * Any useful data needed while processing catalog. This is
131 * passed later to process callback.
135 * Catalog process callback function, called for each record
140 * Start processing the catalog from startcat/startidx
144 int lpd_flags; /** llog_process flags */
147 struct llog_process_cat_data {
149 * Temporary stored first_idx while scanning log.
153 * Temporary stored last_idx while scanning log.
158 struct llog_process_cat_args {
160 * Llog context used in recovery thread on OST (recov_thread.c)
162 struct llog_ctxt *lpca_ctxt;
164 * Llog callback used in recovery thread on OST (recov_thread.c)
168 * Data pointer for llog callback.
173 int llog_cat_put(struct llog_handle *cathandle);
174 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
175 struct llog_cookie *reccookie, void *buf);
176 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
177 struct llog_cookie *cookies);
178 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data,
179 int startcat, int startidx);
180 int llog_cat_process_flags(struct llog_handle *cat_llh, llog_cb_t cb, void *data,
181 int flags, int startcat, int startidx);
182 int llog_cat_process_thread(void *data);
183 int llog_cat_reverse_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
184 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index);
187 int llog_setup_named(struct obd_device *obd, struct obd_llog_group *olg,
188 int index, struct obd_device *disk_obd, int count,
189 struct llog_logid *logid, const char *logname,
190 struct llog_operations *op);
191 int llog_setup(struct obd_device *obd, struct obd_llog_group *olg, int index,
192 struct obd_device *disk_obd, int count, struct llog_logid *logid,
193 struct llog_operations *op);
194 int __llog_ctxt_put(struct llog_ctxt *ctxt);
195 int llog_cleanup(struct llog_ctxt *);
196 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
197 int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
198 struct lov_stripe_md *lsm, struct llog_cookie *logcookies,
200 int llog_cancel(struct llog_ctxt *, struct lov_stripe_md *lsm,
201 int count, struct llog_cookie *cookies, int flags);
203 int llog_obd_origin_setup(struct obd_device *obd, struct obd_llog_group *olg,
204 int index, struct obd_device *disk_obd, int count,
205 struct llog_logid *logid, const char *name);
206 int llog_obd_origin_cleanup(struct llog_ctxt *ctxt);
207 int llog_obd_origin_add(struct llog_ctxt *ctxt,
208 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
209 struct llog_cookie *logcookies, int numcookies);
211 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
212 struct obd_device *disk_obd, int *idx);
214 int obd_llog_finish(struct obd_device *obd, int count);
217 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
218 int llog_catalog_list(struct obd_device *obd, int count,
219 struct obd_ioctl_data *data);
222 int llog_initiator_connect(struct llog_ctxt *ctxt);
223 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
224 int llog_origin_connect(struct llog_ctxt *ctxt,
225 struct llog_logid *logid, struct llog_gen *gen,
226 struct obd_uuid *uuid);
227 int llog_handle_connect(struct ptlrpc_request *req);
230 int llog_obd_repl_cancel(struct llog_ctxt *ctxt,
231 struct lov_stripe_md *lsm, int count,
232 struct llog_cookie *cookies, int flags);
233 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
234 int llog_obd_repl_connect(struct llog_ctxt *ctxt,
235 struct llog_logid *logid, struct llog_gen *gen,
236 struct obd_uuid *uuid);
238 struct llog_operations {
239 int (*lop_write_rec)(struct llog_handle *loghandle,
240 struct llog_rec_hdr *rec,
241 struct llog_cookie *logcookies, int numcookies,
243 int (*lop_destroy)(struct llog_handle *handle);
244 int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
245 int next_idx, __u64 *offset, void *buf, int len);
246 int (*lop_prev_block)(struct llog_handle *h,
247 int prev_idx, void *buf, int len);
248 int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
249 struct llog_logid *logid, char *name);
250 int (*lop_close)(struct llog_handle *handle);
251 int (*lop_read_header)(struct llog_handle *handle);
253 int (*lop_setup)(struct obd_device *obd, struct obd_llog_group *olg,
254 int ctxt_idx, struct obd_device *disk_obd, int count,
255 struct llog_logid *logid, const char *name);
256 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp);
257 int (*lop_cleanup)(struct llog_ctxt *ctxt);
258 int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
259 struct lov_stripe_md *lsm,
260 struct llog_cookie *logcookies, int numcookies);
261 int (*lop_cancel)(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm,
262 int count, struct llog_cookie *cookies, int flags);
263 int (*lop_connect)(struct llog_ctxt *ctxt,
264 struct llog_logid *logid, struct llog_gen *gen,
265 struct obd_uuid *uuid);
266 /* XXX add 2 more: commit callbacks and llog recovery functions */
270 extern struct llog_operations llog_lvfs_ops;
271 int llog_get_cat_list(struct obd_device *disk_obd,
272 char *name, int idx, int count,
273 struct llog_catid *idarray);
275 int llog_put_cat_list(struct obd_device *disk_obd,
276 char *name, int idx, int count, struct llog_catid *idarray);
278 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
281 int loc_idx; /* my index the obd array of ctxt's */
282 struct llog_gen loc_gen;
283 struct obd_device *loc_obd; /* points back to the containing obd*/
284 struct obd_llog_group *loc_olg; /* group containing that ctxt */
285 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
286 struct obd_import *loc_imp; /* to use in RPC's: can be backward
288 struct llog_operations *loc_logops;
289 struct llog_handle *loc_handle;
290 struct llog_commit_master *loc_lcm;
291 struct llog_canceld_ctxt *loc_llcd;
292 cfs_mutex_t loc_mutex; /* protects loc_llcd and loc_imp */
293 cfs_atomic_t loc_refcount;
295 long loc_flags; /* flags, see above defines */
298 #define LCM_NAME_SIZE 64
300 struct llog_commit_master {
302 * Thread control flags (start, stop, etc.)
306 * Number of llcds onthis lcm.
308 cfs_atomic_t lcm_count;
310 * The refcount for lcm
312 cfs_atomic_t lcm_refcount;
314 * Thread control structure. Used for control commit thread.
316 struct ptlrpcd_ctl lcm_pc;
318 * Lock protecting list of llcds.
320 cfs_spinlock_t lcm_lock;
322 * Llcds in flight for debugging purposes.
324 cfs_list_t lcm_llcds;
326 * Commit thread name buffer. Only used for thread start.
328 char lcm_name[LCM_NAME_SIZE];
331 static inline struct llog_commit_master
332 *lcm_get(struct llog_commit_master *lcm)
334 cfs_atomic_inc(&lcm->lcm_refcount);
339 lcm_put(struct llog_commit_master *lcm)
341 LASSERT_ATOMIC_POS(&lcm->lcm_refcount);
342 if (cfs_atomic_dec_and_test(&lcm->lcm_refcount))
346 struct llog_canceld_ctxt {
348 * Llog context this llcd is attached to. Used for accessing
349 * ->loc_import and others in process of canceling cookies
350 * gathered in this llcd.
352 struct llog_ctxt *llcd_ctxt;
354 * Cancel thread control stucture pointer. Used for accessing
355 * it to see if should stop processing and other needs.
357 struct llog_commit_master *llcd_lcm;
359 * Maximal llcd size. Used in calculations on how much of room
360 * left in llcd to cookie comming cookies.
364 * Link to lcm llcds list.
366 cfs_list_t llcd_list;
368 * Current llcd size while gathering cookies. This should not be
369 * more than ->llcd_size. Used for determining if we need to
370 * send this llcd (if full) and allocate new one. This is also
371 * used for copying new cookie at the end of buffer.
373 int llcd_cookiebytes;
375 * Pointer to the start of cookies buffer.
377 struct llog_cookie llcd_cookies[0];
380 /* ptlrpc/recov_thread.c */
381 extern struct llog_commit_master *llog_recov_thread_init(char *name);
382 extern void llog_recov_thread_fini(struct llog_commit_master *lcm,
384 extern int llog_recov_thread_start(struct llog_commit_master *lcm);
385 extern void llog_recov_thread_stop(struct llog_commit_master *lcm,
388 static inline void llog_gen_init(struct llog_ctxt *ctxt)
390 struct obd_device *obd = ctxt->loc_exp->exp_obd;
392 LASSERTF(obd->u.obt.obt_magic == OBT_MAGIC,
393 "%s: wrong obt magic %#x\n",
394 obd->obd_name, obd->u.obt.obt_magic);
395 ctxt->loc_gen.mnt_cnt = obd->u.obt.obt_mount_count;
396 ctxt->loc_gen.conn_cnt++;
399 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
401 if (a.mnt_cnt < b.mnt_cnt)
403 if (a.mnt_cnt > b.mnt_cnt)
405 return(a.conn_cnt < b.conn_cnt ? 1 : 0);
408 #define LLOG_PROC_BREAK 0x0001
409 #define LLOG_DEL_RECORD 0x0002
411 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
412 struct llog_operations **lop)
417 *lop = ctxt->loc_logops;
424 static inline int llog_handle2ops(struct llog_handle *loghandle,
425 struct llog_operations **lop)
427 if (loghandle == NULL)
430 return llog_obd2ops(loghandle->lgh_ctxt, lop);
433 static inline int llog_data_len(int len)
435 return cfs_size_round(len);
438 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
440 cfs_atomic_inc(&ctxt->loc_refcount);
441 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
442 cfs_atomic_read(&ctxt->loc_refcount));
446 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
450 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
451 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
452 cfs_atomic_read(&ctxt->loc_refcount) - 1);
453 __llog_ctxt_put(ctxt);
456 static inline void llog_group_init(struct obd_llog_group *olg, int group)
458 cfs_waitq_init(&olg->olg_waitq);
459 cfs_spin_lock_init(&olg->olg_lock);
460 cfs_mutex_init(&olg->olg_cat_processing);
461 olg->olg_seq = group;
464 static inline void llog_group_set_export(struct obd_llog_group *olg,
465 struct obd_export *exp)
467 LASSERT(exp != NULL);
469 cfs_spin_lock(&olg->olg_lock);
470 if (olg->olg_exp != NULL && olg->olg_exp != exp)
471 CWARN("%s: export for group %d is changed: 0x%p -> 0x%p\n",
472 exp->exp_obd->obd_name, olg->olg_seq,
475 cfs_spin_unlock(&olg->olg_lock);
478 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
479 struct llog_ctxt *ctxt, int index)
481 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
483 cfs_spin_lock(&olg->olg_lock);
484 if (olg->olg_ctxts[index] != NULL) {
485 cfs_spin_unlock(&olg->olg_lock);
488 olg->olg_ctxts[index] = ctxt;
489 cfs_spin_unlock(&olg->olg_lock);
493 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
496 struct llog_ctxt *ctxt;
498 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
500 cfs_spin_lock(&olg->olg_lock);
501 if (olg->olg_ctxts[index] == NULL) {
504 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
506 cfs_spin_unlock(&olg->olg_lock);
510 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
513 return llog_group_get_ctxt(&obd->obd_olg, index);
516 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
518 return (olg->olg_ctxts[index] == NULL);
521 static inline int llog_ctxt_null(struct obd_device *obd, int index)
523 return (llog_group_ctxt_null(&obd->obd_olg, index));
526 static inline int llog_write_rec(struct llog_handle *handle,
527 struct llog_rec_hdr *rec,
528 struct llog_cookie *logcookies,
529 int numcookies, void *buf, int idx)
531 struct llog_operations *lop;
532 int raised, rc, buflen;
535 rc = llog_handle2ops(handle, &lop);
539 if (lop->lop_write_rec == NULL)
542 /* FIXME: Why doesn't caller just set the right lrh_len itself? */
544 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr)
545 + sizeof(struct llog_rec_tail);
547 buflen = rec->lrh_len;
548 LASSERT(cfs_size_round(buflen) == buflen);
550 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
552 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
553 rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
555 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
559 static inline int llog_read_header(struct llog_handle *handle)
561 struct llog_operations *lop;
565 rc = llog_handle2ops(handle, &lop);
568 if (lop->lop_read_header == NULL)
571 rc = lop->lop_read_header(handle);
575 static inline int llog_destroy(struct llog_handle *handle)
577 struct llog_operations *lop;
581 rc = llog_handle2ops(handle, &lop);
584 if (lop->lop_destroy == NULL)
587 rc = lop->lop_destroy(handle);
592 static inline int llog_cancel(struct obd_export *exp,
593 struct lov_stripe_md *lsm, int count,
594 struct llog_cookie *cookies, int flags)
596 struct llog_operations *lop;
600 rc = llog_handle2ops(loghandle, &lop);
603 if (lop->lop_cancel == NULL)
606 rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
611 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
612 int next_idx, __u64 *cur_offset, void *buf,
615 struct llog_operations *lop;
619 rc = llog_handle2ops(loghandle, &lop);
622 if (lop->lop_next_block == NULL)
625 rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
630 static inline int llog_prev_block(struct llog_handle *loghandle,
631 int prev_idx, void *buf, int len)
633 struct llog_operations *lop;
637 rc = llog_handle2ops(loghandle, &lop);
640 if (lop->lop_prev_block == NULL)
643 rc = lop->lop_prev_block(loghandle, prev_idx, buf, len);
647 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
648 struct llog_logid *logid, char *name)
650 struct llog_operations *lop;
654 rc = llog_obd2ops(ctxt, &lop);
657 if (lop->lop_create == NULL)
660 raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
662 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
663 rc = lop->lop_create(ctxt, res, logid, name);
665 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
669 static inline int llog_connect(struct llog_ctxt *ctxt,
670 struct llog_logid *logid, struct llog_gen *gen,
671 struct obd_uuid *uuid)
673 struct llog_operations *lop;
677 rc = llog_obd2ops(ctxt, &lop);
680 if (lop->lop_connect == NULL)
683 rc = lop->lop_connect(ctxt, logid, gen, uuid);
687 int lustre_process_log(struct super_block *sb, char *logname,
688 struct config_llog_instance *cfg);
689 int lustre_end_log(struct super_block *sb, char *logname,
690 struct config_llog_instance *cfg);