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