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 ostid_to_fid(fid, &id->lgl_oi, 0);
103 lu_igif_build(fid, ostid_id(&id->lgl_oi), id->lgl_ogen);
106 static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
108 if (fid_is_igif(fid)) {
109 /* See above lu_igif_build */
110 ostid_set_id(&id->lgl_oi, fid->f_seq);
111 id->lgl_ogen = fid->f_oid;
113 fid_to_ostid(fid, &id->lgl_oi);
118 static inline void logid_set_id(struct llog_logid *log_id, __u64 id)
120 if (log_id->lgl_ogen == 0)
121 ostid_set_id(&log_id->lgl_oi, id);
123 log_id->lgl_oi.oi.oi_id = id;
126 static inline __u64 logid_id(struct llog_logid *log_id)
128 if (log_id->lgl_ogen == 0)
129 return ostid_id(&log_id->lgl_oi);
131 return log_id->lgl_oi.oi.oi_id;
136 /* llog.c - general API */
137 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
138 int flags, struct obd_uuid *uuid);
139 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
140 struct llog_rec_hdr *rec, void *data);
141 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
142 llog_cb_t cb, void *data, void *catdata);
143 int llog_process_or_fork(const struct lu_env *env,
144 struct llog_handle *loghandle,
145 llog_cb_t cb, void *data, void *catdata, bool fork);
146 int llog_reverse_process(const struct lu_env *env,
147 struct llog_handle *loghandle, llog_cb_t cb,
148 void *data, void *catdata);
149 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
151 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
152 struct llog_handle **lgh, struct llog_logid *logid,
153 char *name, enum llog_open_param open_param);
154 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
155 int llog_get_size(struct llog_handle *loghandle);
157 /* llog_process flags */
158 #define LLOG_FLAG_NODEAMON 0x0001
160 /* llog_cat.c - catalog api */
161 struct llog_process_data {
163 * Any useful data needed while processing catalog. This is
164 * passed later to process callback.
168 * Catalog process callback function, called for each record
173 * Start processing the catalog from startcat/startidx
179 struct llog_process_cat_data {
181 * Temporary stored first_idx while scanning log.
185 * Temporary stored last_idx while scanning log.
190 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
191 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
192 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
193 void *buf, struct thandle *th);
194 int llog_cat_declare_add_rec(const struct lu_env *env,
195 struct llog_handle *cathandle,
196 struct llog_rec_hdr *rec, struct thandle *th);
197 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
198 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
200 int llog_cat_cancel_records(const struct lu_env *env,
201 struct llog_handle *cathandle, int count,
202 struct llog_cookie *cookies);
203 int llog_cat_process_or_fork(const struct lu_env *env,
204 struct llog_handle *cat_llh, llog_cb_t cb,
205 void *data, int startcat, int startidx, bool fork);
206 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
207 llog_cb_t cb, void *data, int startcat, int startidx);
208 int llog_cat_reverse_process(const struct lu_env *env,
209 struct llog_handle *cat_llh, llog_cb_t cb,
211 int llog_cat_init_and_process(const struct lu_env *env,
212 struct llog_handle *llh);
215 int llog_setup(const struct lu_env *env, struct obd_device *obd,
216 struct obd_llog_group *olg, int index,
217 struct obd_device *disk_obd, struct llog_operations *op);
218 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
219 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
220 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
221 int llog_obd_add(const struct lu_env *env, struct llog_ctxt *ctxt,
222 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
223 struct llog_cookie *logcookies, int numcookies);
224 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
225 struct lov_stripe_md *lsm, int count,
226 struct llog_cookie *cookies, int flags);
228 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
229 struct obd_device *disk_obd, int *idx);
231 int obd_llog_finish(struct obd_device *obd, int count);
234 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
235 struct obd_ioctl_data *data);
238 int llog_initiator_connect(struct llog_ctxt *ctxt);
240 struct llog_operations {
241 int (*lop_destroy)(const struct lu_env *env,
242 struct llog_handle *handle);
243 int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
244 int *curr_idx, int next_idx, __u64 *offset,
246 int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
247 int prev_idx, void *buf, int len);
248 int (*lop_read_header)(const struct lu_env *env,
249 struct llog_handle *handle);
250 int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
251 struct obd_llog_group *olg, int ctxt_idx,
252 struct obd_device *disk_obd);
253 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
255 int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
256 int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
257 struct lov_stripe_md *lsm, int count,
258 struct llog_cookie *cookies, int flags);
259 int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
260 struct llog_gen *gen, struct obd_uuid *uuid);
262 * Any llog file must be opened first using llog_open(). Llog can be
263 * opened by name, logid or without both, in last case the new logid
266 int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
267 struct llog_logid *logid, char *name,
268 enum llog_open_param);
270 * Opened llog may not exist and this must be checked where needed using
271 * the llog_exist() call.
273 int (*lop_exist)(struct llog_handle *lgh);
275 * Close llog file and calls llog_free_handle() implicitly.
276 * Any opened llog must be closed by llog_close() call.
278 int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
280 * Create new llog file. The llog must be opened.
281 * Must be used only for local llog operations.
283 int (*lop_declare_create)(const struct lu_env *env,
284 struct llog_handle *handle,
286 int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
289 * write new record in llog. It appends records usually but can edit
290 * existing records too.
292 int (*lop_declare_write_rec)(const struct lu_env *env,
293 struct llog_handle *lgh,
294 struct llog_rec_hdr *rec,
295 int idx, struct thandle *th);
296 int (*lop_write_rec)(const struct lu_env *env,
297 struct llog_handle *loghandle,
298 struct llog_rec_hdr *rec,
299 struct llog_cookie *cookie, int cookiecount,
300 void *buf, int idx, struct thandle *th);
302 * Add new record in llog catalog. Does the same as llog_write_rec()
303 * but using llog catalog.
305 int (*lop_declare_add)(const struct lu_env *env,
306 struct llog_handle *lgh,
307 struct llog_rec_hdr *rec, struct thandle *th);
308 int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
309 struct llog_rec_hdr *rec, struct llog_cookie *cookie,
310 void *buf, struct thandle *th);
311 /* Old llog_add version, used in MDS-LOV-OSC now and will gone with
312 * LOD/OSP replacement */
313 int (*lop_obd_add)(const struct lu_env *env, struct llog_ctxt *ctxt,
314 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
315 struct llog_cookie *logcookies, int numcookies);
318 /* In-memory descriptor for a log object or log catalog */
320 struct rw_semaphore lgh_lock;
321 spinlock_t lgh_hdr_lock; /* protect lgh_hdr data */
322 struct llog_logid lgh_id; /* id of this log */
323 struct llog_log_hdr *lgh_hdr;
324 struct file *lgh_file;
325 struct dt_object *lgh_obj;
327 int lgh_cur_idx; /* used during llog_process */
328 __u64 lgh_cur_offset; /* used during llog_process */
329 struct llog_ctxt *lgh_ctxt;
331 struct plain_handle_data phd;
332 struct cat_handle_data chd;
336 struct llog_operations *lgh_logops;
337 cfs_atomic_t lgh_refcount;
341 extern struct llog_operations llog_lvfs_ops;
344 extern struct llog_operations llog_osd_ops;
345 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
347 struct llog_catid *idarray);
348 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
350 struct llog_catid *idarray);
352 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
353 #define LLOG_CTXT_FLAG_STOP 0x00000002
356 int loc_idx; /* my index the obd array of ctxt's */
357 struct obd_device *loc_obd; /* points back to the containing obd*/
358 struct obd_llog_group *loc_olg; /* group containing that ctxt */
359 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
360 struct obd_import *loc_imp; /* to use in RPC's: can be backward
362 struct llog_operations *loc_logops;
363 struct llog_handle *loc_handle;
364 struct mutex loc_mutex; /* protect loc_imp */
365 cfs_atomic_t loc_refcount;
366 long loc_flags; /* flags, see above defines */
367 struct dt_object *loc_dir;
370 #define LLOG_PROC_BREAK 0x0001
371 #define LLOG_DEL_RECORD 0x0002
373 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
374 struct llog_operations **lop)
379 *lop = ctxt->loc_logops;
386 static inline int llog_handle2ops(struct llog_handle *loghandle,
387 struct llog_operations **lop)
389 if (loghandle == NULL || loghandle->lgh_logops == NULL)
392 *lop = loghandle->lgh_logops;
396 static inline int llog_data_len(int len)
398 return cfs_size_round(len);
401 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
403 cfs_atomic_inc(&ctxt->loc_refcount);
404 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
405 cfs_atomic_read(&ctxt->loc_refcount));
409 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
413 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
414 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
415 cfs_atomic_read(&ctxt->loc_refcount) - 1);
416 __llog_ctxt_put(NULL, ctxt);
419 static inline void llog_group_init(struct obd_llog_group *olg, int group)
421 cfs_waitq_init(&olg->olg_waitq);
422 spin_lock_init(&olg->olg_lock);
423 mutex_init(&olg->olg_cat_processing);
424 olg->olg_seq = group;
427 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
428 struct llog_ctxt *ctxt, int index)
430 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
432 spin_lock(&olg->olg_lock);
433 if (olg->olg_ctxts[index] != NULL) {
434 spin_unlock(&olg->olg_lock);
437 olg->olg_ctxts[index] = ctxt;
438 spin_unlock(&olg->olg_lock);
442 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
445 struct llog_ctxt *ctxt;
447 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
449 spin_lock(&olg->olg_lock);
450 if (olg->olg_ctxts[index] == NULL)
453 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
454 spin_unlock(&olg->olg_lock);
458 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
460 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
461 spin_lock(&olg->olg_lock);
462 olg->olg_ctxts[index] = NULL;
463 spin_unlock(&olg->olg_lock);
466 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
469 return llog_group_get_ctxt(&obd->obd_olg, index);
472 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
474 return (olg->olg_ctxts[index] == NULL);
477 static inline int llog_ctxt_null(struct obd_device *obd, int index)
479 return (llog_group_ctxt_null(&obd->obd_olg, index));
482 static inline int llog_destroy(const struct lu_env *env,
483 struct llog_handle *handle)
485 struct llog_operations *lop;
490 rc = llog_handle2ops(handle, &lop);
493 if (lop->lop_destroy == NULL)
496 rc = lop->lop_destroy(env, handle);
500 static inline int llog_next_block(const struct lu_env *env,
501 struct llog_handle *loghandle, int *cur_idx,
502 int next_idx, __u64 *cur_offset, void *buf,
505 struct llog_operations *lop;
510 rc = llog_handle2ops(loghandle, &lop);
513 if (lop->lop_next_block == NULL)
516 rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
517 cur_offset, buf, len);
521 static inline int llog_prev_block(const struct lu_env *env,
522 struct llog_handle *loghandle,
523 int prev_idx, void *buf, int len)
525 struct llog_operations *lop;
530 rc = llog_handle2ops(loghandle, &lop);
533 if (lop->lop_prev_block == NULL)
536 rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
540 static inline int llog_connect(struct llog_ctxt *ctxt,
541 struct llog_logid *logid, struct llog_gen *gen,
542 struct obd_uuid *uuid)
544 struct llog_operations *lop;
549 rc = llog_obd2ops(ctxt, &lop);
552 if (lop->lop_connect == NULL)
555 rc = lop->lop_connect(ctxt, logid, gen, uuid);
560 int llog_exist(struct llog_handle *loghandle);
561 int llog_declare_create(const struct lu_env *env,
562 struct llog_handle *loghandle, struct thandle *th);
563 int llog_create(const struct lu_env *env, struct llog_handle *handle,
565 int llog_declare_write_rec(const struct lu_env *env,
566 struct llog_handle *handle,
567 struct llog_rec_hdr *rec, int idx,
569 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
570 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
571 int numcookies, void *buf, int idx, struct thandle *th);
572 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
573 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
574 void *buf, struct thandle *th);
575 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
576 struct llog_rec_hdr *rec, struct thandle *th);
577 int lustre_process_log(struct super_block *sb, char *logname,
578 struct config_llog_instance *cfg);
579 int lustre_end_log(struct super_block *sb, char *logname,
580 struct config_llog_instance *cfg);
581 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
582 struct llog_handle **res, struct llog_logid *logid,
584 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
585 struct llog_logid *logid, char *name);
586 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
587 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
588 int cookiecount, void *buf, int idx);