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