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 fid->f_seq = id->lgl_oseq;
102 fid->f_oid = id->lgl_oid;
105 lu_igif_build(fid, id->lgl_oid, id->lgl_ogen);
109 static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
111 id->lgl_oseq = fid->f_seq;
112 id->lgl_oid = fid->f_oid;
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_get_size(struct llog_handle *loghandle);
139 /* llog_process flags */
140 #define LLOG_FLAG_NODEAMON 0x0001
142 /* llog_cat.c - catalog api */
143 struct llog_process_data {
145 * Any useful data needed while processing catalog. This is
146 * passed later to process callback.
150 * Catalog process callback function, called for each record
155 * Start processing the catalog from startcat/startidx
161 struct llog_process_cat_data {
163 * Temporary stored first_idx while scanning log.
167 * Temporary stored last_idx while scanning log.
172 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
173 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
174 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
175 void *buf, struct thandle *th);
176 int llog_cat_declare_add_rec(const struct lu_env *env,
177 struct llog_handle *cathandle,
178 struct llog_rec_hdr *rec, struct thandle *th);
179 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
180 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
182 int llog_cat_cancel_records(const struct lu_env *env,
183 struct llog_handle *cathandle, int count,
184 struct llog_cookie *cookies);
185 int llog_cat_process_or_fork(const struct lu_env *env,
186 struct llog_handle *cat_llh, llog_cb_t cb,
187 void *data, int startcat, int startidx, bool fork);
188 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
189 llog_cb_t cb, void *data, int startcat, int startidx);
190 int llog_cat_reverse_process(const struct lu_env *env,
191 struct llog_handle *cat_llh, llog_cb_t cb,
193 int llog_cat_init_and_process(const struct lu_env *env,
194 struct llog_handle *llh);
197 int llog_setup(const struct lu_env *env, struct obd_device *obd,
198 struct obd_llog_group *olg, int index,
199 struct obd_device *disk_obd, struct llog_operations *op);
200 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
201 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
202 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
203 int llog_obd_add(const struct lu_env *env, struct llog_ctxt *ctxt,
204 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
205 struct llog_cookie *logcookies, int numcookies);
206 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
207 struct lov_stripe_md *lsm, int count,
208 struct llog_cookie *cookies, int flags);
210 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
211 struct obd_device *disk_obd, int *idx);
213 int obd_llog_finish(struct obd_device *obd, int count);
216 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
217 struct obd_ioctl_data *data);
220 int llog_initiator_connect(struct llog_ctxt *ctxt);
222 struct llog_operations {
223 int (*lop_destroy)(const struct lu_env *env,
224 struct llog_handle *handle);
225 int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
226 int *curr_idx, int next_idx, __u64 *offset,
228 int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
229 int prev_idx, void *buf, int len);
230 int (*lop_read_header)(const struct lu_env *env,
231 struct llog_handle *handle);
232 int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
233 struct obd_llog_group *olg, int ctxt_idx,
234 struct obd_device *disk_obd);
235 int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
237 int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
238 int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
239 struct lov_stripe_md *lsm, int count,
240 struct llog_cookie *cookies, int flags);
241 int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
242 struct llog_gen *gen, struct obd_uuid *uuid);
244 * Any llog file must be opened first using llog_open(). Llog can be
245 * opened by name, logid or without both, in last case the new logid
248 int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
249 struct llog_logid *logid, char *name,
250 enum llog_open_param);
252 * Opened llog may not exist and this must be checked where needed using
253 * the llog_exist() call.
255 int (*lop_exist)(struct llog_handle *lgh);
257 * Close llog file and calls llog_free_handle() implicitly.
258 * Any opened llog must be closed by llog_close() call.
260 int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
262 * Create new llog file. The llog must be opened.
263 * Must be used only for local llog operations.
265 int (*lop_declare_create)(const struct lu_env *env,
266 struct llog_handle *handle,
268 int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
271 * write new record in llog. It appends records usually but can edit
272 * existing records too.
274 int (*lop_declare_write_rec)(const struct lu_env *env,
275 struct llog_handle *lgh,
276 struct llog_rec_hdr *rec,
277 int idx, struct thandle *th);
278 int (*lop_write_rec)(const struct lu_env *env,
279 struct llog_handle *loghandle,
280 struct llog_rec_hdr *rec,
281 struct llog_cookie *cookie, int cookiecount,
282 void *buf, int idx, struct thandle *th);
284 * Add new record in llog catalog. Does the same as llog_write_rec()
285 * but using llog catalog.
287 int (*lop_declare_add)(const struct lu_env *env,
288 struct llog_handle *lgh,
289 struct llog_rec_hdr *rec, struct thandle *th);
290 int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
291 struct llog_rec_hdr *rec, struct llog_cookie *cookie,
292 void *buf, struct thandle *th);
293 /* Old llog_add version, used in MDS-LOV-OSC now and will gone with
294 * LOD/OSP replacement */
295 int (*lop_obd_add)(const struct lu_env *env, struct llog_ctxt *ctxt,
296 struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
297 struct llog_cookie *logcookies, int numcookies);
300 /* In-memory descriptor for a log object or log catalog */
302 struct rw_semaphore lgh_lock;
303 spinlock_t lgh_hdr_lock; /* protect lgh_hdr data */
304 struct llog_logid lgh_id; /* id of this log */
305 struct llog_log_hdr *lgh_hdr;
306 struct file *lgh_file;
307 struct dt_object *lgh_obj;
309 int lgh_cur_idx; /* used during llog_process */
310 __u64 lgh_cur_offset; /* used during llog_process */
311 struct llog_ctxt *lgh_ctxt;
313 struct plain_handle_data phd;
314 struct cat_handle_data chd;
318 struct llog_operations *lgh_logops;
319 cfs_atomic_t lgh_refcount;
323 extern struct llog_operations llog_lvfs_ops;
326 extern struct llog_operations llog_osd_ops;
327 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
329 struct llog_catid *idarray);
330 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
332 struct llog_catid *idarray);
334 #define LLOG_CTXT_FLAG_UNINITIALIZED 0x00000001
335 #define LLOG_CTXT_FLAG_STOP 0x00000002
338 int loc_idx; /* my index the obd array of ctxt's */
339 struct obd_device *loc_obd; /* points back to the containing obd*/
340 struct obd_llog_group *loc_olg; /* group containing that ctxt */
341 struct obd_export *loc_exp; /* parent "disk" export (e.g. MDS) */
342 struct obd_import *loc_imp; /* to use in RPC's: can be backward
344 struct llog_operations *loc_logops;
345 struct llog_handle *loc_handle;
346 struct mutex loc_mutex; /* protect loc_imp */
347 cfs_atomic_t loc_refcount;
348 long loc_flags; /* flags, see above defines */
349 struct dt_object *loc_dir;
352 #define LLOG_PROC_BREAK 0x0001
353 #define LLOG_DEL_RECORD 0x0002
355 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
356 struct llog_operations **lop)
361 *lop = ctxt->loc_logops;
368 static inline int llog_handle2ops(struct llog_handle *loghandle,
369 struct llog_operations **lop)
371 if (loghandle == NULL || loghandle->lgh_logops == NULL)
374 *lop = loghandle->lgh_logops;
378 static inline int llog_data_len(int len)
380 return cfs_size_round(len);
383 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
385 cfs_atomic_inc(&ctxt->loc_refcount);
386 CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
387 cfs_atomic_read(&ctxt->loc_refcount));
391 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
395 LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
396 CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
397 cfs_atomic_read(&ctxt->loc_refcount) - 1);
398 __llog_ctxt_put(NULL, ctxt);
401 static inline void llog_group_init(struct obd_llog_group *olg, int group)
403 cfs_waitq_init(&olg->olg_waitq);
404 spin_lock_init(&olg->olg_lock);
405 mutex_init(&olg->olg_cat_processing);
406 olg->olg_seq = group;
409 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
410 struct llog_ctxt *ctxt, int index)
412 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
414 spin_lock(&olg->olg_lock);
415 if (olg->olg_ctxts[index] != NULL) {
416 spin_unlock(&olg->olg_lock);
419 olg->olg_ctxts[index] = ctxt;
420 spin_unlock(&olg->olg_lock);
424 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
427 struct llog_ctxt *ctxt;
429 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
431 spin_lock(&olg->olg_lock);
432 if (olg->olg_ctxts[index] == NULL)
435 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
436 spin_unlock(&olg->olg_lock);
440 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
442 LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
443 spin_lock(&olg->olg_lock);
444 olg->olg_ctxts[index] = NULL;
445 spin_unlock(&olg->olg_lock);
448 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
451 return llog_group_get_ctxt(&obd->obd_olg, index);
454 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
456 return (olg->olg_ctxts[index] == NULL);
459 static inline int llog_ctxt_null(struct obd_device *obd, int index)
461 return (llog_group_ctxt_null(&obd->obd_olg, index));
464 static inline int llog_destroy(const struct lu_env *env,
465 struct llog_handle *handle)
467 struct llog_operations *lop;
472 rc = llog_handle2ops(handle, &lop);
475 if (lop->lop_destroy == NULL)
478 rc = lop->lop_destroy(env, handle);
482 static inline int llog_next_block(const struct lu_env *env,
483 struct llog_handle *loghandle, int *cur_idx,
484 int next_idx, __u64 *cur_offset, void *buf,
487 struct llog_operations *lop;
492 rc = llog_handle2ops(loghandle, &lop);
495 if (lop->lop_next_block == NULL)
498 rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
499 cur_offset, buf, len);
503 static inline int llog_prev_block(const struct lu_env *env,
504 struct llog_handle *loghandle,
505 int prev_idx, void *buf, int len)
507 struct llog_operations *lop;
512 rc = llog_handle2ops(loghandle, &lop);
515 if (lop->lop_prev_block == NULL)
518 rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
522 static inline int llog_connect(struct llog_ctxt *ctxt,
523 struct llog_logid *logid, struct llog_gen *gen,
524 struct obd_uuid *uuid)
526 struct llog_operations *lop;
531 rc = llog_obd2ops(ctxt, &lop);
534 if (lop->lop_connect == NULL)
537 rc = lop->lop_connect(ctxt, logid, gen, uuid);
542 int llog_exist(struct llog_handle *loghandle);
543 int llog_declare_create(const struct lu_env *env,
544 struct llog_handle *loghandle, struct thandle *th);
545 int llog_create(const struct lu_env *env, struct llog_handle *handle,
547 int llog_declare_write_rec(const struct lu_env *env,
548 struct llog_handle *handle,
549 struct llog_rec_hdr *rec, int idx,
551 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
552 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
553 int numcookies, void *buf, int idx, struct thandle *th);
554 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
555 struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
556 void *buf, struct thandle *th);
557 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
558 struct llog_rec_hdr *rec, struct thandle *th);
559 int lustre_process_log(struct super_block *sb, char *logname,
560 struct config_llog_instance *cfg);
561 int lustre_end_log(struct super_block *sb, char *logname,
562 struct config_llog_instance *cfg);
563 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
564 struct llog_handle **res, struct llog_logid *logid,
566 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
567 struct llog_logid *logid, char *name);
568 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
569 struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
570 int cookiecount, void *buf, int idx);