Whamcloud - gitweb
LU-6602 obdclass: variable llog chunk size
[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, 2014, 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 <obd_class.h>
60 #include <lustre/lustre_idl.h>
61 #include <dt_object.h>
62
63 #define LOG_NAME_LIMIT(logname, name)                   \
64         snprintf(logname, sizeof(logname), "LOGS/%s", name)
65 #define LLOG_EEMPTY 4711
66
67 enum llog_open_param {
68         LLOG_OPEN_EXISTS        = 0x0000,
69         LLOG_OPEN_NEW           = 0x0001,
70 };
71
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;
77 };
78
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 */
83 };
84
85 static inline void logid_to_fid(struct llog_logid *id, struct lu_fid *fid)
86 {
87         /* For compatibility purposes we identify pre-OSD (~< 2.3.51 MDS)
88          * logid's by non-zero ogen (inode generation) and convert them
89          * into IGIF */
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;
93                 fid->f_ver = 0;
94         } else {
95                 lu_igif_build(fid, id->lgl_oi.oi.oi_id, id->lgl_ogen);
96         }
97 }
98
99 static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
100 {
101         id->lgl_oi.oi.oi_seq = fid->f_seq;
102         id->lgl_oi.oi.oi_id = fid->f_oid;
103         id->lgl_ogen = 0;
104 }
105
106 static inline void logid_set_id(struct llog_logid *log_id, __u64 id)
107 {
108         log_id->lgl_oi.oi.oi_id = id;
109 }
110
111 static inline __u64 logid_id(struct llog_logid *log_id)
112 {
113         return log_id->lgl_oi.oi.oi_id;
114 }
115
116 struct llog_handle;
117
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,
132                     int index);
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,
138                   char *name);
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);
142
143 /* llog_process flags */
144 #define LLOG_FLAG_NODEAMON 0x0001
145
146 /* llog_cat.c - catalog api */
147 struct llog_process_data {
148         /**
149          * Any useful data needed while processing catalog. This is
150          * passed later to process callback.
151          */
152         void                *lpd_data;
153         /**
154          * Catalog process callback function, called for each record
155          * in catalog.
156          */
157         llog_cb_t            lpd_cb;
158         /**
159          * Start processing the catalog from startcat/startidx
160          */
161         int                  lpd_startcat;
162         int                  lpd_startidx;
163 };
164
165 struct llog_process_cat_data {
166         /**
167          * Temporary stored first_idx while scanning log.
168          */
169         int                  lpcd_first_idx;
170         /**
171          * Temporary stored last_idx while scanning log.
172          */
173         int                  lpcd_last_idx;
174 };
175
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,
179                      struct thandle *th);
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,
195                              void *data);
196 int llog_cat_init_and_process(const struct lu_env *env,
197                               struct llog_handle *llh);
198
199 /* llog_obd.c */
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);
208
209 /* llog_ioctl.c */
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);
216
217 /* llog_net.c */
218 int llog_initiator_connect(struct llog_ctxt *ctxt);
219
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,
225                               void *buf, int len);
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,
234                         int flags);
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);
240         /**
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
243          * will be generated.
244          */
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);
248         /**
249          * Opened llog may not exist and this must be checked where needed using
250          * the llog_exist() call.
251          */
252         int (*lop_exist)(struct llog_handle *lgh);
253         /**
254          * Close llog file and calls llog_free_handle() implicitly.
255          * Any opened llog must be closed by llog_close() call.
256          */
257         int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
258         /**
259          * Create new llog file. The llog must be opened.
260          * Must be used only for local llog operations.
261          */
262         int (*lop_declare_create)(const struct lu_env *env,
263                                   struct llog_handle *handle,
264                                   struct thandle *th);
265         int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
266                           struct thandle *th);
267         /**
268          * write new record in llog. It appends records usually but can edit
269          * existing records too.
270          */
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);
280         /**
281          * Add new record in llog catalog. Does the same as llog_write_rec()
282          * but using llog catalog.
283          */
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,
289                        struct thandle *th);
290 };
291
292 /* In-memory descriptor for a log object or log catalog */
293 struct llog_handle {
294         struct rw_semaphore      lgh_lock;
295         struct rw_semaphore      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         size_t                  lgh_hdr_size;
299         struct dt_object        *lgh_obj;
300         int                      lgh_last_idx;
301         int                      lgh_cur_idx; /* used during llog_process */
302         __u64                    lgh_cur_offset; /* used during llog_process */
303         struct llog_ctxt        *lgh_ctxt;
304         union {
305                 struct plain_handle_data         phd;
306                 struct cat_handle_data           chd;
307         } u;
308         char                    *lgh_name;
309         void                    *private_data;
310         struct llog_operations  *lgh_logops;
311         atomic_t                 lgh_refcount;
312 };
313
314 /* llog_osd.c */
315 extern struct llog_operations llog_osd_ops;
316 extern struct llog_operations llog_common_cat_ops;
317 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
318                           int idx, int count, struct llog_catid *idarray,
319                           const struct lu_fid *fid);
320 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
321                           int idx, int count, struct llog_catid *idarray,
322                           const struct lu_fid *fid);
323
324 #define LLOG_CTXT_FLAG_UNINITIALIZED     0x00000001
325 #define LLOG_CTXT_FLAG_STOP              0x00000002
326
327 /* Indicate the llog objects under this context are normal FID objects,
328  * instead of objects with local FID. */
329 #define LLOG_CTXT_FLAG_NORMAL_FID        0x00000004
330
331 struct llog_ctxt {
332         int                      loc_idx; /* my index the obd array of ctxt's */
333         struct obd_device       *loc_obd; /* points back to the containing obd*/
334         struct obd_llog_group   *loc_olg; /* group containing that ctxt */
335         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
336         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
337                                              pointing import */
338         struct llog_operations  *loc_logops;
339         struct llog_handle      *loc_handle;
340         struct mutex             loc_mutex; /* protect loc_imp */
341         atomic_t                 loc_refcount;
342         long                     loc_flags; /* flags, see above defines */
343         struct dt_object        *loc_dir;
344         struct local_oid_storage *loc_los_nameless;
345         struct local_oid_storage *loc_los_named;
346         /* llog chunk size, and llog record size can not be bigger than
347          * loc_chunk_size */
348         __u32                    loc_chunk_size;
349 };
350
351 #define LLOG_PROC_BREAK 0x0001
352 #define LLOG_DEL_RECORD 0x0002
353 #define LLOG_DEL_PLAIN  0x0003
354
355 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
356                                struct llog_operations **lop)
357 {
358         if (ctxt == NULL)
359                 return -ENOTCONN;
360
361         *lop = ctxt->loc_logops;
362         if (*lop == NULL)
363                 return -EOPNOTSUPP;
364
365         return 0;
366 }
367
368 static inline int llog_handle2ops(struct llog_handle *loghandle,
369                                   struct llog_operations **lop)
370 {
371         if (loghandle == NULL || loghandle->lgh_logops == NULL)
372                 return -EINVAL;
373
374         *lop = loghandle->lgh_logops;
375         return 0;
376 }
377
378 static inline int llog_data_len(int len)
379 {
380         return cfs_size_round(len);
381 }
382
383 static inline int llog_get_size(struct llog_handle *loghandle)
384 {
385         if (loghandle && loghandle->lgh_hdr)
386                 return loghandle->lgh_hdr->llh_count;
387         return 0;
388 }
389
390 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
391 {
392         atomic_inc(&ctxt->loc_refcount);
393         CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
394                atomic_read(&ctxt->loc_refcount));
395         return ctxt;
396 }
397
398 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
399 {
400         if (ctxt == NULL)
401                 return;
402         LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
403         CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
404                atomic_read(&ctxt->loc_refcount) - 1);
405         __llog_ctxt_put(NULL, ctxt);
406 }
407
408 static inline void llog_group_init(struct obd_llog_group *olg)
409 {
410         init_waitqueue_head(&olg->olg_waitq);
411         spin_lock_init(&olg->olg_lock);
412         mutex_init(&olg->olg_cat_processing);
413 }
414
415 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
416                                       struct llog_ctxt *ctxt, int index)
417 {
418         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
419
420         spin_lock(&olg->olg_lock);
421         if (olg->olg_ctxts[index] != NULL) {
422                 spin_unlock(&olg->olg_lock);
423                 return -EEXIST;
424         }
425         olg->olg_ctxts[index] = ctxt;
426         spin_unlock(&olg->olg_lock);
427         return 0;
428 }
429
430 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
431                                                     int index)
432 {
433         struct llog_ctxt *ctxt;
434
435         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
436
437         spin_lock(&olg->olg_lock);
438         if (olg->olg_ctxts[index] == NULL)
439                 ctxt = NULL;
440         else
441                 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
442         spin_unlock(&olg->olg_lock);
443         return ctxt;
444 }
445
446 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
447 {
448         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
449         spin_lock(&olg->olg_lock);
450         olg->olg_ctxts[index] = NULL;
451         spin_unlock(&olg->olg_lock);
452 }
453
454 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
455                                                  int index)
456 {
457         return llog_group_get_ctxt(&obd->obd_olg, index);
458 }
459
460 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
461 {
462         return (olg->olg_ctxts[index] == NULL);
463 }
464
465 static inline int llog_ctxt_null(struct obd_device *obd, int index)
466 {
467         return (llog_group_ctxt_null(&obd->obd_olg, index));
468 }
469
470 static inline int llog_destroy(const struct lu_env *env,
471                                struct llog_handle *handle)
472 {
473         struct llog_operations *lop;
474         int rc;
475
476         ENTRY;
477
478         rc = llog_handle2ops(handle, &lop);
479         if (rc)
480                 RETURN(rc);
481         if (lop->lop_destroy == NULL)
482                 RETURN(-EOPNOTSUPP);
483
484         rc = lop->lop_destroy(env, handle);
485         RETURN(rc);
486 }
487
488 static inline int llog_next_block(const struct lu_env *env,
489                                   struct llog_handle *loghandle, int *cur_idx,
490                                   int next_idx, __u64 *cur_offset, void *buf,
491                                   int len)
492 {
493         struct llog_operations *lop;
494         int rc;
495
496         ENTRY;
497
498         rc = llog_handle2ops(loghandle, &lop);
499         if (rc)
500                 RETURN(rc);
501         if (lop->lop_next_block == NULL)
502                 RETURN(-EOPNOTSUPP);
503
504         rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
505                                  cur_offset, buf, len);
506         RETURN(rc);
507 }
508
509 static inline int llog_prev_block(const struct lu_env *env,
510                                   struct llog_handle *loghandle,
511                                   int prev_idx, void *buf, int len)
512 {
513         struct llog_operations *lop;
514         int rc;
515
516         ENTRY;
517
518         rc = llog_handle2ops(loghandle, &lop);
519         if (rc)
520                 RETURN(rc);
521         if (lop->lop_prev_block == NULL)
522                 RETURN(-EOPNOTSUPP);
523
524         rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
525         RETURN(rc);
526 }
527
528 static inline int llog_connect(struct llog_ctxt *ctxt,
529                                struct llog_logid *logid, struct llog_gen *gen,
530                                struct obd_uuid *uuid)
531 {
532         struct llog_operations  *lop;
533         int                      rc;
534
535         ENTRY;
536
537         rc = llog_obd2ops(ctxt, &lop);
538         if (rc)
539                 RETURN(rc);
540         if (lop->lop_connect == NULL)
541                 RETURN(-EOPNOTSUPP);
542
543         rc = lop->lop_connect(ctxt, logid, gen, uuid);
544         RETURN(rc);
545 }
546
547 struct llog_cfg_rec {
548         struct llog_rec_hdr     lcr_hdr;
549         struct lustre_cfg       lcr_cfg;
550         struct llog_rec_tail    lcr_tail;
551 };
552
553 struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
554 void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
555
556 enum {
557         LLOG_NEXT_IDX = -1,
558         LLOG_HEADER_IDX = 0,
559 };
560
561 /* llog.c */
562 int llog_exist(struct llog_handle *loghandle);
563 int llog_declare_create(const struct lu_env *env,
564                         struct llog_handle *loghandle, struct thandle *th);
565 int llog_create(const struct lu_env *env, struct llog_handle *handle,
566                 struct thandle *th);
567 int llog_declare_write_rec(const struct lu_env *env,
568                            struct llog_handle *handle,
569                            struct llog_rec_hdr *rec, int idx,
570                            struct thandle *th);
571 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
572                    struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
573                    int idx, struct thandle *th);
574 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
575              struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
576              struct thandle *th);
577 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
578                      struct llog_rec_hdr *rec, struct thandle *th);
579 int lustre_process_log(struct super_block *sb, char *logname,
580                        struct config_llog_instance *cfg);
581 int lustre_end_log(struct super_block *sb, char *logname,
582                    struct config_llog_instance *cfg);
583 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
584                      struct llog_handle **res, struct llog_logid *logid,
585                      char *name);
586 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
587                struct llog_logid *logid, char *name);
588 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
589                struct llog_rec_hdr *rec, int idx);
590
591 /** @} log */
592
593 #endif