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>
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>
70 #include <lustre/lustre_idl.h>
71 #include <dt_object.h>
73 #define LOG_NAME_LIMIT(logname, name) \
74 snprintf(logname, sizeof(logname), "LOGS/%s", name)
75 #define LLOG_EEMPTY 4711
77 enum llog_open_param {
78 LLOG_OPEN_EXISTS = 0x0000,
79 LLOG_OPEN_NEW = 0x0001,
82 struct plain_handle_data {
83 struct list_head phd_entry;
84 struct llog_handle *phd_cat_handle;
85 /* cookie of this log in its cat */
86 struct llog_cookie phd_cookie;
89 struct cat_handle_data {
90 struct list_head chd_head;
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_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
149 int llog_backup(const struct lu_env *env, struct obd_device *obd,
150 struct llog_ctxt *ctxt, struct llog_ctxt *bak_ctxt,
151 char *name, char *backup);
153 /* llog_process flags */
154 #define LLOG_FLAG_NODEAMON 0x0001
156 /* llog_cat.c - catalog api */
157 struct llog_process_data {
159 * Any useful data needed while processing catalog. This is
160 * passed later to process callback.
164 * Catalog process callback function, called for each record
169 * Start processing the catalog from startcat/startidx
175 struct llog_process_cat_data {
177 * Temporary stored first_idx while scanning log.
181 * Temporary stored last_idx while scanning log.
186 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
187 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
188 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
190 int llog_cat_declare_add_rec(const struct lu_env *env,
191 struct llog_handle *cathandle,
192 struct llog_rec_hdr *rec, struct thandle *th);
193 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
194 struct llog_rec_hdr *rec, struct llog_cookie *reccookie);
195 int llog_cat_cancel_records(const struct lu_env *env,
196 struct llog_handle *cathandle, int count,
197 struct llog_cookie *cookies);
198 int llog_cat_process_or_fork(const struct lu_env *env,
199 struct llog_handle *cat_llh, llog_cb_t cb,
200 void *data, int startcat, int startidx, bool fork);
201 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
202 llog_cb_t cb, void *data, int startcat, int startidx);
203 int llog_cat_reverse_process(const struct lu_env *env,
204 struct llog_handle *cat_llh, llog_cb_t cb,
206 int llog_cat_init_and_process(const struct lu_env *env,
207 struct llog_handle *llh);
210 int llog_setup(const struct lu_env *env, struct obd_device *obd,
211 struct obd_llog_group *olg, int index,
212 struct obd_device *disk_obd, struct llog_operations *op);
213 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
214 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
215 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
216 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
217 struct llog_cookie *cookies, int flags);
219 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
220 struct obd_device *disk_obd, int *idx);
222 int obd_llog_finish(struct obd_device *obd, int count);
225 struct obd_ioctl_data;
226 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
227 struct obd_ioctl_data *data);
228 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
229 int count, struct obd_ioctl_data *data,
230 const struct lu_fid *fid);
233 int llog_initiator_connect(struct llog_ctxt *ctxt);
235 struct llog_operations {
236 int (*lop_destroy)(const struct lu_env *env,
237 struct llog_handle *handle);
238 int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
239 int *curr_idx, int next_idx, __u64 *offset,
241 int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
242 int prev_idx, void *buf, int len);
243 int (*lop_read_header)(const struct lu_env *env,
244 struct llog_handle *handle);
245 int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
246 struct obd_llog_group *olg, int ctxt_idx,
247 struct obd_device *disk_obd);
248 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
250 int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
251 int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
252 struct llog_cookie *cookies, int flags);
253 int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
254 struct llog_gen *gen, struct obd_uuid *uuid);
256 * Any llog file must be opened first using llog_open(). Llog can be
257 * opened by name, logid or without both, in last case the new logid
260 int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
261 struct llog_logid *logid, char *name,
262 enum llog_open_param);
264 * Opened llog may not exist and this must be checked where needed using
265 * the llog_exist() call.
267 int (*lop_exist)(struct llog_handle *lgh);
269 * Close llog file and calls llog_free_handle() implicitly.
270 * Any opened llog must be closed by llog_close() call.
272 int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
274 * Create new llog file. The llog must be opened.
275 * Must be used only for local llog operations.
277 int (*lop_declare_create)(const struct lu_env *env,
278 struct llog_handle *handle,
280 int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
283 * write new record in llog. It appends records usually but can edit
284 * existing records too.
286 int (*lop_declare_write_rec)(const struct lu_env *env,
287 struct llog_handle *lgh,
288 struct llog_rec_hdr *rec,
289 int idx, struct thandle *th);
290 int (*lop_write_rec)(const struct lu_env *env,
291 struct llog_handle *loghandle,
292 struct llog_rec_hdr *rec,
293 struct llog_cookie *cookie,
294 int idx, struct thandle *th);
296 * Add new record in llog catalog. Does the same as llog_write_rec()
297 * but using llog catalog.
299 int (*lop_declare_add)(const struct lu_env *env,
300 struct llog_handle *lgh,
301 struct llog_rec_hdr *rec, struct thandle *th);
302 int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
303 struct llog_rec_hdr *rec, struct llog_cookie *cookie,
307 /* In-memory descriptor for a log object or log catalog */
309 struct rw_semaphore lgh_lock;
310 spinlock_t lgh_hdr_lock; /* protect lgh_hdr data */
311 struct llog_logid lgh_id; /* id of this log */
312 struct llog_log_hdr *lgh_hdr;
313 struct dt_object *lgh_obj;
315 int lgh_cur_idx; /* used during llog_process */
316 __u64 lgh_cur_offset; /* used during llog_process */
317 struct llog_ctxt *lgh_ctxt;
319 struct plain_handle_data phd;
320 struct cat_handle_data chd;
324 struct llog_operations *lgh_logops;
325 atomic_t lgh_refcount;
329 extern struct llog_operations llog_osd_ops;
330 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
331 int idx, int count, struct llog_catid *idarray,
332 const struct lu_fid *fid);
333 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
334 int idx, int count, struct llog_catid *idarray,
335 const struct lu_fid *fid);
337 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
338 #define LLOG_CTXT_FLAG_STOP 0x00000002
341 int loc_idx; /* my index the obd array of ctxt's */
342 struct obd_device *loc_obd; /* points back to the containing obd*/
343 struct obd_llog_group *loc_olg; /* group containing that ctxt */
344 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
345 struct obd_import *loc_imp; /* to use in RPC's: can be backward
347 struct llog_operations *loc_logops;
348 struct llog_handle *loc_handle;
349 struct mutex loc_mutex; /* protect loc_imp */
350 atomic_t loc_refcount;
351 long loc_flags; /* flags, see above defines */
352 struct dt_object *loc_dir;
353 struct local_oid_storage *loc_los_nameless;
354 struct local_oid_storage *loc_los_named;
357 #define LLOG_PROC_BREAK 0x0001
358 #define LLOG_DEL_RECORD 0x0002
359 #define LLOG_DEL_PLAIN 0x0003
361 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
362 struct llog_operations **lop)
367 *lop = ctxt->loc_logops;
374 static inline int llog_handle2ops(struct llog_handle *loghandle,
375 struct llog_operations **lop)
377 if (loghandle == NULL || loghandle->lgh_logops == NULL)
380 *lop = loghandle->lgh_logops;
384 static inline int llog_data_len(int len)
386 return cfs_size_round(len);
389 static inline int llog_get_size(struct llog_handle *loghandle)
391 if (loghandle && loghandle->lgh_hdr)
392 return loghandle->lgh_hdr->llh_count;
396 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
398 atomic_inc(&ctxt->loc_refcount);
399 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
400 atomic_read(&ctxt->loc_refcount));
404 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
408 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
409 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
410 atomic_read(&ctxt->loc_refcount) - 1);
411 __llog_ctxt_put(NULL, ctxt);
414 static inline void llog_group_init(struct obd_llog_group *olg)
416 init_waitqueue_head(&olg->olg_waitq);
417 spin_lock_init(&olg->olg_lock);
418 mutex_init(&olg->olg_cat_processing);
421 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
422 struct llog_ctxt *ctxt, int index)
424 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
426 spin_lock(&olg->olg_lock);
427 if (olg->olg_ctxts[index] != NULL) {
428 spin_unlock(&olg->olg_lock);
431 olg->olg_ctxts[index] = ctxt;
432 spin_unlock(&olg->olg_lock);
436 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
439 struct llog_ctxt *ctxt;
441 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
443 spin_lock(&olg->olg_lock);
444 if (olg->olg_ctxts[index] == NULL)
447 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
448 spin_unlock(&olg->olg_lock);
452 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
454 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
455 spin_lock(&olg->olg_lock);
456 olg->olg_ctxts[index] = NULL;
457 spin_unlock(&olg->olg_lock);
460 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
463 return llog_group_get_ctxt(&obd->obd_olg, index);
466 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
468 return (olg->olg_ctxts[index] == NULL);
471 static inline int llog_ctxt_null(struct obd_device *obd, int index)
473 return (llog_group_ctxt_null(&obd->obd_olg, index));
476 static inline int llog_destroy(const struct lu_env *env,
477 struct llog_handle *handle)
479 struct llog_operations *lop;
484 rc = llog_handle2ops(handle, &lop);
487 if (lop->lop_destroy == NULL)
490 rc = lop->lop_destroy(env, handle);
494 static inline int llog_next_block(const struct lu_env *env,
495 struct llog_handle *loghandle, int *cur_idx,
496 int next_idx, __u64 *cur_offset, void *buf,
499 struct llog_operations *lop;
504 rc = llog_handle2ops(loghandle, &lop);
507 if (lop->lop_next_block == NULL)
510 rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
511 cur_offset, buf, len);
515 static inline int llog_prev_block(const struct lu_env *env,
516 struct llog_handle *loghandle,
517 int prev_idx, void *buf, int len)
519 struct llog_operations *lop;
524 rc = llog_handle2ops(loghandle, &lop);
527 if (lop->lop_prev_block == NULL)
530 rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
534 static inline int llog_connect(struct llog_ctxt *ctxt,
535 struct llog_logid *logid, struct llog_gen *gen,
536 struct obd_uuid *uuid)
538 struct llog_operations *lop;
543 rc = llog_obd2ops(ctxt, &lop);
546 if (lop->lop_connect == NULL)
549 rc = lop->lop_connect(ctxt, logid, gen, uuid);
553 struct llog_cfg_rec {
554 struct llog_rec_hdr lcr_hdr;
555 struct lustre_cfg lcr_cfg;
556 struct llog_rec_tail lcr_tail;
559 struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
560 void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
568 int llog_exist(struct llog_handle *loghandle);
569 int llog_declare_create(const struct lu_env *env,
570 struct llog_handle *loghandle, struct thandle *th);
571 int llog_create(const struct lu_env *env, struct llog_handle *handle,
573 int llog_declare_write_rec(const struct lu_env *env,
574 struct llog_handle *handle,
575 struct llog_rec_hdr *rec, int idx,
577 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
578 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
579 int idx, struct thandle *th);
580 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
581 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
583 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
584 struct llog_rec_hdr *rec, struct thandle *th);
585 int lustre_process_log(struct super_block *sb, char *logname,
586 struct config_llog_instance *cfg);
587 int lustre_end_log(struct super_block *sb, char *logname,
588 struct config_llog_instance *cfg);
589 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
590 struct llog_handle **res, struct llog_logid *logid,
592 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
593 struct llog_logid *logid, char *name);
594 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
595 struct llog_rec_hdr *rec, int idx);