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