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, 2013, 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>
62 #error Unsupported operating system.
65 #include <obd_class.h>
66 #include <lustre/lustre_idl.h>
67 #include <dt_object.h>
69 #define LOG_NAME_LIMIT(logname, name) \
70 snprintf(logname, sizeof(logname), "LOGS/%s", name)
71 #define LLOG_EEMPTY 4711
73 enum llog_open_param {
74 LLOG_OPEN_EXISTS = 0x0000,
75 LLOG_OPEN_NEW = 0x0001,
78 struct plain_handle_data {
79 struct list_head phd_entry;
80 struct llog_handle *phd_cat_handle;
81 /* cookie of this log in its cat */
82 struct llog_cookie phd_cookie;
85 struct cat_handle_data {
86 struct list_head chd_head;
87 struct llog_handle *chd_current_log;/* currently open log */
88 struct llog_handle *chd_next_log; /* llog to be used next */
91 static inline void logid_to_fid(struct llog_logid *id, struct lu_fid *fid)
93 /* For compatibility purposes we identify pre-OSD (~< 2.3.51 MDS)
94 * logid's by non-zero ogen (inode generation) and convert them
96 if (id->lgl_ogen == 0) {
97 fid->f_seq = id->lgl_oi.oi.oi_seq;
98 fid->f_oid = id->lgl_oi.oi.oi_id;
101 lu_igif_build(fid, id->lgl_oi.oi.oi_id, id->lgl_ogen);
105 static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
107 id->lgl_oi.oi.oi_seq = fid->f_seq;
108 id->lgl_oi.oi.oi_id = fid->f_oid;
112 static inline void logid_set_id(struct llog_logid *log_id, __u64 id)
114 log_id->lgl_oi.oi.oi_id = id;
117 static inline __u64 logid_id(struct llog_logid *log_id)
119 return log_id->lgl_oi.oi.oi_id;
124 /* llog.c - general API */
125 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
126 int flags, struct obd_uuid *uuid);
127 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
128 struct llog_rec_hdr *rec, void *data);
129 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
130 llog_cb_t cb, void *data, void *catdata);
131 int llog_process_or_fork(const struct lu_env *env,
132 struct llog_handle *loghandle,
133 llog_cb_t cb, void *data, void *catdata, bool fork);
134 int llog_reverse_process(const struct lu_env *env,
135 struct llog_handle *loghandle, llog_cb_t cb,
136 void *data, void *catdata);
137 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
139 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
140 struct llog_handle **lgh, struct llog_logid *logid,
141 char *name, enum llog_open_param open_param);
142 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
143 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
145 int llog_backup(const struct lu_env *env, struct obd_device *obd,
146 struct llog_ctxt *ctxt, struct llog_ctxt *bak_ctxt,
147 char *name, char *backup);
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,
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);
191 int llog_cat_cancel_records(const struct lu_env *env,
192 struct llog_handle *cathandle, int count,
193 struct llog_cookie *cookies);
194 int llog_cat_process_or_fork(const struct lu_env *env,
195 struct llog_handle *cat_llh, llog_cb_t cb,
196 void *data, int startcat, int startidx, bool fork);
197 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
198 llog_cb_t cb, void *data, int startcat, int startidx);
199 int llog_cat_reverse_process(const struct lu_env *env,
200 struct llog_handle *cat_llh, llog_cb_t cb,
202 int llog_cat_init_and_process(const struct lu_env *env,
203 struct llog_handle *llh);
206 int llog_setup(const struct lu_env *env, struct obd_device *obd,
207 struct obd_llog_group *olg, int index,
208 struct obd_device *disk_obd, struct llog_operations *op);
209 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
210 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
211 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
212 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
213 struct llog_cookie *cookies, int flags);
215 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
216 struct obd_device *disk_obd, int *idx);
218 int obd_llog_finish(struct obd_device *obd, int count);
221 struct obd_ioctl_data;
222 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
223 struct obd_ioctl_data *data);
224 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
225 int count, struct obd_ioctl_data *data,
226 const struct lu_fid *fid);
229 int llog_initiator_connect(struct llog_ctxt *ctxt);
231 struct llog_operations {
232 int (*lop_destroy)(const struct lu_env *env,
233 struct llog_handle *handle);
234 int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
235 int *curr_idx, int next_idx, __u64 *offset,
237 int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
238 int prev_idx, void *buf, int len);
239 int (*lop_read_header)(const struct lu_env *env,
240 struct llog_handle *handle);
241 int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
242 struct obd_llog_group *olg, int ctxt_idx,
243 struct obd_device *disk_obd);
244 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
246 int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
247 int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
248 struct llog_cookie *cookies, int flags);
249 int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
250 struct llog_gen *gen, struct obd_uuid *uuid);
252 * Any llog file must be opened first using llog_open(). Llog can be
253 * opened by name, logid or without both, in last case the new logid
256 int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
257 struct llog_logid *logid, char *name,
258 enum llog_open_param);
260 * Opened llog may not exist and this must be checked where needed using
261 * the llog_exist() call.
263 int (*lop_exist)(struct llog_handle *lgh);
265 * Close llog file and calls llog_free_handle() implicitly.
266 * Any opened llog must be closed by llog_close() call.
268 int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
270 * Create new llog file. The llog must be opened.
271 * Must be used only for local llog operations.
273 int (*lop_declare_create)(const struct lu_env *env,
274 struct llog_handle *handle,
276 int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
279 * write new record in llog. It appends records usually but can edit
280 * existing records too.
282 int (*lop_declare_write_rec)(const struct lu_env *env,
283 struct llog_handle *lgh,
284 struct llog_rec_hdr *rec,
285 int idx, struct thandle *th);
286 int (*lop_write_rec)(const struct lu_env *env,
287 struct llog_handle *loghandle,
288 struct llog_rec_hdr *rec,
289 struct llog_cookie *cookie,
290 int idx, struct thandle *th);
292 * Add new record in llog catalog. Does the same as llog_write_rec()
293 * but using llog catalog.
295 int (*lop_declare_add)(const struct lu_env *env,
296 struct llog_handle *lgh,
297 struct llog_rec_hdr *rec, struct thandle *th);
298 int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
299 struct llog_rec_hdr *rec, struct llog_cookie *cookie,
303 /* In-memory descriptor for a log object or log catalog */
305 struct rw_semaphore lgh_lock;
306 spinlock_t lgh_hdr_lock; /* protect lgh_hdr data */
307 struct llog_logid lgh_id; /* id of this log */
308 struct llog_log_hdr *lgh_hdr;
309 struct dt_object *lgh_obj;
311 int lgh_cur_idx; /* used during llog_process */
312 __u64 lgh_cur_offset; /* used during llog_process */
313 struct llog_ctxt *lgh_ctxt;
315 struct plain_handle_data phd;
316 struct cat_handle_data chd;
320 struct llog_operations *lgh_logops;
321 atomic_t lgh_refcount;
325 extern struct llog_operations llog_osd_ops;
326 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
327 int idx, int count, struct llog_catid *idarray,
328 const struct lu_fid *fid);
329 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
330 int idx, int count, struct llog_catid *idarray,
331 const struct lu_fid *fid);
333 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
334 #define LLOG_CTXT_FLAG_STOP 0x00000002
337 int loc_idx; /* my index the obd array of ctxt's */
338 struct obd_device *loc_obd; /* points back to the containing obd*/
339 struct obd_llog_group *loc_olg; /* group containing that ctxt */
340 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
341 struct obd_import *loc_imp; /* to use in RPC's: can be backward
343 struct llog_operations *loc_logops;
344 struct llog_handle *loc_handle;
345 struct mutex loc_mutex; /* protect loc_imp */
346 atomic_t loc_refcount;
347 long loc_flags; /* flags, see above defines */
348 struct dt_object *loc_dir;
349 struct local_oid_storage *loc_los_nameless;
350 struct local_oid_storage *loc_los_named;
353 #define LLOG_PROC_BREAK 0x0001
354 #define LLOG_DEL_RECORD 0x0002
355 #define LLOG_DEL_PLAIN 0x0003
357 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
358 struct llog_operations **lop)
363 *lop = ctxt->loc_logops;
370 static inline int llog_handle2ops(struct llog_handle *loghandle,
371 struct llog_operations **lop)
373 if (loghandle == NULL || loghandle->lgh_logops == NULL)
376 *lop = loghandle->lgh_logops;
380 static inline int llog_data_len(int len)
382 return cfs_size_round(len);
385 static inline int llog_get_size(struct llog_handle *loghandle)
387 if (loghandle && loghandle->lgh_hdr)
388 return loghandle->lgh_hdr->llh_count;
392 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
394 atomic_inc(&ctxt->loc_refcount);
395 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
396 atomic_read(&ctxt->loc_refcount));
400 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
404 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
405 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
406 atomic_read(&ctxt->loc_refcount) - 1);
407 __llog_ctxt_put(NULL, ctxt);
410 static inline void llog_group_init(struct obd_llog_group *olg)
412 init_waitqueue_head(&olg->olg_waitq);
413 spin_lock_init(&olg->olg_lock);
414 mutex_init(&olg->olg_cat_processing);
417 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
418 struct llog_ctxt *ctxt, int index)
420 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
422 spin_lock(&olg->olg_lock);
423 if (olg->olg_ctxts[index] != NULL) {
424 spin_unlock(&olg->olg_lock);
427 olg->olg_ctxts[index] = ctxt;
428 spin_unlock(&olg->olg_lock);
432 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
435 struct llog_ctxt *ctxt;
437 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
439 spin_lock(&olg->olg_lock);
440 if (olg->olg_ctxts[index] == NULL)
443 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
444 spin_unlock(&olg->olg_lock);
448 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
450 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
451 spin_lock(&olg->olg_lock);
452 olg->olg_ctxts[index] = NULL;
453 spin_unlock(&olg->olg_lock);
456 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
459 return llog_group_get_ctxt(&obd->obd_olg, index);
462 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
464 return (olg->olg_ctxts[index] == NULL);
467 static inline int llog_ctxt_null(struct obd_device *obd, int index)
469 return (llog_group_ctxt_null(&obd->obd_olg, index));
472 static inline int llog_destroy(const struct lu_env *env,
473 struct llog_handle *handle)
475 struct llog_operations *lop;
480 rc = llog_handle2ops(handle, &lop);
483 if (lop->lop_destroy == NULL)
486 rc = lop->lop_destroy(env, handle);
490 static inline int llog_next_block(const struct lu_env *env,
491 struct llog_handle *loghandle, int *cur_idx,
492 int next_idx, __u64 *cur_offset, void *buf,
495 struct llog_operations *lop;
500 rc = llog_handle2ops(loghandle, &lop);
503 if (lop->lop_next_block == NULL)
506 rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
507 cur_offset, buf, len);
511 static inline int llog_prev_block(const struct lu_env *env,
512 struct llog_handle *loghandle,
513 int prev_idx, void *buf, int len)
515 struct llog_operations *lop;
520 rc = llog_handle2ops(loghandle, &lop);
523 if (lop->lop_prev_block == NULL)
526 rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
530 static inline int llog_connect(struct llog_ctxt *ctxt,
531 struct llog_logid *logid, struct llog_gen *gen,
532 struct obd_uuid *uuid)
534 struct llog_operations *lop;
539 rc = llog_obd2ops(ctxt, &lop);
542 if (lop->lop_connect == NULL)
545 rc = lop->lop_connect(ctxt, logid, gen, uuid);
549 struct llog_cfg_rec {
550 struct llog_rec_hdr lcr_hdr;
551 struct lustre_cfg lcr_cfg;
552 struct llog_rec_tail lcr_tail;
555 struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
556 void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
564 int llog_exist(struct llog_handle *loghandle);
565 int llog_declare_create(const struct lu_env *env,
566 struct llog_handle *loghandle, struct thandle *th);
567 int llog_create(const struct lu_env *env, struct llog_handle *handle,
569 int llog_declare_write_rec(const struct lu_env *env,
570 struct llog_handle *handle,
571 struct llog_rec_hdr *rec, int idx,
573 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
574 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
575 int idx, struct thandle *th);
576 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
577 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
579 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
580 struct llog_rec_hdr *rec, struct thandle *th);
581 int lustre_process_log(struct super_block *sb, char *logname,
582 struct config_llog_instance *cfg);
583 int lustre_end_log(struct super_block *sb, char *logname,
584 struct config_llog_instance *cfg);
585 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
586 struct llog_handle **res, struct llog_logid *logid,
588 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
589 struct llog_logid *logid, char *name);
590 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
591 struct llog_rec_hdr *rec, int idx);