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_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_get_size(struct llog_handle *loghandle);
149 /* llog_process flags */
150 #define LLOG_FLAG_NODEAMON 0x0001
152 /* llog_cat.c - catalog api */
153 struct llog_process_data {
155 * Any useful data needed while processing catalog. This is
156 * passed later to process callback.
160 * Catalog process callback function, called for each record
165 * Start processing the catalog from startcat/startidx
171 struct llog_process_cat_data {
173 * Temporary stored first_idx while scanning log.
177 * Temporary stored last_idx while scanning log.
182 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
183 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
184 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
185 void *buf, struct thandle *th);
186 int llog_cat_declare_add_rec(const struct lu_env *env,
187 struct llog_handle *cathandle,
188 struct llog_rec_hdr *rec, struct thandle *th);
189 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
190 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
192 int llog_cat_cancel_records(const struct lu_env *env,
193 struct llog_handle *cathandle, int count,
194 struct llog_cookie *cookies);
195 int llog_cat_process_or_fork(const struct lu_env *env,
196 struct llog_handle *cat_llh, llog_cb_t cb,
197 void *data, int startcat, int startidx, bool fork);
198 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
199 llog_cb_t cb, void *data, int startcat, int startidx);
200 int llog_cat_reverse_process(const struct lu_env *env,
201 struct llog_handle *cat_llh, llog_cb_t cb,
203 int llog_cat_init_and_process(const struct lu_env *env,
204 struct llog_handle *llh);
207 int llog_setup(const struct lu_env *env, struct obd_device *obd,
208 struct obd_llog_group *olg, int index,
209 struct obd_device *disk_obd, struct llog_operations *op);
210 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
211 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
212 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
213 int llog_obd_add(const struct lu_env *env, struct llog_ctxt *ctxt,
214 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
215 struct llog_cookie *logcookies, int numcookies);
216 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
217 struct lov_stripe_md *lsm, int count,
218 struct llog_cookie *cookies, int flags);
220 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
221 struct obd_device *disk_obd, int *idx);
223 int obd_llog_finish(struct obd_device *obd, int count);
226 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
227 struct obd_ioctl_data *data);
230 int llog_initiator_connect(struct llog_ctxt *ctxt);
232 struct llog_operations {
233 int (*lop_destroy)(const struct lu_env *env,
234 struct llog_handle *handle);
235 int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
236 int *curr_idx, int next_idx, __u64 *offset,
238 int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
239 int prev_idx, void *buf, int len);
240 int (*lop_read_header)(const struct lu_env *env,
241 struct llog_handle *handle);
242 int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
243 struct obd_llog_group *olg, int ctxt_idx,
244 struct obd_device *disk_obd);
245 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
247 int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
248 int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
249 struct lov_stripe_md *lsm, int count,
250 struct llog_cookie *cookies, int flags);
251 int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
252 struct llog_gen *gen, struct obd_uuid *uuid);
254 * Any llog file must be opened first using llog_open(). Llog can be
255 * opened by name, logid or without both, in last case the new logid
258 int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
259 struct llog_logid *logid, char *name,
260 enum llog_open_param);
262 * Opened llog may not exist and this must be checked where needed using
263 * the llog_exist() call.
265 int (*lop_exist)(struct llog_handle *lgh);
267 * Close llog file and calls llog_free_handle() implicitly.
268 * Any opened llog must be closed by llog_close() call.
270 int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
272 * Create new llog file. The llog must be opened.
273 * Must be used only for local llog operations.
275 int (*lop_declare_create)(const struct lu_env *env,
276 struct llog_handle *handle,
278 int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
281 * write new record in llog. It appends records usually but can edit
282 * existing records too.
284 int (*lop_declare_write_rec)(const struct lu_env *env,
285 struct llog_handle *lgh,
286 struct llog_rec_hdr *rec,
287 int idx, struct thandle *th);
288 int (*lop_write_rec)(const struct lu_env *env,
289 struct llog_handle *loghandle,
290 struct llog_rec_hdr *rec,
291 struct llog_cookie *cookie, int cookiecount,
292 void *buf, int idx, struct thandle *th);
294 * Add new record in llog catalog. Does the same as llog_write_rec()
295 * but using llog catalog.
297 int (*lop_declare_add)(const struct lu_env *env,
298 struct llog_handle *lgh,
299 struct llog_rec_hdr *rec, struct thandle *th);
300 int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
301 struct llog_rec_hdr *rec, struct llog_cookie *cookie,
302 void *buf, struct thandle *th);
303 /* Old llog_add version, used in MDS-LOV-OSC now and will gone with
304 * LOD/OSP replacement */
305 int (*lop_obd_add)(const struct lu_env *env, struct llog_ctxt *ctxt,
306 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
307 struct llog_cookie *logcookies, int numcookies);
310 /* In-memory descriptor for a log object or log catalog */
312 struct rw_semaphore lgh_lock;
313 spinlock_t lgh_hdr_lock; /* protect lgh_hdr data */
314 struct llog_logid lgh_id; /* id of this log */
315 struct llog_log_hdr *lgh_hdr;
316 struct file *lgh_file;
317 struct dt_object *lgh_obj;
319 int lgh_cur_idx; /* used during llog_process */
320 __u64 lgh_cur_offset; /* used during llog_process */
321 struct llog_ctxt *lgh_ctxt;
323 struct plain_handle_data phd;
324 struct cat_handle_data chd;
328 struct llog_operations *lgh_logops;
329 cfs_atomic_t lgh_refcount;
333 extern struct llog_operations llog_lvfs_ops;
336 extern struct llog_operations llog_osd_ops;
337 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
339 struct llog_catid *idarray);
340 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
342 struct llog_catid *idarray);
344 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
345 #define LLOG_CTXT_FLAG_STOP 0x00000002
348 int loc_idx; /* my index the obd array of ctxt's */
349 struct obd_device *loc_obd; /* points back to the containing obd*/
350 struct obd_llog_group *loc_olg; /* group containing that ctxt */
351 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
352 struct obd_import *loc_imp; /* to use in RPC's: can be backward
354 struct llog_operations *loc_logops;
355 struct llog_handle *loc_handle;
356 struct mutex loc_mutex; /* protect loc_imp */
357 cfs_atomic_t loc_refcount;
358 long loc_flags; /* flags, see above defines */
359 struct dt_object *loc_dir;
362 #define LLOG_PROC_BREAK 0x0001
363 #define LLOG_DEL_RECORD 0x0002
365 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
366 struct llog_operations **lop)
371 *lop = ctxt->loc_logops;
378 static inline int llog_handle2ops(struct llog_handle *loghandle,
379 struct llog_operations **lop)
381 if (loghandle == NULL || loghandle->lgh_logops == NULL)
384 *lop = loghandle->lgh_logops;
388 static inline int llog_data_len(int len)
390 return cfs_size_round(len);
393 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
395 cfs_atomic_inc(&ctxt->loc_refcount);
396 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
397 cfs_atomic_read(&ctxt->loc_refcount));
401 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
405 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
406 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
407 cfs_atomic_read(&ctxt->loc_refcount) - 1);
408 __llog_ctxt_put(NULL, ctxt);
411 static inline void llog_group_init(struct obd_llog_group *olg, int group)
413 cfs_waitq_init(&olg->olg_waitq);
414 spin_lock_init(&olg->olg_lock);
415 mutex_init(&olg->olg_cat_processing);
416 olg->olg_seq = group;
419 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
420 struct llog_ctxt *ctxt, int index)
422 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
424 spin_lock(&olg->olg_lock);
425 if (olg->olg_ctxts[index] != NULL) {
426 spin_unlock(&olg->olg_lock);
429 olg->olg_ctxts[index] = ctxt;
430 spin_unlock(&olg->olg_lock);
434 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
437 struct llog_ctxt *ctxt;
439 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
441 spin_lock(&olg->olg_lock);
442 if (olg->olg_ctxts[index] == NULL)
445 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
446 spin_unlock(&olg->olg_lock);
450 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
452 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
453 spin_lock(&olg->olg_lock);
454 olg->olg_ctxts[index] = NULL;
455 spin_unlock(&olg->olg_lock);
458 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
461 return llog_group_get_ctxt(&obd->obd_olg, index);
464 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
466 return (olg->olg_ctxts[index] == NULL);
469 static inline int llog_ctxt_null(struct obd_device *obd, int index)
471 return (llog_group_ctxt_null(&obd->obd_olg, index));
474 static inline int llog_destroy(const struct lu_env *env,
475 struct llog_handle *handle)
477 struct llog_operations *lop;
482 rc = llog_handle2ops(handle, &lop);
485 if (lop->lop_destroy == NULL)
488 rc = lop->lop_destroy(env, handle);
492 static inline int llog_next_block(const struct lu_env *env,
493 struct llog_handle *loghandle, int *cur_idx,
494 int next_idx, __u64 *cur_offset, void *buf,
497 struct llog_operations *lop;
502 rc = llog_handle2ops(loghandle, &lop);
505 if (lop->lop_next_block == NULL)
508 rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
509 cur_offset, buf, len);
513 static inline int llog_prev_block(const struct lu_env *env,
514 struct llog_handle *loghandle,
515 int prev_idx, void *buf, int len)
517 struct llog_operations *lop;
522 rc = llog_handle2ops(loghandle, &lop);
525 if (lop->lop_prev_block == NULL)
528 rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
532 static inline int llog_connect(struct llog_ctxt *ctxt,
533 struct llog_logid *logid, struct llog_gen *gen,
534 struct obd_uuid *uuid)
536 struct llog_operations *lop;
541 rc = llog_obd2ops(ctxt, &lop);
544 if (lop->lop_connect == NULL)
547 rc = lop->lop_connect(ctxt, logid, gen, uuid);
552 int llog_exist(struct llog_handle *loghandle);
553 int llog_declare_create(const struct lu_env *env,
554 struct llog_handle *loghandle, struct thandle *th);
555 int llog_create(const struct lu_env *env, struct llog_handle *handle,
557 int llog_declare_write_rec(const struct lu_env *env,
558 struct llog_handle *handle,
559 struct llog_rec_hdr *rec, int idx,
561 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
562 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
563 int numcookies, void *buf, int idx, struct thandle *th);
564 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
565 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
566 void *buf, struct thandle *th);
567 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
568 struct llog_rec_hdr *rec, struct thandle *th);
569 int lustre_process_log(struct super_block *sb, char *logname,
570 struct config_llog_instance *cfg);
571 int lustre_end_log(struct super_block *sb, char *logname,
572 struct config_llog_instance *cfg);
573 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
574 struct llog_handle **res, struct llog_logid *logid,
576 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
577 struct llog_logid *logid, char *name);
578 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
579 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
580 int cookiecount, void *buf, int idx);