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, 2014, 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 #include <obd_class.h>
60 #include <lustre/lustre_idl.h>
61 #include <dt_object.h>
63 #define LOG_NAME_LIMIT(logname, name) \
64 snprintf(logname, sizeof(logname), "LOGS/%s", name)
65 #define LLOG_EEMPTY 4711
67 enum llog_open_param {
68 LLOG_OPEN_EXISTS = 0x0000,
69 LLOG_OPEN_NEW = 0x0001,
72 struct plain_handle_data {
73 struct list_head phd_entry;
74 struct llog_handle *phd_cat_handle;
75 /* cookie of this log in its cat */
76 struct llog_cookie phd_cookie;
79 struct cat_handle_data {
80 struct list_head chd_head;
81 struct llog_handle *chd_current_log;/* currently open log */
82 struct llog_handle *chd_next_log; /* llog to be used next */
85 static inline void logid_to_fid(struct llog_logid *id, struct lu_fid *fid)
87 /* For compatibility purposes we identify pre-OSD (~< 2.3.51 MDS)
88 * logid's by non-zero ogen (inode generation) and convert them
90 if (id->lgl_ogen == 0) {
91 fid->f_seq = id->lgl_oi.oi.oi_seq;
92 fid->f_oid = id->lgl_oi.oi.oi_id;
95 lu_igif_build(fid, id->lgl_oi.oi.oi_id, id->lgl_ogen);
99 static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
101 id->lgl_oi.oi.oi_seq = fid->f_seq;
102 id->lgl_oi.oi.oi_id = fid->f_oid;
106 static inline void logid_set_id(struct llog_logid *log_id, __u64 id)
108 log_id->lgl_oi.oi.oi_id = id;
111 static inline __u64 logid_id(struct llog_logid *log_id)
113 return log_id->lgl_oi.oi.oi_id;
118 /* llog.c - general API */
119 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
120 int flags, struct obd_uuid *uuid);
121 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
122 struct llog_rec_hdr *rec, void *data);
123 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
124 llog_cb_t cb, void *data, void *catdata);
125 int llog_process_or_fork(const struct lu_env *env,
126 struct llog_handle *loghandle,
127 llog_cb_t cb, void *data, void *catdata, bool fork);
128 int llog_reverse_process(const struct lu_env *env,
129 struct llog_handle *loghandle, llog_cb_t cb,
130 void *data, void *catdata);
131 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
133 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
134 struct llog_handle **lgh, struct llog_logid *logid,
135 char *name, enum llog_open_param open_param);
136 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
137 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
139 int llog_backup(const struct lu_env *env, struct obd_device *obd,
140 struct llog_ctxt *ctxt, struct llog_ctxt *bak_ctxt,
141 char *name, char *backup);
143 /* llog_process flags */
144 #define LLOG_FLAG_NODEAMON 0x0001
146 /* llog_cat.c - catalog api */
147 struct llog_process_data {
149 * Any useful data needed while processing catalog. This is
150 * passed later to process callback.
154 * Catalog process callback function, called for each record
159 * Start processing the catalog from startcat/startidx
165 struct llog_process_cat_data {
167 * Temporary stored first_idx while scanning log.
171 * Temporary stored last_idx while scanning log.
176 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
177 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
178 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
180 int llog_cat_declare_add_rec(const struct lu_env *env,
181 struct llog_handle *cathandle,
182 struct llog_rec_hdr *rec, struct thandle *th);
183 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
184 struct llog_rec_hdr *rec, struct llog_cookie *reccookie);
185 int llog_cat_cancel_records(const struct lu_env *env,
186 struct llog_handle *cathandle, int count,
187 struct llog_cookie *cookies);
188 int llog_cat_process_or_fork(const struct lu_env *env,
189 struct llog_handle *cat_llh, llog_cb_t cb,
190 void *data, int startcat, int startidx, bool fork);
191 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
192 llog_cb_t cb, void *data, int startcat, int startidx);
193 int llog_cat_reverse_process(const struct lu_env *env,
194 struct llog_handle *cat_llh, llog_cb_t cb,
196 int llog_cat_init_and_process(const struct lu_env *env,
197 struct llog_handle *llh);
200 int llog_setup(const struct lu_env *env, struct obd_device *obd,
201 struct obd_llog_group *olg, int index,
202 struct obd_device *disk_obd, struct llog_operations *op);
203 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
204 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
205 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
206 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
207 struct llog_cookie *cookies, int flags);
210 struct obd_ioctl_data;
211 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
212 struct obd_ioctl_data *data);
213 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
214 int count, struct obd_ioctl_data *data,
215 const struct lu_fid *fid);
218 int llog_initiator_connect(struct llog_ctxt *ctxt);
220 struct llog_operations {
221 int (*lop_destroy)(const struct lu_env *env,
222 struct llog_handle *handle);
223 int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
224 int *curr_idx, int next_idx, __u64 *offset,
226 int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
227 int prev_idx, void *buf, int len);
228 int (*lop_read_header)(const struct lu_env *env,
229 struct llog_handle *handle);
230 int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
231 struct obd_llog_group *olg, int ctxt_idx,
232 struct obd_device *disk_obd);
233 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
235 int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
236 int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
237 struct llog_cookie *cookies, int flags);
238 int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
239 struct llog_gen *gen, struct obd_uuid *uuid);
241 * Any llog file must be opened first using llog_open(). Llog can be
242 * opened by name, logid or without both, in last case the new logid
245 int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
246 struct llog_logid *logid, char *name,
247 enum llog_open_param);
249 * Opened llog may not exist and this must be checked where needed using
250 * the llog_exist() call.
252 int (*lop_exist)(struct llog_handle *lgh);
254 * Close llog file and calls llog_free_handle() implicitly.
255 * Any opened llog must be closed by llog_close() call.
257 int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
259 * Create new llog file. The llog must be opened.
260 * Must be used only for local llog operations.
262 int (*lop_declare_create)(const struct lu_env *env,
263 struct llog_handle *handle,
265 int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
268 * write new record in llog. It appends records usually but can edit
269 * existing records too.
271 int (*lop_declare_write_rec)(const struct lu_env *env,
272 struct llog_handle *lgh,
273 struct llog_rec_hdr *rec,
274 int idx, struct thandle *th);
275 int (*lop_write_rec)(const struct lu_env *env,
276 struct llog_handle *loghandle,
277 struct llog_rec_hdr *rec,
278 struct llog_cookie *cookie,
279 int idx, struct thandle *th);
281 * Add new record in llog catalog. Does the same as llog_write_rec()
282 * but using llog catalog.
284 int (*lop_declare_add)(const struct lu_env *env,
285 struct llog_handle *lgh,
286 struct llog_rec_hdr *rec, struct thandle *th);
287 int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
288 struct llog_rec_hdr *rec, struct llog_cookie *cookie,
292 /* In-memory descriptor for a log object or log catalog */
294 struct rw_semaphore lgh_lock;
295 spinlock_t lgh_hdr_lock; /* protect lgh_hdr data */
296 struct llog_logid lgh_id; /* id of this log */
297 struct llog_log_hdr *lgh_hdr;
298 struct dt_object *lgh_obj;
300 int lgh_cur_idx; /* used during llog_process */
301 __u64 lgh_cur_offset; /* used during llog_process */
302 struct llog_ctxt *lgh_ctxt;
304 struct plain_handle_data phd;
305 struct cat_handle_data chd;
309 struct llog_operations *lgh_logops;
310 atomic_t lgh_refcount;
314 extern struct llog_operations llog_osd_ops;
315 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
316 int idx, int count, struct llog_catid *idarray,
317 const struct lu_fid *fid);
318 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
319 int idx, int count, struct llog_catid *idarray,
320 const struct lu_fid *fid);
322 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
323 #define LLOG_CTXT_FLAG_STOP 0x00000002
326 int loc_idx; /* my index the obd array of ctxt's */
327 struct obd_device *loc_obd; /* points back to the containing obd*/
328 struct obd_llog_group *loc_olg; /* group containing that ctxt */
329 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
330 struct obd_import *loc_imp; /* to use in RPC's: can be backward
332 struct llog_operations *loc_logops;
333 struct llog_handle *loc_handle;
334 struct mutex loc_mutex; /* protect loc_imp */
335 atomic_t loc_refcount;
336 long loc_flags; /* flags, see above defines */
337 struct dt_object *loc_dir;
338 struct local_oid_storage *loc_los_nameless;
339 struct local_oid_storage *loc_los_named;
342 #define LLOG_PROC_BREAK 0x0001
343 #define LLOG_DEL_RECORD 0x0002
344 #define LLOG_DEL_PLAIN 0x0003
346 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
347 struct llog_operations **lop)
352 *lop = ctxt->loc_logops;
359 static inline int llog_handle2ops(struct llog_handle *loghandle,
360 struct llog_operations **lop)
362 if (loghandle == NULL || loghandle->lgh_logops == NULL)
365 *lop = loghandle->lgh_logops;
369 static inline int llog_data_len(int len)
371 return cfs_size_round(len);
374 static inline int llog_get_size(struct llog_handle *loghandle)
376 if (loghandle && loghandle->lgh_hdr)
377 return loghandle->lgh_hdr->llh_count;
381 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
383 atomic_inc(&ctxt->loc_refcount);
384 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
385 atomic_read(&ctxt->loc_refcount));
389 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
393 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
394 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
395 atomic_read(&ctxt->loc_refcount) - 1);
396 __llog_ctxt_put(NULL, ctxt);
399 static inline void llog_group_init(struct obd_llog_group *olg)
401 init_waitqueue_head(&olg->olg_waitq);
402 spin_lock_init(&olg->olg_lock);
403 mutex_init(&olg->olg_cat_processing);
406 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
407 struct llog_ctxt *ctxt, int index)
409 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
411 spin_lock(&olg->olg_lock);
412 if (olg->olg_ctxts[index] != NULL) {
413 spin_unlock(&olg->olg_lock);
416 olg->olg_ctxts[index] = ctxt;
417 spin_unlock(&olg->olg_lock);
421 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
424 struct llog_ctxt *ctxt;
426 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
428 spin_lock(&olg->olg_lock);
429 if (olg->olg_ctxts[index] == NULL)
432 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
433 spin_unlock(&olg->olg_lock);
437 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
439 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
440 spin_lock(&olg->olg_lock);
441 olg->olg_ctxts[index] = NULL;
442 spin_unlock(&olg->olg_lock);
445 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
448 return llog_group_get_ctxt(&obd->obd_olg, index);
451 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
453 return (olg->olg_ctxts[index] == NULL);
456 static inline int llog_ctxt_null(struct obd_device *obd, int index)
458 return (llog_group_ctxt_null(&obd->obd_olg, index));
461 static inline int llog_destroy(const struct lu_env *env,
462 struct llog_handle *handle)
464 struct llog_operations *lop;
469 rc = llog_handle2ops(handle, &lop);
472 if (lop->lop_destroy == NULL)
475 rc = lop->lop_destroy(env, handle);
479 static inline int llog_next_block(const struct lu_env *env,
480 struct llog_handle *loghandle, int *cur_idx,
481 int next_idx, __u64 *cur_offset, void *buf,
484 struct llog_operations *lop;
489 rc = llog_handle2ops(loghandle, &lop);
492 if (lop->lop_next_block == NULL)
495 rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
496 cur_offset, buf, len);
500 static inline int llog_prev_block(const struct lu_env *env,
501 struct llog_handle *loghandle,
502 int prev_idx, void *buf, int len)
504 struct llog_operations *lop;
509 rc = llog_handle2ops(loghandle, &lop);
512 if (lop->lop_prev_block == NULL)
515 rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
519 static inline int llog_connect(struct llog_ctxt *ctxt,
520 struct llog_logid *logid, struct llog_gen *gen,
521 struct obd_uuid *uuid)
523 struct llog_operations *lop;
528 rc = llog_obd2ops(ctxt, &lop);
531 if (lop->lop_connect == NULL)
534 rc = lop->lop_connect(ctxt, logid, gen, uuid);
538 struct llog_cfg_rec {
539 struct llog_rec_hdr lcr_hdr;
540 struct lustre_cfg lcr_cfg;
541 struct llog_rec_tail lcr_tail;
544 struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
545 void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
553 int llog_exist(struct llog_handle *loghandle);
554 int llog_declare_create(const struct lu_env *env,
555 struct llog_handle *loghandle, struct thandle *th);
556 int llog_create(const struct lu_env *env, struct llog_handle *handle,
558 int llog_declare_write_rec(const struct lu_env *env,
559 struct llog_handle *handle,
560 struct llog_rec_hdr *rec, int idx,
562 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
563 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
564 int idx, struct thandle *th);
565 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
566 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
568 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
569 struct llog_rec_hdr *rec, struct thandle *th);
570 int lustre_process_log(struct super_block *sb, char *logname,
571 struct config_llog_instance *cfg);
572 int lustre_end_log(struct super_block *sb, char *logname,
573 struct config_llog_instance *cfg);
574 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
575 struct llog_handle **res, struct llog_logid *logid,
577 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
578 struct llog_logid *logid, char *name);
579 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
580 struct llog_rec_hdr *rec, int idx);