Whamcloud - gitweb
b=20607 Correct the refcount of lov_request_set
[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 obd_llog_init(struct obd_device *obd, struct obd_device *disk_obd,
186                   int *idx);
187
188 int obd_llog_finish(struct obd_device *obd, int count);
189
190 /* llog_ioctl.c */
191 int llog_ioctl(struct llog_ctxt *ctxt, int cmd, struct obd_ioctl_data *data);
192 int llog_catalog_list(struct obd_device *obd, int count,
193                       struct obd_ioctl_data *data);
194
195 /* llog_net.c */
196 int llog_initiator_connect(struct llog_ctxt *ctxt);
197 int llog_receptor_accept(struct llog_ctxt *ctxt, struct obd_import *imp);
198 int llog_origin_connect(struct llog_ctxt *ctxt,
199                         struct llog_logid *logid, struct llog_gen *gen,
200                         struct obd_uuid *uuid);
201 int llog_handle_connect(struct ptlrpc_request *req);
202
203 /* recov_thread.c */
204 int llog_obd_repl_cancel(struct llog_ctxt *ctxt,
205                          struct lov_stripe_md *lsm, int count,
206                          struct llog_cookie *cookies, int flags);
207 int llog_obd_repl_sync(struct llog_ctxt *ctxt, struct obd_export *exp);
208 int llog_obd_repl_connect(struct llog_ctxt *ctxt,
209                           struct llog_logid *logid, struct llog_gen *gen,
210                           struct obd_uuid *uuid);
211
212 struct llog_operations {
213         int (*lop_write_rec)(struct llog_handle *loghandle,
214                              struct llog_rec_hdr *rec,
215                              struct llog_cookie *logcookies, int numcookies,
216                              void *, int idx);
217         int (*lop_destroy)(struct llog_handle *handle);
218         int (*lop_next_block)(struct llog_handle *h, int *curr_idx,
219                               int next_idx, __u64 *offset, void *buf, int len);
220         int (*lop_prev_block)(struct llog_handle *h,
221                               int prev_idx, void *buf, int len);
222         int (*lop_create)(struct llog_ctxt *ctxt, struct llog_handle **,
223                           struct llog_logid *logid, char *name);
224         int (*lop_close)(struct llog_handle *handle);
225         int (*lop_read_header)(struct llog_handle *handle);
226
227         int (*lop_setup)(struct obd_device *obd, int ctxt_idx,
228                          struct obd_device *disk_obd, int count,
229                          struct llog_logid *logid);
230         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp);
231         int (*lop_cleanup)(struct llog_ctxt *ctxt);
232         int (*lop_add)(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
233                        struct lov_stripe_md *lsm,
234                        struct llog_cookie *logcookies, int numcookies);
235         int (*lop_cancel)(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm,
236                           int count, struct llog_cookie *cookies, int flags);
237         int (*lop_connect)(struct llog_ctxt *ctxt,
238                            struct llog_logid *logid, struct llog_gen *gen,
239                            struct obd_uuid *uuid);
240         /* XXX add 2 more: commit callbacks and llog recovery functions */
241 };
242
243 /* llog_lvfs.c */
244 extern struct llog_operations llog_lvfs_ops;
245 int llog_get_cat_list(struct obd_device *obd, struct obd_device *disk_obd,
246                       char *name, int idx, int count,
247                       struct llog_catid *idarray);
248
249 int llog_put_cat_list(struct obd_device *obd, struct obd_device *disk_obd,
250                       char *name, int idx, int count, struct llog_catid *idarray);
251
252 #define LLOG_CTXT_FLAG_UNINITIALIZED     0x00000001
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         long                     loc_flags; /* flags, see above defines */
269 };
270
271 #define LCM_NAME_SIZE 64
272
273 struct llog_commit_master {
274         /**
275          * Thread control flags (start, stop, etc.)
276          */
277         long                       lcm_flags;
278         /**
279          * Number of llcds onthis lcm.
280          */
281         atomic_t                   lcm_count;
282         /**
283          * Thread control structure. Used for control commit thread.
284          */
285         struct ptlrpcd_ctl         lcm_pc;
286         /**
287          * Lock protecting list of llcds.
288          */
289         spinlock_t                 lcm_lock;
290         /**
291          * Llcds in flight for debugging purposes.
292          */
293         struct list_head           lcm_llcds;
294         /**
295          * Commit thread name buffer. Only used for thread start.
296          */
297         char                       lcm_name[LCM_NAME_SIZE];
298 };
299
300 struct llog_canceld_ctxt {
301         /**
302          * Llog context this llcd is attached to. Used for accessing
303          * ->loc_import and others in process of canceling cookies
304          * gathered in this llcd.
305          */
306         struct llog_ctxt          *llcd_ctxt;
307         /**
308          * Cancel thread control stucture pointer. Used for accessing
309          * it to see if should stop processing and other needs.
310          */
311         struct llog_commit_master *llcd_lcm;
312         /**
313          * Maximal llcd size. Used in calculations on how much of room
314          * left in llcd to cookie comming cookies.
315          */
316         int                        llcd_size;
317         /**
318          * Link to lcm llcds list.
319          */
320         struct list_head           llcd_list;
321         /**
322          * Current llcd size while gathering cookies. This should not be
323          * more than ->llcd_size. Used for determining if we need to
324          * send this llcd (if full) and allocate new one. This is also
325          * used for copying new cookie at the end of buffer.
326          */
327         int                        llcd_cookiebytes;
328         /**
329          * Pointer to the start of cookies buffer.
330          */
331         struct llog_cookie         llcd_cookies[0];
332 };
333
334 /* ptlrpc/recov_thread.c */
335 extern struct llog_commit_master *llog_recov_thread_init(char *name);
336 extern void llog_recov_thread_fini(struct llog_commit_master *lcm, 
337                                    int force);
338 extern int llog_recov_thread_start(struct llog_commit_master *lcm);
339 extern void llog_recov_thread_stop(struct llog_commit_master *lcm, 
340                                    int force);
341
342 static inline void llog_gen_init(struct llog_ctxt *ctxt)
343 {
344         struct obd_device *obd = ctxt->loc_exp->exp_obd;
345
346         if (!strcmp(obd->obd_type->typ_name, LUSTRE_MDS_NAME))
347                 ctxt->loc_gen.mnt_cnt = obd->u.mds.mds_mount_count;
348         else if (!strstr(obd->obd_type->typ_name, LUSTRE_OST_NAME))
349                 ctxt->loc_gen.mnt_cnt = obd->u.filter.fo_mount_count;
350         else
351                 ctxt->loc_gen.mnt_cnt = 0;
352 }
353
354 static inline int llog_gen_lt(struct llog_gen a, struct llog_gen b)
355 {
356         if (a.mnt_cnt < b.mnt_cnt)
357                 return 1;
358         if (a.mnt_cnt > b.mnt_cnt)
359                 return 0;
360         return(a.conn_cnt < b.conn_cnt ? 1 : 0);
361 }
362
363 #define LLOG_GEN_INC(gen)  ((gen).conn_cnt ++)
364 #define LLOG_PROC_BREAK 0x0001
365 #define LLOG_DEL_RECORD 0x0002
366
367 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
368                                struct llog_operations **lop)
369 {
370         if (ctxt == NULL)
371                 return -ENOTCONN;
372
373         *lop = ctxt->loc_logops;
374         if (*lop == NULL)
375                 return -EOPNOTSUPP;
376
377         return 0;
378 }
379
380 static inline int llog_handle2ops(struct llog_handle *loghandle,
381                                   struct llog_operations **lop)
382 {
383         if (loghandle == NULL)
384                 return -EINVAL;
385
386         return llog_obd2ops(loghandle->lgh_ctxt, lop);
387 }
388
389 static inline int llog_data_len(int len)
390 {
391         return size_round(len);
392 }
393
394 #define llog_ctxt_get(ctxt)                                                 \
395 ({                                                                          \
396          struct llog_ctxt *ctxt_ = ctxt;                                    \
397          LASSERT(atomic_read(&ctxt_->loc_refcount) > 0);                    \
398          atomic_inc(&ctxt_->loc_refcount);                                  \
399          CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt_,       \
400                 atomic_read(&ctxt_->loc_refcount));                         \
401          ctxt_;                                                             \
402 })
403  
404 #define llog_ctxt_put(ctxt)                                                 \
405 do {                                                                        \
406          if ((ctxt) == NULL)                                                \
407                  break;                                                     \
408          LASSERT(atomic_read(&(ctxt)->loc_refcount) > 0);                   \
409          LASSERT(atomic_read(&(ctxt)->loc_refcount) < 0x5a5a5a);            \
410          CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", (ctxt),      \
411                 atomic_read(&(ctxt)->loc_refcount) - 1);                    \
412          __llog_ctxt_put(ctxt);                                             \
413 } while (0)
414
415 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
416                                                    int index)
417 {
418          struct llog_ctxt *ctxt;
419
420          if (index < 0 || index >= LLOG_MAX_CTXTS) {
421                  CDEBUG(D_INFO, "obd %p bad index %d\n", obd, index);
422                  return NULL;
423          }
424
425          spin_lock(&obd->obd_dev_lock);
426          if (obd->obd_llog_ctxt[index] == NULL) {
427                  spin_unlock(&obd->obd_dev_lock);
428                  CDEBUG(D_INFO,"obd %p and ctxt index %d is NULL \n",obd,index);
429                  return NULL;
430          }
431          ctxt = llog_ctxt_get(obd->obd_llog_ctxt[index]);
432          spin_unlock(&obd->obd_dev_lock);
433          return ctxt;
434 }
435
436 static inline int llog_ctxt_null(struct obd_device *obd, int index)
437 {
438         return (obd->obd_llog_ctxt[index] == NULL);
439 }
440
441 static inline int llog_write_rec(struct llog_handle *handle,
442                                  struct llog_rec_hdr *rec,
443                                  struct llog_cookie *logcookies,
444                                  int numcookies, void *buf, int idx)
445 {
446         struct llog_operations *lop;
447         int raised, rc, buflen;
448         ENTRY;
449
450         rc = llog_handle2ops(handle, &lop);
451         if (rc)
452                 RETURN(rc);
453         if (lop->lop_write_rec == NULL)
454                 RETURN(-EOPNOTSUPP);
455
456         if (buf)
457                 buflen = rec->lrh_len + sizeof(struct llog_rec_hdr)
458                                 + sizeof(struct llog_rec_tail);
459         else
460                 buflen = rec->lrh_len;
461         LASSERT(size_round(buflen) == buflen);
462
463         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
464         if (!raised)
465                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE); 
466         rc = lop->lop_write_rec(handle, rec, logcookies, numcookies, buf, idx);
467         if (!raised)
468                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE); 
469         RETURN(rc);
470 }
471
472 static inline int llog_read_header(struct llog_handle *handle)
473 {
474         struct llog_operations *lop;
475         int rc;
476         ENTRY;
477
478         rc = llog_handle2ops(handle, &lop);
479         if (rc)
480                 RETURN(rc);
481         if (lop->lop_read_header == NULL)
482                 RETURN(-EOPNOTSUPP);
483
484         rc = lop->lop_read_header(handle);
485         RETURN(rc);
486 }
487
488 static inline int llog_destroy(struct llog_handle *handle)
489 {
490         struct llog_operations *lop;
491         int rc;
492         ENTRY;
493
494         rc = llog_handle2ops(handle, &lop);
495         if (rc)
496                 RETURN(rc);
497         if (lop->lop_destroy == NULL)
498                 RETURN(-EOPNOTSUPP);
499
500         rc = lop->lop_destroy(handle);
501         RETURN(rc);
502 }
503
504 #if 0
505 static inline int llog_cancel(struct obd_export *exp,
506                               struct lov_stripe_md *lsm, int count,
507                               struct llog_cookie *cookies, int flags)
508 {
509         struct llog_operations *lop;
510         int rc;
511         ENTRY;
512
513         rc = llog_handle2ops(loghandle, &lop);
514         if (rc)
515                 RETURN(rc);
516         if (lop->lop_cancel == NULL)
517                 RETURN(-EOPNOTSUPP);
518
519         rc = lop->lop_cancel(exp, lsm, count, cookies, flags);
520         RETURN(rc);
521 }
522 #endif
523
524 static inline int llog_next_block(struct llog_handle *loghandle, int *cur_idx,
525                                   int next_idx, __u64 *cur_offset, void *buf,
526                                   int len)
527 {
528         struct llog_operations *lop;
529         int rc;
530         ENTRY;
531
532         rc = llog_handle2ops(loghandle, &lop);
533         if (rc)
534                 RETURN(rc);
535         if (lop->lop_next_block == NULL)
536                 RETURN(-EOPNOTSUPP);
537
538         rc = lop->lop_next_block(loghandle, cur_idx, next_idx, cur_offset, buf,
539                                  len);
540         RETURN(rc);
541 }
542
543 static inline int llog_prev_block(struct llog_handle *loghandle,
544                                   int prev_idx, void *buf, int len)
545 {
546         struct llog_operations *lop;
547         int rc;
548         ENTRY;
549
550         rc = llog_handle2ops(loghandle, &lop);
551         if (rc)
552                 RETURN(rc);
553         if (lop->lop_prev_block == NULL)
554                 RETURN(-EOPNOTSUPP);
555
556         rc = lop->lop_prev_block(loghandle, prev_idx, buf, len);
557         RETURN(rc);
558 }
559
560 static inline int llog_create(struct llog_ctxt *ctxt, struct llog_handle **res,
561                               struct llog_logid *logid, char *name)
562 {
563         struct llog_operations *lop;
564         int raised, rc;
565         ENTRY;
566
567         rc = llog_obd2ops(ctxt, &lop);
568         if (rc)
569                 RETURN(rc);
570         if (lop->lop_create == NULL)
571                 RETURN(-EOPNOTSUPP);
572
573         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
574         if (!raised)
575                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
576         rc = lop->lop_create(ctxt, res, logid, name);
577         if (!raised)
578                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
579         RETURN(rc);
580 }
581
582 static inline int llog_connect(struct llog_ctxt *ctxt,
583                                struct llog_logid *logid, struct llog_gen *gen,
584                                struct obd_uuid *uuid)
585 {
586         struct llog_operations *lop;
587         int rc;
588         ENTRY;
589
590         rc = llog_obd2ops(ctxt, &lop);
591         if (rc)
592                 RETURN(rc);
593         if (lop->lop_connect == NULL)
594                 RETURN(-EOPNOTSUPP);
595
596         rc = lop->lop_connect(ctxt, logid, gen, uuid);
597         RETURN(rc);
598 }
599
600 #endif