Whamcloud - gitweb
eb986f9c18b1cf5a6906e75190b4fc93568c024a
[fs/lustre-release.git] / lustre / include / lustre_log.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
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
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2012, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/include/lustre_log.h
37  *
38  * Generic infrastructure for managing a collection of logs.
39  * These logs are used for:
40  *
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
44  *
45  * - mds unlink log: the MDS adds an entry upon delete
46  *
47  * - raid1 replication log between OST's
48  * - MDS replication logs
49  */
50
51 #ifndef _LUSTRE_LOG_H
52 #define _LUSTRE_LOG_H
53
54 /** \defgroup log log
55  *
56  * @{
57  */
58
59 #include <linux/lustre_log.h>
60
61 #include <obd_class.h>
62 #include <lustre/lustre_idl.h>
63 #include <dt_object.h>
64
65 #define LOG_NAME_LIMIT(logname, name)                   \
66         snprintf(logname, sizeof(logname), "LOGS/%s", name)
67 #define LLOG_EEMPTY 4711
68
69 enum llog_open_param {
70         LLOG_OPEN_EXISTS        = 0x0000,
71         LLOG_OPEN_NEW           = 0x0001,
72 };
73
74 struct plain_handle_data {
75         struct list_head        phd_entry;
76         struct llog_handle      *phd_cat_handle;
77         /* cookie of this log in its cat */
78         struct llog_cookie      phd_cookie;
79 };
80
81 struct cat_handle_data {
82         struct list_head        chd_head;
83         struct llog_handle     *chd_current_log;/* currently open log */
84         struct llog_handle     *chd_next_log;   /* llog to be used next */
85 };
86
87 static inline void logid_to_fid(struct llog_logid *id, struct lu_fid *fid)
88 {
89         /* For compatibility purposes we identify pre-OSD (~< 2.3.51 MDS)
90          * logid's by non-zero ogen (inode generation) and convert them
91          * into IGIF */
92         if (id->lgl_ogen == 0) {
93                 fid->f_seq = id->lgl_oi.oi.oi_seq;
94                 fid->f_oid = id->lgl_oi.oi.oi_id;
95                 fid->f_ver = 0;
96         } else {
97                 lu_igif_build(fid, id->lgl_oi.oi.oi_id, id->lgl_ogen);
98         }
99 }
100
101 static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
102 {
103         id->lgl_oi.oi.oi_seq = fid->f_seq;
104         id->lgl_oi.oi.oi_id = fid->f_oid;
105         id->lgl_ogen = 0;
106 }
107
108 static inline void logid_set_id(struct llog_logid *log_id, __u64 id)
109 {
110         log_id->lgl_oi.oi.oi_id = id;
111 }
112
113 static inline __u64 logid_id(struct llog_logid *log_id)
114 {
115         return log_id->lgl_oi.oi.oi_id;
116 }
117
118 struct llog_handle;
119
120 /* llog.c  -  general API */
121 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
122                      int flags, struct obd_uuid *uuid);
123 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
124                       struct llog_rec_hdr *rec, void *data);
125 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
126                  llog_cb_t cb, void *data, void *catdata);
127 int llog_process_or_fork(const struct lu_env *env,
128                          struct llog_handle *loghandle,
129                          llog_cb_t cb, void *data, void *catdata, bool fork);
130 int llog_reverse_process(const struct lu_env *env,
131                          struct llog_handle *loghandle, llog_cb_t cb,
132                          void *data, void *catdata);
133 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
134                     int index);
135 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
136               struct llog_handle **lgh, struct llog_logid *logid,
137               char *name, enum llog_open_param open_param);
138 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
139 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
140                   char *name);
141 int llog_backup(const struct lu_env *env, struct obd_device *obd,
142                 struct llog_ctxt *ctxt, struct llog_ctxt *bak_ctxt,
143                 char *name, char *backup);
144
145 /* llog_process flags */
146 #define LLOG_FLAG_NODEAMON 0x0001
147
148 /* llog_cat.c - catalog api */
149 struct llog_process_data {
150         /**
151          * Any useful data needed while processing catalog. This is
152          * passed later to process callback.
153          */
154         void                *lpd_data;
155         /**
156          * Catalog process callback function, called for each record
157          * in catalog.
158          */
159         llog_cb_t            lpd_cb;
160         /**
161          * Start processing the catalog from startcat/startidx
162          */
163         int                  lpd_startcat;
164         int                  lpd_startidx;
165 };
166
167 struct llog_process_cat_data {
168         /**
169          * Temporary stored first_idx while scanning log.
170          */
171         int                  lpcd_first_idx;
172         /**
173          * Temporary stored last_idx while scanning log.
174          */
175         int                  lpcd_last_idx;
176 };
177
178 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
179 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
180                      struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
181                      struct thandle *th);
182 int llog_cat_declare_add_rec(const struct lu_env *env,
183                              struct llog_handle *cathandle,
184                              struct llog_rec_hdr *rec, struct thandle *th);
185 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
186                  struct llog_rec_hdr *rec, struct llog_cookie *reccookie);
187 int llog_cat_cancel_records(const struct lu_env *env,
188                             struct llog_handle *cathandle, int count,
189                             struct llog_cookie *cookies);
190 int llog_cat_process_or_fork(const struct lu_env *env,
191                              struct llog_handle *cat_llh, llog_cb_t cb,
192                              void *data, int startcat, int startidx, bool fork);
193 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
194                      llog_cb_t cb, void *data, int startcat, int startidx);
195 int llog_cat_reverse_process(const struct lu_env *env,
196                              struct llog_handle *cat_llh, llog_cb_t cb,
197                              void *data);
198 int llog_cat_init_and_process(const struct lu_env *env,
199                               struct llog_handle *llh);
200
201 /* llog_obd.c */
202 int llog_setup(const struct lu_env *env, struct obd_device *obd,
203                struct obd_llog_group *olg, int index,
204                struct obd_device *disk_obd, struct llog_operations *op);
205 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
206 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
207 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
208 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
209                 struct llog_cookie *cookies, int flags);
210
211 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
212                   struct obd_device *disk_obd, int *idx);
213
214 int obd_llog_finish(struct obd_device *obd, int count);
215
216 /* llog_ioctl.c */
217 struct obd_ioctl_data;
218 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
219                struct obd_ioctl_data *data);
220 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
221                       int count, struct obd_ioctl_data *data,
222                       const struct lu_fid *fid);
223
224 /* llog_net.c */
225 int llog_initiator_connect(struct llog_ctxt *ctxt);
226
227 struct llog_operations {
228         int (*lop_destroy)(const struct lu_env *env,
229                            struct llog_handle *handle);
230         int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
231                               int *curr_idx, int next_idx, __u64 *offset,
232                               void *buf, int len);
233         int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
234                               int prev_idx, void *buf, int len);
235         int (*lop_read_header)(const struct lu_env *env,
236                                struct llog_handle *handle);
237         int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
238                          struct obd_llog_group *olg, int ctxt_idx,
239                          struct obd_device *disk_obd);
240         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
241                         int flags);
242         int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
243         int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
244                           struct llog_cookie *cookies, int flags);
245         int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
246                            struct llog_gen *gen, struct obd_uuid *uuid);
247         /**
248          * Any llog file must be opened first using llog_open().  Llog can be
249          * opened by name, logid or without both, in last case the new logid
250          * will be generated.
251          */
252         int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
253                         struct llog_logid *logid, char *name,
254                         enum llog_open_param);
255         /**
256          * Opened llog may not exist and this must be checked where needed using
257          * the llog_exist() call.
258          */
259         int (*lop_exist)(struct llog_handle *lgh);
260         /**
261          * Close llog file and calls llog_free_handle() implicitly.
262          * Any opened llog must be closed by llog_close() call.
263          */
264         int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
265         /**
266          * Create new llog file. The llog must be opened.
267          * Must be used only for local llog operations.
268          */
269         int (*lop_declare_create)(const struct lu_env *env,
270                                   struct llog_handle *handle,
271                                   struct thandle *th);
272         int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
273                           struct thandle *th);
274         /**
275          * write new record in llog. It appends records usually but can edit
276          * existing records too.
277          */
278         int (*lop_declare_write_rec)(const struct lu_env *env,
279                                      struct llog_handle *lgh,
280                                      struct llog_rec_hdr *rec,
281                                      int idx, struct thandle *th);
282         int (*lop_write_rec)(const struct lu_env *env,
283                              struct llog_handle *loghandle,
284                              struct llog_rec_hdr *rec,
285                              struct llog_cookie *cookie,
286                              int idx, struct thandle *th);
287         /**
288          * Add new record in llog catalog. Does the same as llog_write_rec()
289          * but using llog catalog.
290          */
291         int (*lop_declare_add)(const struct lu_env *env,
292                                struct llog_handle *lgh,
293                                struct llog_rec_hdr *rec, struct thandle *th);
294         int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
295                        struct llog_rec_hdr *rec, struct llog_cookie *cookie,
296                        struct thandle *th);
297 };
298
299 /* In-memory descriptor for a log object or log catalog */
300 struct llog_handle {
301         struct rw_semaphore      lgh_lock;
302         spinlock_t               lgh_hdr_lock; /* protect lgh_hdr data */
303         struct llog_logid        lgh_id; /* id of this log */
304         struct llog_log_hdr     *lgh_hdr;
305         struct dt_object        *lgh_obj;
306         int                      lgh_last_idx;
307         int                      lgh_cur_idx; /* used during llog_process */
308         __u64                    lgh_cur_offset; /* used during llog_process */
309         struct llog_ctxt        *lgh_ctxt;
310         union {
311                 struct plain_handle_data         phd;
312                 struct cat_handle_data           chd;
313         } u;
314         char                    *lgh_name;
315         void                    *private_data;
316         struct llog_operations  *lgh_logops;
317         atomic_t                 lgh_refcount;
318 };
319
320 /* llog_osd.c */
321 extern struct llog_operations llog_osd_ops;
322 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
323                           int idx, int count, struct llog_catid *idarray,
324                           const struct lu_fid *fid);
325 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
326                           int idx, int count, struct llog_catid *idarray,
327                           const struct lu_fid *fid);
328
329 #define LLOG_CTXT_FLAG_UNINITIALIZED     0x00000001
330 #define LLOG_CTXT_FLAG_STOP              0x00000002
331
332 struct llog_ctxt {
333         int                      loc_idx; /* my index the obd array of ctxt's */
334         struct obd_device       *loc_obd; /* points back to the containing obd*/
335         struct obd_llog_group   *loc_olg; /* group containing that ctxt */
336         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
337         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
338                                              pointing import */
339         struct llog_operations  *loc_logops;
340         struct llog_handle      *loc_handle;
341         struct mutex             loc_mutex; /* protect loc_imp */
342         atomic_t                 loc_refcount;
343         long                     loc_flags; /* flags, see above defines */
344         struct dt_object        *loc_dir;
345         struct local_oid_storage *loc_los_nameless;
346         struct local_oid_storage *loc_los_named;
347 };
348
349 #define LLOG_PROC_BREAK 0x0001
350 #define LLOG_DEL_RECORD 0x0002
351 #define LLOG_DEL_PLAIN  0x0003
352
353 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
354                                struct llog_operations **lop)
355 {
356         if (ctxt == NULL)
357                 return -ENOTCONN;
358
359         *lop = ctxt->loc_logops;
360         if (*lop == NULL)
361                 return -EOPNOTSUPP;
362
363         return 0;
364 }
365
366 static inline int llog_handle2ops(struct llog_handle *loghandle,
367                                   struct llog_operations **lop)
368 {
369         if (loghandle == NULL || loghandle->lgh_logops == NULL)
370                 return -EINVAL;
371
372         *lop = loghandle->lgh_logops;
373         return 0;
374 }
375
376 static inline int llog_data_len(int len)
377 {
378         return cfs_size_round(len);
379 }
380
381 static inline int llog_get_size(struct llog_handle *loghandle)
382 {
383         if (loghandle && loghandle->lgh_hdr)
384                 return loghandle->lgh_hdr->llh_count;
385         return 0;
386 }
387
388 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
389 {
390         atomic_inc(&ctxt->loc_refcount);
391         CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
392                atomic_read(&ctxt->loc_refcount));
393         return ctxt;
394 }
395
396 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
397 {
398         if (ctxt == NULL)
399                 return;
400         LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
401         CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
402                atomic_read(&ctxt->loc_refcount) - 1);
403         __llog_ctxt_put(NULL, ctxt);
404 }
405
406 static inline void llog_group_init(struct obd_llog_group *olg)
407 {
408         init_waitqueue_head(&olg->olg_waitq);
409         spin_lock_init(&olg->olg_lock);
410         mutex_init(&olg->olg_cat_processing);
411 }
412
413 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
414                                       struct llog_ctxt *ctxt, int index)
415 {
416         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
417
418         spin_lock(&olg->olg_lock);
419         if (olg->olg_ctxts[index] != NULL) {
420                 spin_unlock(&olg->olg_lock);
421                 return -EEXIST;
422         }
423         olg->olg_ctxts[index] = ctxt;
424         spin_unlock(&olg->olg_lock);
425         return 0;
426 }
427
428 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
429                                                     int index)
430 {
431         struct llog_ctxt *ctxt;
432
433         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
434
435         spin_lock(&olg->olg_lock);
436         if (olg->olg_ctxts[index] == NULL)
437                 ctxt = NULL;
438         else
439                 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
440         spin_unlock(&olg->olg_lock);
441         return ctxt;
442 }
443
444 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
445 {
446         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
447         spin_lock(&olg->olg_lock);
448         olg->olg_ctxts[index] = NULL;
449         spin_unlock(&olg->olg_lock);
450 }
451
452 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
453                                                  int index)
454 {
455         return llog_group_get_ctxt(&obd->obd_olg, index);
456 }
457
458 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
459 {
460         return (olg->olg_ctxts[index] == NULL);
461 }
462
463 static inline int llog_ctxt_null(struct obd_device *obd, int index)
464 {
465         return (llog_group_ctxt_null(&obd->obd_olg, index));
466 }
467
468 static inline int llog_destroy(const struct lu_env *env,
469                                struct llog_handle *handle)
470 {
471         struct llog_operations *lop;
472         int rc;
473
474         ENTRY;
475
476         rc = llog_handle2ops(handle, &lop);
477         if (rc)
478                 RETURN(rc);
479         if (lop->lop_destroy == NULL)
480                 RETURN(-EOPNOTSUPP);
481
482         rc = lop->lop_destroy(env, handle);
483         RETURN(rc);
484 }
485
486 static inline int llog_next_block(const struct lu_env *env,
487                                   struct llog_handle *loghandle, int *cur_idx,
488                                   int next_idx, __u64 *cur_offset, void *buf,
489                                   int len)
490 {
491         struct llog_operations *lop;
492         int rc;
493
494         ENTRY;
495
496         rc = llog_handle2ops(loghandle, &lop);
497         if (rc)
498                 RETURN(rc);
499         if (lop->lop_next_block == NULL)
500                 RETURN(-EOPNOTSUPP);
501
502         rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
503                                  cur_offset, buf, len);
504         RETURN(rc);
505 }
506
507 static inline int llog_prev_block(const struct lu_env *env,
508                                   struct llog_handle *loghandle,
509                                   int prev_idx, void *buf, int len)
510 {
511         struct llog_operations *lop;
512         int rc;
513
514         ENTRY;
515
516         rc = llog_handle2ops(loghandle, &lop);
517         if (rc)
518                 RETURN(rc);
519         if (lop->lop_prev_block == NULL)
520                 RETURN(-EOPNOTSUPP);
521
522         rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
523         RETURN(rc);
524 }
525
526 static inline int llog_connect(struct llog_ctxt *ctxt,
527                                struct llog_logid *logid, struct llog_gen *gen,
528                                struct obd_uuid *uuid)
529 {
530         struct llog_operations  *lop;
531         int                      rc;
532
533         ENTRY;
534
535         rc = llog_obd2ops(ctxt, &lop);
536         if (rc)
537                 RETURN(rc);
538         if (lop->lop_connect == NULL)
539                 RETURN(-EOPNOTSUPP);
540
541         rc = lop->lop_connect(ctxt, logid, gen, uuid);
542         RETURN(rc);
543 }
544
545 struct llog_cfg_rec {
546         struct llog_rec_hdr     lcr_hdr;
547         struct lustre_cfg       lcr_cfg;
548         struct llog_rec_tail    lcr_tail;
549 };
550
551 struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
552 void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
553
554 enum {
555         LLOG_NEXT_IDX = -1,
556         LLOG_HEADER_IDX = 0,
557 };
558
559 /* llog.c */
560 int llog_exist(struct llog_handle *loghandle);
561 int llog_declare_create(const struct lu_env *env,
562                         struct llog_handle *loghandle, struct thandle *th);
563 int llog_create(const struct lu_env *env, struct llog_handle *handle,
564                 struct thandle *th);
565 int llog_declare_write_rec(const struct lu_env *env,
566                            struct llog_handle *handle,
567                            struct llog_rec_hdr *rec, int idx,
568                            struct thandle *th);
569 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
570                    struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
571                    int idx, struct thandle *th);
572 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
573              struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
574              struct thandle *th);
575 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
576                      struct llog_rec_hdr *rec, struct thandle *th);
577 int lustre_process_log(struct super_block *sb, char *logname,
578                        struct config_llog_instance *cfg);
579 int lustre_end_log(struct super_block *sb, char *logname,
580                    struct config_llog_instance *cfg);
581 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
582                      struct llog_handle **res, struct llog_logid *logid,
583                      char *name);
584 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
585                struct llog_logid *logid, char *name);
586 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
587                struct llog_rec_hdr *rec, int idx);
588
589 /** @} log */
590
591 #endif