Whamcloud - gitweb
LU-4357 libcfs: restore __GFP_WAIT flag to memalloc calls
[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 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
233                       int count, struct obd_ioctl_data *data,
234                       const struct lu_fid *fid);
235
236 /* llog_net.c */
237 int llog_initiator_connect(struct llog_ctxt *ctxt);
238
239 struct llog_operations {
240         int (*lop_destroy)(const struct lu_env *env,
241                            struct llog_handle *handle);
242         int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
243                               int *curr_idx, int next_idx, __u64 *offset,
244                               void *buf, int len);
245         int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
246                               int prev_idx, void *buf, int len);
247         int (*lop_read_header)(const struct lu_env *env,
248                                struct llog_handle *handle);
249         int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
250                          struct obd_llog_group *olg, int ctxt_idx,
251                          struct obd_device *disk_obd);
252         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
253                         int flags);
254         int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
255         int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
256                           struct lov_stripe_md *lsm, int count,
257                           struct llog_cookie *cookies, int flags);
258         int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
259                            struct llog_gen *gen, struct obd_uuid *uuid);
260         /**
261          * Any llog file must be opened first using llog_open().  Llog can be
262          * opened by name, logid or without both, in last case the new logid
263          * will be generated.
264          */
265         int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
266                         struct llog_logid *logid, char *name,
267                         enum llog_open_param);
268         /**
269          * Opened llog may not exist and this must be checked where needed using
270          * the llog_exist() call.
271          */
272         int (*lop_exist)(struct llog_handle *lgh);
273         /**
274          * Close llog file and calls llog_free_handle() implicitly.
275          * Any opened llog must be closed by llog_close() call.
276          */
277         int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
278         /**
279          * Create new llog file. The llog must be opened.
280          * Must be used only for local llog operations.
281          */
282         int (*lop_declare_create)(const struct lu_env *env,
283                                   struct llog_handle *handle,
284                                   struct thandle *th);
285         int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
286                           struct thandle *th);
287         /**
288          * write new record in llog. It appends records usually but can edit
289          * existing records too.
290          */
291         int (*lop_declare_write_rec)(const struct lu_env *env,
292                                      struct llog_handle *lgh,
293                                      struct llog_rec_hdr *rec,
294                                      int idx, struct thandle *th);
295         int (*lop_write_rec)(const struct lu_env *env,
296                              struct llog_handle *loghandle,
297                              struct llog_rec_hdr *rec,
298                              struct llog_cookie *cookie, int cookiecount,
299                              void *buf, int idx, struct thandle *th);
300         /**
301          * Add new record in llog catalog. Does the same as llog_write_rec()
302          * but using llog catalog.
303          */
304         int (*lop_declare_add)(const struct lu_env *env,
305                                struct llog_handle *lgh,
306                                struct llog_rec_hdr *rec, struct thandle *th);
307         int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
308                        struct llog_rec_hdr *rec, struct llog_cookie *cookie,
309                        void *buf, struct thandle *th);
310         /* Old llog_add version, used in MDS-LOV-OSC now and will gone with
311          * LOD/OSP replacement */
312         int (*lop_obd_add)(const struct lu_env *env, struct llog_ctxt *ctxt,
313                            struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
314                            struct llog_cookie *logcookies, int numcookies);
315 };
316
317 /* In-memory descriptor for a log object or log catalog */
318 struct llog_handle {
319         struct rw_semaphore      lgh_lock;
320         spinlock_t               lgh_hdr_lock; /* protect lgh_hdr data */
321         struct llog_logid        lgh_id; /* id of this log */
322         struct llog_log_hdr     *lgh_hdr;
323         struct dt_object        *lgh_obj;
324         int                      lgh_last_idx;
325         int                      lgh_cur_idx; /* used during llog_process */
326         __u64                    lgh_cur_offset; /* used during llog_process */
327         struct llog_ctxt        *lgh_ctxt;
328         union {
329                 struct plain_handle_data         phd;
330                 struct cat_handle_data           chd;
331         } u;
332         char                    *lgh_name;
333         void                    *private_data;
334         struct llog_operations  *lgh_logops;
335         atomic_t                 lgh_refcount;
336 };
337
338 /* llog_osd.c */
339 extern struct llog_operations llog_osd_ops;
340 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
341                           int idx, int count, struct llog_catid *idarray,
342                           const struct lu_fid *fid);
343 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
344                           int idx, int count, struct llog_catid *idarray,
345                           const struct lu_fid *fid);
346
347 #define LLOG_CTXT_FLAG_UNINITIALIZED     0x00000001
348 #define LLOG_CTXT_FLAG_STOP              0x00000002
349
350 struct llog_ctxt {
351         int                      loc_idx; /* my index the obd array of ctxt's */
352         struct obd_device       *loc_obd; /* points back to the containing obd*/
353         struct obd_llog_group   *loc_olg; /* group containing that ctxt */
354         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
355         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
356                                              pointing import */
357         struct llog_operations  *loc_logops;
358         struct llog_handle      *loc_handle;
359         struct mutex             loc_mutex; /* protect loc_imp */
360         atomic_t                 loc_refcount;
361         long                     loc_flags; /* flags, see above defines */
362         struct dt_object        *loc_dir;
363 };
364
365 #define LLOG_PROC_BREAK 0x0001
366 #define LLOG_DEL_RECORD 0x0002
367
368 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
369                                struct llog_operations **lop)
370 {
371         if (ctxt == NULL)
372                 return -ENOTCONN;
373
374         *lop = ctxt->loc_logops;
375         if (*lop == NULL)
376                 return -EOPNOTSUPP;
377
378         return 0;
379 }
380
381 static inline int llog_handle2ops(struct llog_handle *loghandle,
382                                   struct llog_operations **lop)
383 {
384         if (loghandle == NULL || loghandle->lgh_logops == NULL)
385                 return -EINVAL;
386
387         *lop = loghandle->lgh_logops;
388         return 0;
389 }
390
391 static inline int llog_data_len(int len)
392 {
393         return cfs_size_round(len);
394 }
395
396 static inline int llog_get_size(struct llog_handle *loghandle)
397 {
398         if (loghandle && loghandle->lgh_hdr)
399                 return loghandle->lgh_hdr->llh_count;
400         return 0;
401 }
402
403 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
404 {
405         atomic_inc(&ctxt->loc_refcount);
406         CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
407                atomic_read(&ctxt->loc_refcount));
408         return ctxt;
409 }
410
411 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
412 {
413         if (ctxt == NULL)
414                 return;
415         LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
416         CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
417                atomic_read(&ctxt->loc_refcount) - 1);
418         __llog_ctxt_put(NULL, ctxt);
419 }
420
421 static inline void llog_group_init(struct obd_llog_group *olg, int group)
422 {
423         init_waitqueue_head(&olg->olg_waitq);
424         spin_lock_init(&olg->olg_lock);
425         mutex_init(&olg->olg_cat_processing);
426         olg->olg_seq = group;
427 }
428
429 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
430                                       struct llog_ctxt *ctxt, int index)
431 {
432         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
433
434         spin_lock(&olg->olg_lock);
435         if (olg->olg_ctxts[index] != NULL) {
436                 spin_unlock(&olg->olg_lock);
437                 return -EEXIST;
438         }
439         olg->olg_ctxts[index] = ctxt;
440         spin_unlock(&olg->olg_lock);
441         return 0;
442 }
443
444 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
445                                                     int index)
446 {
447         struct llog_ctxt *ctxt;
448
449         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
450
451         spin_lock(&olg->olg_lock);
452         if (olg->olg_ctxts[index] == NULL)
453                 ctxt = NULL;
454         else
455                 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
456         spin_unlock(&olg->olg_lock);
457         return ctxt;
458 }
459
460 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
461 {
462         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
463         spin_lock(&olg->olg_lock);
464         olg->olg_ctxts[index] = NULL;
465         spin_unlock(&olg->olg_lock);
466 }
467
468 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
469                                                  int index)
470 {
471         return llog_group_get_ctxt(&obd->obd_olg, index);
472 }
473
474 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
475 {
476         return (olg->olg_ctxts[index] == NULL);
477 }
478
479 static inline int llog_ctxt_null(struct obd_device *obd, int index)
480 {
481         return (llog_group_ctxt_null(&obd->obd_olg, index));
482 }
483
484 static inline int llog_destroy(const struct lu_env *env,
485                                struct llog_handle *handle)
486 {
487         struct llog_operations *lop;
488         int rc;
489
490         ENTRY;
491
492         rc = llog_handle2ops(handle, &lop);
493         if (rc)
494                 RETURN(rc);
495         if (lop->lop_destroy == NULL)
496                 RETURN(-EOPNOTSUPP);
497
498         rc = lop->lop_destroy(env, handle);
499         RETURN(rc);
500 }
501
502 static inline int llog_next_block(const struct lu_env *env,
503                                   struct llog_handle *loghandle, int *cur_idx,
504                                   int next_idx, __u64 *cur_offset, void *buf,
505                                   int len)
506 {
507         struct llog_operations *lop;
508         int rc;
509
510         ENTRY;
511
512         rc = llog_handle2ops(loghandle, &lop);
513         if (rc)
514                 RETURN(rc);
515         if (lop->lop_next_block == NULL)
516                 RETURN(-EOPNOTSUPP);
517
518         rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
519                                  cur_offset, buf, len);
520         RETURN(rc);
521 }
522
523 static inline int llog_prev_block(const struct lu_env *env,
524                                   struct llog_handle *loghandle,
525                                   int prev_idx, void *buf, int len)
526 {
527         struct llog_operations *lop;
528         int rc;
529
530         ENTRY;
531
532         rc = llog_handle2ops(loghandle, &lop);
533         if (rc)
534                 RETURN(rc);
535         if (lop->lop_prev_block == NULL)
536                 RETURN(-EOPNOTSUPP);
537
538         rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
539         RETURN(rc);
540 }
541
542 static inline int llog_connect(struct llog_ctxt *ctxt,
543                                struct llog_logid *logid, struct llog_gen *gen,
544                                struct obd_uuid *uuid)
545 {
546         struct llog_operations  *lop;
547         int                      rc;
548
549         ENTRY;
550
551         rc = llog_obd2ops(ctxt, &lop);
552         if (rc)
553                 RETURN(rc);
554         if (lop->lop_connect == NULL)
555                 RETURN(-EOPNOTSUPP);
556
557         rc = lop->lop_connect(ctxt, logid, gen, uuid);
558         RETURN(rc);
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 numcookies, void *buf, 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              void *buf, 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, struct llog_cookie *reccookie,
590                int cookiecount, void *buf, int idx);
591
592 /** @} log */
593
594 #endif