Whamcloud - gitweb
Land b1_8_gate onto b1_8 (20081218_1708)
[fs/lustre-release.git] / lustre / include / lustre_log.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
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 #if defined(__linux__)
55 #include <linux/lustre_log.h>
56 #elif defined(__APPLE__)
57 #include <darwin/lustre_log.h>
58 #elif defined(__WINNT__)
59 #include <winnt/lustre_log.h>
60 #else
61 #error Unsupported operating system.
62 #endif
63
64 #include <obd.h>
65 #include <obd_ost.h>
66 #include <lustre/lustre_idl.h>
67
68 #define LOG_NAME_LIMIT(logname, name)                   \
69         snprintf(logname, sizeof(logname), "LOGS/%s", name)
70 #define LLOG_EEMPTY 4711
71
72 struct plain_handle_data {
73         struct list_head    phd_entry;
74         struct llog_handle *phd_cat_handle;
75         struct llog_cookie  phd_cookie; /* cookie of this log in its cat */
76         int                 phd_last_idx;
77 };
78
79 struct cat_handle_data {
80         struct list_head        chd_head;
81         struct llog_handle     *chd_current_log; /* currently open log */
82 };
83
84 /* In-memory descriptor for a log object or log catalog */
85 struct llog_handle {
86         struct rw_semaphore     lgh_lock;
87         struct llog_logid       lgh_id;              /* id of this log */
88         struct llog_log_hdr    *lgh_hdr;
89         struct file            *lgh_file;
90         int                     lgh_last_idx;
91         int                     lgh_cur_idx;    /* used during llog_process */
92         __u64                   lgh_cur_offset; /* used during llog_process */
93         struct llog_ctxt       *lgh_ctxt;
94         union {
95                 struct plain_handle_data phd;
96                 struct cat_handle_data   chd;
97         } u;
98 };
99
100 /* llog.c  -  general API */
101 typedef int (*llog_cb_t)(struct llog_handle *, struct llog_rec_hdr *, void *);
102 typedef int (*llog_fill_rec_cb_t)(struct llog_rec_hdr *rec, void *data);
103 extern struct llog_handle *llog_alloc_handle(void);
104 int llog_init_handle(struct llog_handle *handle, int flags,
105                      struct obd_uuid *uuid);
106 extern void llog_free_handle(struct llog_handle *handle);
107 int llog_process(struct llog_handle *loghandle, llog_cb_t cb,
108                  void *data, void *catdata);
109 int llog_reverse_process(struct llog_handle *loghandle, llog_cb_t cb,
110                          void *data, void *catdata);
111 extern int llog_cancel_rec(struct llog_handle *loghandle, int index);
112 extern int llog_close(struct llog_handle *cathandle);
113 extern int llog_get_size(struct llog_handle *loghandle);
114
115 /* llog_cat.c - catalog api */
116 struct llog_process_data {
117         /**
118          * Any useful data needed while processing catalog. This is
119          * passed later to process callback.
120          */
121         void                *lpd_data;
122         /**
123          * Catalog process callback function, called for each record
124          * in catalog.
125          */
126         llog_cb_t            lpd_cb;
127 };
128
129 struct llog_process_cat_data {
130         /**
131          * Temporary stored first_idx while scanning log.
132          */
133         int                  lpcd_first_idx;
134         /**
135          * Temporary stored last_idx while scanning log.
136          */
137         int                  lpcd_last_idx;
138 };
139
140 struct llog_process_cat_args {
141         /**
142          * Llog context used in recovery thread on OST (recov_thread.c)
143          */
144         struct llog_ctxt    *lpca_ctxt;
145         /**
146          * Llog callback used in recovery thread on OST (recov_thread.c)
147          */
148         void                *lpca_cb;
149         /**
150          * Data pointer for llog callback.
151          */
152         void                *lpca_arg;
153 };
154
155 int llog_cat_put(struct llog_handle *cathandle);
156 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
157                      struct llog_cookie *reccookie, void *buf);
158 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
159                             struct llog_cookie *cookies);
160 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
161 int llog_cat_process_thread(void *data);
162 int llog_cat_reverse_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data);
163 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index);
164
165 /* llog_obd.c */
166 int llog_setup(struct obd_device *obd, int index, struct obd_device *disk_obd,
167                int count,  struct llog_logid *logid,struct llog_operations *op);
168 int __llog_ctxt_put(struct llog_ctxt *ctxt);
169 int llog_cleanup(struct llog_ctxt *);
170 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
171 int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
172              struct lov_stripe_md *lsm, struct llog_cookie *logcookies,
173              int numcookies);
174 int llog_cancel(struct llog_ctxt *, struct lov_stripe_md *lsm,
175                 int count, struct llog_cookie *cookies, int flags);
176
177 int llog_obd_origin_setup(struct obd_device *obd, int index,
178                           struct obd_device *disk_obd, int count,
179                           struct llog_logid *logid);
180 int llog_obd_origin_cleanup(struct llog_ctxt *ctxt);
181 int llog_obd_origin_add(struct llog_ctxt *ctxt,
182                         struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
183                         struct llog_cookie *logcookies, int numcookies);
184
185 int llog_cat_initialize(struct obd_device *obd, int idx,
186                         struct obd_uuid *uuid);
187 int obd_llog_init(struct obd_device *obd, struct obd_device *disk_obd,
188                   int count, struct llog_catid *logid, struct obd_uuid *uuid);
189
190 int obd_llog_finish(struct obd_device *obd, int count);
191
192 /* llog_ioctl.c */
193 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
194 int llog_catalog_list(struct obd_device *obd, int count,
195                       struct obd_ioctl_data *data);
196
197 /* llog_net.c */
198 int llog_initiator_connect(struct llog_ctxt *ctxt);
199 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
200 int llog_origin_connect(struct llog_ctxt *ctxt,
201                         struct llog_logid *logid, struct llog_gen *gen,
202                         struct obd_uuid *uuid);
203 int llog_handle_connect(struct ptlrpc_request *req);
204
205 /* recov_thread.c */
206 int llog_obd_repl_cancel(struct llog_ctxt *ctxt,
207                          struct lov_stripe_md *lsm, int count,
208                          struct llog_cookie *cookies, int flags);
209 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
210 int llog_obd_repl_connect(struct llog_ctxt *ctxt,
211                           struct llog_logid *logid, struct llog_gen *gen,
212                           struct obd_uuid *uuid);
213
214 struct llog_operations {
215         int (*lop_write_rec)(struct llog_handle *loghandle,
216                              struct llog_rec_hdr *rec,
217                              struct llog_cookie *logcookies, int numcookies,
218                              void *, int idx);
219         int (*lop_destroy)(struct llog_handle *handle);
220         int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
221                               int next_idx, __u64 *offset, void *buf, int len);
222         int (*lop_prev_block)(struct llog_handle *h,
223                               int prev_idx, void *buf, int len);
224         int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
225                           struct llog_logid *logid, char *name);
226         int (*lop_close)(struct llog_handle *handle);
227         int (*lop_read_header)(struct llog_handle *handle);
228
229         int (*lop_setup)(struct obd_device *obd, int ctxt_idx,
230                          struct obd_device *disk_obd, int count,
231                          struct llog_logid *logid);
232         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp);
233         int (*lop_cleanup)(struct llog_ctxt *ctxt);
234         int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
235                        struct lov_stripe_md *lsm,
236                        struct llog_cookie *logcookies, int numcookies);
237         int (*lop_cancel)(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm,
238                           int count, struct llog_cookie *cookies, int flags);
239         int (*lop_connect)(struct llog_ctxt *ctxt,
240                            struct llog_logid *logid, struct llog_gen *gen,
241                            struct obd_uuid *uuid);
242         /* XXX add 2 more: commit callbacks and llog recovery functions */
243 };
244
245 /* llog_lvfs.c */
246 extern struct llog_operations llog_lvfs_ops;
247 int llog_get_cat_list(struct obd_device *obd, struct obd_device *disk_obd,
248                       char *name, int idx, int count,
249                       struct llog_catid *idarray);
250
251 int llog_put_cat_list(struct obd_device *obd, struct obd_device *disk_obd,
252                       char *name, int idx, int count, struct llog_catid *idarray);
253
254 struct llog_ctxt {
255         int                      loc_idx; /* my index the obd array of ctxt's */
256         struct llog_gen          loc_gen;
257         struct obd_device       *loc_obd; /* points back to the containing obd*/
258         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
259         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
260                                              pointing import */
261         struct llog_operations  *loc_logops;
262         struct llog_handle      *loc_handle;
263         struct llog_canceld_ctxt *loc_llcd;
264         struct semaphore         loc_sem; /* protects loc_llcd and loc_imp */
265         atomic_t                 loc_refcount;
266         struct llog_commit_master *loc_lcm;
267         void                    *llog_proc_cb;
268 };
269
270 #define LCM_NAME_SIZE 64
271
272 struct llog_commit_master {
273         /**
274          * Thread control flags (start, stop, etc.)
275          */
276         long                       lcm_flags;
277         /**
278          * Number of llcds onthis lcm.
279          */
280         atomic_t                   lcm_count;
281         /**
282          * Thread control structure. Used for control commit thread.
283          */
284         struct ptlrpcd_ctl         lcm_pc;
285         /**
286          * Lock protecting list of llcds.
287          */
288         spinlock_t                 lcm_lock;
289         /**
290          * Llcds in flight for debugging purposes.
291          */
292         struct list_head           lcm_llcds;
293         /**
294          * Commit thread name buffer. Only used for thread start.
295          */
296         char                       lcm_name[LCM_NAME_SIZE];
297 };
298
299 struct llog_canceld_ctxt {
300         /**
301          * Llog context this llcd is attached to. Used for accessing
302          * ->loc_import and others in process of canceling cookies
303          * gathered in this llcd.
304          */
305         struct llog_ctxt          *llcd_ctxt;
306         /**
307          * Cancel thread control stucture pointer. Used for accessing
308          * it to see if should stop processing and other needs.
309          */
310         struct llog_commit_master *llcd_lcm;
311         /**
312          * Maximal llcd size. Used in calculations on how much of room
313          * left in llcd to cookie comming cookies.
314          */
315         int                        llcd_size;
316         /**
317          * Link to lcm llcds list.
318          */
319         struct list_head           llcd_list;
320         /**
321          * Current llcd size while gathering cookies. This should not be
322          * more than ->llcd_size. Used for determining if we need to
323          * send this llcd (if full) and allocate new one. This is also
324          * used for copying new cookie at the end of buffer.
325          */
326         int                        llcd_cookiebytes;
327         /**
328          * Pointer to the start of cookies buffer.
329          */
330         struct llog_cookie         llcd_cookies[0];
331 };
332
333 /* ptlrpc/recov_thread.c */
334 extern struct llog_commit_master *llog_recov_thread_init(char *name);
335 extern void llog_recov_thread_fini(struct llog_commit_master *lcm, 
336                                    int force);
337 extern int llog_recov_thread_start(struct llog_commit_master *lcm);
338 extern void llog_recov_thread_stop(struct llog_commit_master *lcm, 
339                                    int force);
340
341 static inline void llog_gen_init(struct llog_ctxt *ctxt)
342 {
343         struct obd_device *obd = ctxt->loc_exp->exp_obd;
344
345         if (!strcmp(obd->obd_type->typ_name, LUSTRE_MDS_NAME))
346                 ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count;
347         else if (!strstr(obd->obd_type->typ_name, LUSTRE_OST_NAME))
348                 ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count;
349         else
350                 ctxt->loc_gen.mnt_cnt = 0;
351 }
352
353 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
354 {
355         if (a.mnt_cnt < b.mnt_cnt)
356                 return 1;
357         if (a.mnt_cnt > b.mnt_cnt)
358                 return 0;
359         return(a.conn_cnt < b.conn_cnt ? 1 : 0);
360 }
361
362 #define LLOG_GEN_INC(gen)  ((gen).conn_cnt ++)
363 #define LLOG_PROC_BREAK 0x0001
364 #define LLOG_DEL_RECORD 0x0002
365
366 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
367                                struct llog_operations **lop)
368 {
369         if (ctxt == NULL)
370                 return -ENOTCONN;
371
372         *lop = ctxt->loc_logops;
373         if (*lop == NULL)
374                 return -EOPNOTSUPP;
375
376         return 0;
377 }
378
379 static inline int llog_handle2ops(struct llog_handle *loghandle,
380                                   struct llog_operations **lop)
381 {
382         if (loghandle == NULL)
383                 return -EINVAL;
384
385         return llog_obd2ops(loghandle->lgh_ctxt, lop);
386 }
387
388 static inline int llog_data_len(int len)
389 {
390         return size_round(len);
391 }
392
393 #define llog_ctxt_get(ctxt)                                                 \
394 ({                                                                          \
395          struct llog_ctxt *ctxt_ = ctxt;                                    \
396          LASSERT(atomic_read(&ctxt_->loc_refcount) > 0);                    \
397          atomic_inc(&ctxt_->loc_refcount);                                  \
398          CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt_,       \
399                 atomic_read(&ctxt_->loc_refcount));                         \
400          ctxt_;                                                             \
401 })
402  
403 #define llog_ctxt_put(ctxt)                                                 \
404 do {                                                                        \
405          if ((ctxt) == NULL)                                                \
406                  break;                                                     \
407          LASSERT(atomic_read(&(ctxt)->loc_refcount) > 0);                   \
408          LASSERT(atomic_read(&(ctxt)->loc_refcount) < 0x5a5a5a);            \
409          CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", (ctxt),      \
410                 atomic_read(&(ctxt)->loc_refcount) - 1);                    \
411          __llog_ctxt_put(ctxt);                                             \
412 } while (0)
413
414 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
415                                                    int index)
416 {
417          struct llog_ctxt *ctxt;
418
419          if (index < 0 || index >= LLOG_MAX_CTXTS) {
420                  CDEBUG(D_INFO, "obd %p bad index %d\n", obd, index);
421                  return NULL;
422          }
423
424          spin_lock(&obd->obd_dev_lock);
425          if (obd->obd_llog_ctxt[index] == NULL) {
426                  spin_unlock(&obd->obd_dev_lock);
427                  CDEBUG(D_INFO,"obd %p and ctxt index %d is NULL \n",obd,index);
428                  return NULL;
429          }
430          ctxt = llog_ctxt_get(obd->obd_llog_ctxt[index]);
431          spin_unlock(&obd->obd_dev_lock);
432          return ctxt;
433 }
434
435 static inline int llog_ctxt_null(struct obd_device *obd, int index)
436 {
437         return (obd->obd_llog_ctxt[index] == NULL);
438 }
439
440 static inline int llog_write_rec(struct llog_handle *handle,
441                                  struct llog_rec_hdr *rec,
442                                  struct llog_cookie *logcookies,
443                                  int numcookies, void *buf, int idx)
444 {
445         struct llog_operations *lop;
446         int raised, rc, buflen;
447         ENTRY;
448
449         rc = llog_handle2ops(handle, &lop);
450         if (rc)
451                 RETURN(rc);
452         if (lop->lop_write_rec == NULL)
453                 RETURN(-EOPNOTSUPP);
454
455         if (buf)
456                 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr)
457                                 + sizeof(struct llog_rec_tail);
458         else
459                 buflen = rec->lrh_len;
460         LASSERT(size_round(buflen) == buflen);
461
462         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
463         if (!raised)
464                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE); 
465         rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
466         if (!raised)
467                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE); 
468         RETURN(rc);
469 }
470
471 static inline int llog_read_header(struct llog_handle *handle)
472 {
473         struct llog_operations *lop;
474         int rc;
475         ENTRY;
476
477         rc = llog_handle2ops(handle, &lop);
478         if (rc)
479                 RETURN(rc);
480         if (lop->lop_read_header == NULL)
481                 RETURN(-EOPNOTSUPP);
482
483         rc = lop->lop_read_header(handle);
484         RETURN(rc);
485 }
486
487 static inline int llog_destroy(struct llog_handle *handle)
488 {
489         struct llog_operations *lop;
490         int rc;
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(handle);
500         RETURN(rc);
501 }
502
503 #if 0
504 static inline int llog_cancel(struct obd_export *exp,
505                               struct lov_stripe_md *lsm, int count,
506                               struct llog_cookie *cookies, int flags)
507 {
508         struct llog_operations *lop;
509         int rc;
510         ENTRY;
511
512         rc = llog_handle2ops(loghandle, &lop);
513         if (rc)
514                 RETURN(rc);
515         if (lop->lop_cancel == NULL)
516                 RETURN(-EOPNOTSUPP);
517
518         rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
519         RETURN(rc);
520 }
521 #endif
522
523 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
524                                   int next_idx, __u64 *cur_offset, void *buf,
525                                   int len)
526 {
527         struct llog_operations *lop;
528         int rc;
529         ENTRY;
530
531         rc = llog_handle2ops(loghandle, &lop);
532         if (rc)
533                 RETURN(rc);
534         if (lop->lop_next_block == NULL)
535                 RETURN(-EOPNOTSUPP);
536
537         rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
538                                  len);
539         RETURN(rc);
540 }
541
542 static inline int llog_prev_block(struct llog_handle *loghandle,
543                                   int prev_idx, void *buf, int len)
544 {
545         struct llog_operations *lop;
546         int rc;
547         ENTRY;
548
549         rc = llog_handle2ops(loghandle, &lop);
550         if (rc)
551                 RETURN(rc);
552         if (lop->lop_prev_block == NULL)
553                 RETURN(-EOPNOTSUPP);
554
555         rc = lop->lop_prev_block(loghandle, prev_idx, buf, len);
556         RETURN(rc);
557 }
558
559 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
560                               struct llog_logid *logid, char *name)
561 {
562         struct llog_operations *lop;
563         int raised, rc;
564         ENTRY;
565
566         rc = llog_obd2ops(ctxt, &lop);
567         if (rc)
568                 RETURN(rc);
569         if (lop->lop_create == NULL)
570                 RETURN(-EOPNOTSUPP);
571
572         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
573         if (!raised)
574                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
575         rc = lop->lop_create(ctxt, res, logid, name);
576         if (!raised)
577                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
578         RETURN(rc);
579 }
580
581 static inline int llog_connect(struct llog_ctxt *ctxt,
582                                struct llog_logid *logid, struct llog_gen *gen,
583                                struct obd_uuid *uuid)
584 {
585         struct llog_operations *lop;
586         int rc;
587         ENTRY;
588
589         rc = llog_obd2ops(ctxt, &lop);
590         if (rc)
591                 RETURN(rc);
592         if (lop->lop_connect == NULL)
593                 RETURN(-EOPNOTSUPP);
594
595         rc = lop->lop_connect(ctxt, logid, gen, uuid);
596         RETURN(rc);
597 }
598
599 #endif