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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
31 * lustre/include/lustre_log.h
33 * Generic infrastructure for managing a collection of logs.
34 * These logs are used for:
36 * - orphan recovery: OST adds record on create
37 * - mtime/size consistency: the OST adds a record on first write
38 * - open/unlinked objects: OST adds a record on destroy
40 * - mds unlink log: the MDS adds an entry upon delete
42 * - raid1 replication log between OST's
43 * - MDS replication logs
54 #include <obd_class.h>
55 #include <dt_object.h>
56 #include <uapi/linux/lustre/lustre_idl.h>
57 #include <uapi/linux/lustre/lustre_log_user.h>
59 #define LOG_NAME_LIMIT(logname, name) \
60 snprintf(logname, sizeof(logname), "LOGS/%s", name)
61 #define LLOG_EEMPTY 4711
63 enum llog_open_param {
64 LLOG_OPEN_EXISTS = 0x0000,
65 LLOG_OPEN_NEW = 0x0001,
68 struct plain_handle_data {
69 struct list_head phd_entry;
70 struct llog_handle *phd_cat_handle;
71 /* cookie of this log in its cat */
72 struct llog_cookie phd_cookie;
75 struct cat_handle_data {
76 struct list_head chd_head;
77 struct llog_handle *chd_current_log;/* currently open log */
78 struct llog_handle *chd_next_log; /* llog to be used next */
83 /* llog.c - general API */
84 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
85 int flags, struct obd_uuid *uuid);
86 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
87 struct llog_rec_hdr *rec, void *data);
88 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
89 llog_cb_t cb, void *data, void *catdata);
90 int llog_process_or_fork(const struct lu_env *env,
91 struct llog_handle *loghandle,
92 llog_cb_t cb, void *data, void *catdata, bool fork);
93 int llog_reverse_process(const struct lu_env *env,
94 struct llog_handle *loghandle, llog_cb_t cb,
95 void *data, void *catdata);
96 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
98 int llog_cancel_arr_rec(const struct lu_env *env, struct llog_handle *loghandle,
100 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
101 struct llog_handle **lgh, struct llog_logid *logid,
102 char *name, enum llog_open_param open_param);
103 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
104 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
106 int llog_backup(const struct lu_env *env, struct obd_device *obd,
107 struct llog_ctxt *ctxt, struct llog_ctxt *bak_ctxt,
108 char *name, char *backup);
109 int llog_read_header(const struct lu_env *env, struct llog_handle *handle,
110 const struct obd_uuid *uuid);
111 __u64 llog_size(const struct lu_env *env, struct llog_handle *llh);
112 int llog_retain(const struct lu_env *env, struct llog_handle *log);
114 /* llog_process flags */
115 #define LLOG_FLAG_NODEAMON 0x0001
117 /* llog read mode, LLOG_READ_MODE_RAW will process llog canceled records */
118 enum llog_read_mode {
119 LLOG_READ_MODE_NORMAL = 0x0000,
120 LLOG_READ_MODE_RAW = 0x0001,
124 /* llog_cat.c - catalog api */
125 struct llog_process_data {
127 * Any useful data needed while processing catalog. This is
128 * passed later to process callback.
132 * Catalog process callback function, called for each record
137 * Start processing the catalog from startcat/startidx
143 struct llog_process_cat_data {
145 * Temporary stored first_idx while scanning log.
149 * Temporary stored last_idx while scanning log.
155 enum llog_read_mode lpcd_read_mode;
158 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
159 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
160 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
162 int llog_cat_declare_add_rec(const struct lu_env *env,
163 struct llog_handle *cathandle,
164 struct llog_rec_hdr *rec, struct thandle *th);
165 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
166 struct llog_rec_hdr *rec, struct llog_cookie *reccookie);
167 int llog_cat_cancel_arr_rec(const struct lu_env *env,
168 struct llog_handle *cathandle,
169 struct llog_logid *lgl, int count, int *index);
170 int llog_cat_cancel_records(const struct lu_env *env,
171 struct llog_handle *cathandle, int count,
172 struct llog_cookie *cookies);
173 int llog_cat_process_or_fork(const struct lu_env *env,
174 struct llog_handle *cat_llh, llog_cb_t cat_cb,
175 llog_cb_t cb, void *data, int startcat,
176 int startidx, bool fork);
177 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
178 llog_cb_t cb, void *data, int startcat, int startidx);
179 __u64 llog_cat_size(const struct lu_env *env, struct llog_handle *cat_llh);
180 __u32 llog_cat_free_space(struct llog_handle *cat_llh);
181 int llog_cat_reverse_process(const struct lu_env *env,
182 struct llog_handle *cat_llh, llog_cb_t cb,
184 int llog_cat_retain_cb(const struct lu_env *env, struct llog_handle *cat,
185 struct llog_rec_hdr *rec, void *data);
187 int llog_setup(const struct lu_env *env, struct obd_device *obd,
188 struct obd_llog_group *olg, int index,
189 struct obd_device *disk_obd, const struct llog_operations *op);
190 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
191 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
192 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
195 struct obd_ioctl_data;
196 int llog_print_cb(const struct lu_env *env, struct llog_handle *handle,
197 struct llog_rec_hdr *rec, void *data);
198 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
199 struct obd_ioctl_data *data);
200 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
201 int count, struct obd_ioctl_data *data,
202 const struct lu_fid *fid);
204 struct llog_print_data {
205 struct obd_ioctl_data *lprd_data;
206 unsigned int lprd_cfg_flags;
211 int llog_initiator_connect(struct llog_ctxt *ctxt);
213 struct llog_operations {
214 int (*lop_declare_destroy)(const struct lu_env *env,
215 struct llog_handle *handle, struct thandle *th);
216 int (*lop_destroy)(const struct lu_env *env,
217 struct llog_handle *handle, struct thandle *th);
218 int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
219 int *curr_idx, int next_idx, __u64 *offset,
221 int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
222 int prev_idx, void *buf, int len);
223 int (*lop_read_header)(const struct lu_env *env,
224 struct llog_handle *handle);
225 int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
226 struct obd_llog_group *olg, int ctxt_idx,
227 struct obd_device *disk_obd);
228 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
230 int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
231 int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
232 struct llog_gen *gen, struct obd_uuid *uuid);
234 * Any llog file must be opened first using llog_open(). Llog can be
235 * opened by name, logid or without both, in last case the new logid
238 int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
239 struct llog_logid *logid, char *name,
240 enum llog_open_param);
242 * Opened llog may not exist and this must be checked where needed using
243 * the llog_exist() call.
245 int (*lop_exist)(struct llog_handle *lgh);
247 * Close llog file and calls llog_free_handle() implicitly.
248 * Any opened llog must be closed by llog_close() call.
250 int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
252 * Create new llog file. The llog must be opened.
253 * Must be used only for local llog operations.
255 int (*lop_declare_create)(const struct lu_env *env,
256 struct llog_handle *handle,
258 int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
261 * write new record in llog. It appends records usually but can edit
262 * existing records too.
264 int (*lop_declare_write_rec)(const struct lu_env *env,
265 struct llog_handle *lgh,
266 struct llog_rec_hdr *rec,
267 int idx, struct thandle *th);
268 int (*lop_write_rec)(const struct lu_env *env,
269 struct llog_handle *loghandle,
270 struct llog_rec_hdr *rec,
271 struct llog_cookie *cookie,
272 int idx, struct thandle *th);
274 * Add new record in llog catalog. Does the same as llog_write_rec()
275 * but using llog catalog.
277 int (*lop_declare_add)(const struct lu_env *env,
278 struct llog_handle *lgh,
279 struct llog_rec_hdr *rec, struct thandle *th);
280 int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
281 struct llog_rec_hdr *rec, struct llog_cookie *cookie,
285 /* In-memory descriptor for a log object or log catalog */
287 struct rw_semaphore lgh_lock;
288 struct mutex lgh_hdr_mutex; /* protect lgh_hdr data */
289 struct llog_logid lgh_id; /* id of this log */
290 struct llog_log_hdr *lgh_hdr; /* may be vmalloc'd */
292 struct dt_object *lgh_obj;
293 /* For a Catalog, is the last/newest used index for a plain slot.
294 * Used in conjunction with llh_cat_idx to handle Catalog wrap-around
295 * case, after it will have reached LLOG_HDR_BITMAP_SIZE, llh_cat_idx
296 * will become its upper limit */
298 struct rw_semaphore lgh_last_sem;
299 __u64 lgh_cur_offset; /* used for test only */
300 struct llog_ctxt *lgh_ctxt;
302 struct plain_handle_data phd;
303 struct cat_handle_data chd;
307 const struct llog_operations *lgh_logops;
308 refcount_t lgh_refcount;
315 extern const struct llog_operations llog_osd_ops;
316 extern const struct llog_operations llog_common_cat_ops;
317 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
318 int idx, int count, struct llog_catid *idarray,
319 const struct lu_fid *fid);
320 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
321 int idx, int count, struct llog_catid *idarray,
322 const struct lu_fid *fid);
324 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
325 #define LLOG_CTXT_FLAG_STOP 0x00000002
327 /* Indicate the llog objects under this context are normal FID objects,
328 * instead of objects with local FID. */
329 #define LLOG_CTXT_FLAG_NORMAL_FID 0x00000004
332 int loc_idx; /* my index the obd array of ctxt's */
333 struct obd_device *loc_obd; /* points back to the containing obd*/
334 struct obd_llog_group *loc_olg; /* group containing that ctxt */
335 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
336 struct obd_import *loc_imp; /* to use in RPC's: can be backward
338 const struct llog_operations *loc_logops;
339 struct llog_handle *loc_handle;
340 struct mutex loc_mutex; /* protect loc_imp */
341 atomic_t loc_refcount;
342 long loc_flags; /* flags, see above defines */
343 struct dt_object *loc_dir;
344 struct local_oid_storage *loc_los_nameless;
345 struct local_oid_storage *loc_los_named;
346 /* llog chunk size, and llog record size can not be bigger than
348 __u32 loc_chunk_size;
351 #define LLOG_PROC_BREAK 0x0001
352 #define LLOG_DEL_RECORD 0x0002
353 #define LLOG_DEL_PLAIN 0x0003
354 #define LLOG_SKIP_PLAIN 0x0004
356 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
357 const struct llog_operations **lop)
362 *lop = ctxt->loc_logops;
369 static inline int llog_handle2ops(struct llog_handle *loghandle,
370 const struct llog_operations **lop)
372 if (loghandle == NULL || loghandle->lgh_logops == NULL)
375 *lop = loghandle->lgh_logops;
379 static inline int llog_data_len(int len)
381 return cfs_size_round(len);
384 static inline int llog_get_size(struct llog_handle *loghandle)
386 if (loghandle && loghandle->lgh_hdr)
387 return loghandle->lgh_hdr->llh_count;
391 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
393 atomic_inc(&ctxt->loc_refcount);
394 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
395 atomic_read(&ctxt->loc_refcount));
399 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
403 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
404 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
405 atomic_read(&ctxt->loc_refcount) - 1);
406 __llog_ctxt_put(NULL, ctxt);
409 static inline void llog_group_init(struct obd_llog_group *olg)
411 init_waitqueue_head(&olg->olg_waitq);
412 spin_lock_init(&olg->olg_lock);
415 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
416 struct llog_ctxt *ctxt, int index)
418 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
420 spin_lock(&olg->olg_lock);
421 if (olg->olg_ctxts[index] != NULL) {
422 spin_unlock(&olg->olg_lock);
425 olg->olg_ctxts[index] = ctxt;
426 spin_unlock(&olg->olg_lock);
430 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
433 struct llog_ctxt *ctxt;
435 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
437 spin_lock(&olg->olg_lock);
438 if (olg->olg_ctxts[index] == NULL)
441 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
442 spin_unlock(&olg->olg_lock);
446 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
448 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
449 spin_lock(&olg->olg_lock);
450 olg->olg_ctxts[index] = NULL;
451 spin_unlock(&olg->olg_lock);
454 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
457 return llog_group_get_ctxt(&obd->obd_olg, index);
460 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
462 return (olg->olg_ctxts[index] == NULL);
465 static inline int llog_ctxt_null(struct obd_device *obd, int index)
467 return (llog_group_ctxt_null(&obd->obd_olg, index));
470 static inline int llog_next_block(const struct lu_env *env,
471 struct llog_handle *loghandle, int *cur_idx,
472 int next_idx, __u64 *cur_offset, void *buf,
475 const struct llog_operations *lop;
480 rc = llog_handle2ops(loghandle, &lop);
483 if (lop->lop_next_block == NULL)
486 rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
487 cur_offset, buf, len);
491 static inline int llog_prev_block(const struct lu_env *env,
492 struct llog_handle *loghandle,
493 int prev_idx, void *buf, int len)
495 const struct llog_operations *lop;
500 rc = llog_handle2ops(loghandle, &lop);
503 if (lop->lop_prev_block == NULL)
506 rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
510 static inline int llog_connect(struct llog_ctxt *ctxt,
511 struct llog_logid *logid, struct llog_gen *gen,
512 struct obd_uuid *uuid)
514 const struct llog_operations *lop;
519 rc = llog_obd2ops(ctxt, &lop);
522 if (lop->lop_connect == NULL)
525 rc = lop->lop_connect(ctxt, logid, gen, uuid);
530 static inline int llog_max_idx(struct llog_log_hdr *lh)
532 if (OBD_FAIL_PRECHECK(OBD_FAIL_CAT_RECORDS) &&
533 unlikely(lh->llh_flags & LLOG_F_IS_CAT))
536 return LLOG_HDR_BITMAP_SIZE(lh) - 1;
539 static inline int llog_is_full(struct llog_handle *llh)
541 return llh->lgh_last_idx >= llog_max_idx(llh->lgh_hdr);
544 /* Determine if a llog plain of a catalog could be skiped based on record
546 * This assumes that indexes follow each other. The number of records to skip
547 * can be computed base on a starting offset and the index of the current
548 * record (in llog catalog callback).
550 static inline int llog_is_plain_skipable(struct llog_log_hdr *lh,
551 struct llog_rec_hdr *rec,
552 __u64 curr, __u64 start)
554 if (start == 0 || curr >= start)
557 return (LLOG_HDR_BITMAP_SIZE(lh) - rec->lrh_index) < (start - curr);
560 static inline bool llog_cat_is_wrapped(struct llog_handle *cat)
562 struct llog_log_hdr *llh = cat->lgh_hdr;
564 return llh->llh_cat_idx >= cat->lgh_last_idx && llh->llh_count > 1;
567 struct llog_cfg_rec {
568 struct llog_rec_hdr lcr_hdr;
569 struct lustre_cfg lcr_cfg;
570 struct llog_rec_tail lcr_tail;
573 struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
574 void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
582 int llog_exist(struct llog_handle *loghandle);
583 int llog_declare_create(const struct lu_env *env,
584 struct llog_handle *loghandle, struct thandle *th);
585 int llog_create(const struct lu_env *env, struct llog_handle *handle,
587 int llog_trans_destroy(const struct lu_env *env, struct llog_handle *handle,
589 int llog_destroy(const struct lu_env *env, struct llog_handle *handle);
591 int llog_declare_write_rec(const struct lu_env *env,
592 struct llog_handle *handle,
593 struct llog_rec_hdr *rec, int idx,
595 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
596 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
597 int idx, struct thandle *th);
598 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
599 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
601 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
602 struct llog_rec_hdr *rec, struct thandle *th);
603 int lustre_process_log(struct super_block *sb, char *logname,
604 struct config_llog_instance *cfg);
605 int lustre_end_log(struct super_block *sb, char *logname,
606 struct config_llog_instance *cfg);
607 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
608 struct llog_handle **res, struct llog_logid *logid,
610 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
611 struct llog_logid *logid, char *name);
612 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
613 struct llog_rec_hdr *rec, int idx);