lustre/include/lustre_mdc.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 /*
  31  * Copyright (c) 2012 Whamcloud, Inc.
  32  */
  33 /*
  34  * This file is part of Lustre, http://www.lustre.org/
  35  * Lustre is a trademark of Sun Microsystems, Inc.
  36  *
  37  * lustre/include/lustre_mdc.h
  38  *
  39  * MDS data structures.
  40  * See also lustre_idl.h for wire formats of requests.
  41  */
  42
  43 #ifndef _LUSTRE_MDC_H
  44 #define _LUSTRE_MDC_H
  45
  46 /** \defgroup mdc mdc
  47  *
  48  * @{
  49  */
  50
  51 #ifdef __KERNEL__
  52 # include <linux/fs.h>
  53 # include <linux/dcache.h>
  54 # ifdef CONFIG_FS_POSIX_ACL
  55 #  include <linux/posix_acl_xattr.h>
  56 # endif /* CONFIG_FS_POSIX_ACL */
  57 # include <linux/lustre_intent.h>
  58 #endif /* __KERNEL__ */
  59 #include <lustre_handles.h>
  60 #include <libcfs/libcfs.h>
  61 #include <obd_class.h>
  62 #include <lustre/lustre_idl.h>
  63 #include <lustre_lib.h>
  64 #include <lustre_dlm.h>
  65 #include <lustre_export.h>
  66
  67 struct ptlrpc_client;
  68 struct obd_export;
  69 struct ptlrpc_request;
  70 struct obd_device;
  71
  72 struct mdc_rpc_lock {
  73         struct mutex            rpcl_mutex;
  74         struct lookup_intent    *rpcl_it;
  75         int                     rpcl_fakes;
  76 };
  77
  78 #define MDC_FAKE_RPCL_IT ((void *)0x2c0012bfUL)
  79
  80 static inline void mdc_init_rpc_lock(struct mdc_rpc_lock *lck)
  81 {
  82         mutex_init(&lck->rpcl_mutex);
  83         lck->rpcl_it = NULL;
  84 }
  85
  86 static inline void mdc_get_rpc_lock(struct mdc_rpc_lock *lck,
  87                                     struct lookup_intent *it)
  88 {
  89         ENTRY;
  90
  91         if (it != NULL && (it->it_op == IT_GETATTR || it->it_op == IT_LOOKUP))
  92                 return;
  93
  94         /* This would normally block until the existing request finishes.
  95          * If fail_loc is set it will block until the regular request is
  96          * done, then set rpcl_it to MDC_FAKE_RPCL_IT.  Once that is set
  97          * it will only be cleared when all fake requests are finished.
  98          * Only when all fake requests are finished can normal requests
  99          * be sent, to ensure they are recoverable again. */
 100  again:
 101         mutex_lock(&lck->rpcl_mutex);
 102
 103         if (CFS_FAIL_CHECK_QUIET(OBD_FAIL_MDC_RPCS_SEM)) {
 104                 lck->rpcl_it = MDC_FAKE_RPCL_IT;
 105                 lck->rpcl_fakes++;
 106                 mutex_unlock(&lck->rpcl_mutex);
 107                 return;
 108         }
 109
 110         /* This will only happen when the CFS_FAIL_CHECK() was
 111          * just turned off but there are still requests in progress.
 112          * Wait until they finish.  It doesn't need to be efficient
 113          * in this extremely rare case, just have low overhead in
 114          * the common case when it isn't true. */
 115         while (unlikely(lck->rpcl_it == MDC_FAKE_RPCL_IT)) {
 116                 mutex_unlock(&lck->rpcl_mutex);
 117                 cfs_schedule_timeout(cfs_time_seconds(1) / 4);
 118                 goto again;
 119         }
 120
 121         LASSERT(lck->rpcl_it == NULL);
 122         lck->rpcl_it = it;
 123 }
 124
 125 static inline void mdc_put_rpc_lock(struct mdc_rpc_lock *lck,
 126                                     struct lookup_intent *it)
 127 {
 128         if (it != NULL && (it->it_op == IT_GETATTR || it->it_op == IT_LOOKUP))
 129                 goto out;
 130
 131         if (lck->rpcl_it == MDC_FAKE_RPCL_IT) { /* OBD_FAIL_MDC_RPCS_SEM */
 132                 mutex_lock(&lck->rpcl_mutex);
 133
 134                 LASSERTF(lck->rpcl_fakes > 0, "%d\n", lck->rpcl_fakes);
 135                 lck->rpcl_fakes--;
 136
 137                 if (lck->rpcl_fakes == 0)
 138                         lck->rpcl_it = NULL;
 139
 140         } else {
 141                 LASSERTF(it == lck->rpcl_it, "%p != %p\n", it, lck->rpcl_it);
 142                 lck->rpcl_it = NULL;
 143         }
 144
 145         mutex_unlock(&lck->rpcl_mutex);
 146  out:
 147         EXIT;
 148 }
 149
 150 static inline void mdc_update_max_ea_from_body(struct obd_export *exp,
 151                                                struct mdt_body *body)
 152 {
 153         if (body->valid & OBD_MD_FLMODEASIZE) {
 154                 if (exp->exp_obd->u.cli.cl_max_mds_easize < body->max_mdsize)
 155                         exp->exp_obd->u.cli.cl_max_mds_easize =
 156                                                 body->max_mdsize;
 157                 if (exp->exp_obd->u.cli.cl_max_mds_cookiesize <
 158                                                 body->max_cookiesize)
 159                         exp->exp_obd->u.cli.cl_max_mds_cookiesize =
 160                                                 body->max_cookiesize;
 161         }
 162 }
 163
 164
 165 struct mdc_cache_waiter {
 166         cfs_list_t              mcw_entry;
 167         cfs_waitq_t             mcw_waitq;
 168 };
 169
 170 /* mdc/mdc_locks.c */
 171 int it_disposition(struct lookup_intent *it, int flag);
 172 void it_clear_disposition(struct lookup_intent *it, int flag);
 173 void it_set_disposition(struct lookup_intent *it, int flag);
 174 int it_open_error(int phase, struct lookup_intent *it);
 175 #ifdef HAVE_SPLIT_SUPPORT
 176 int mdc_sendpage(struct obd_export *exp, const struct lu_fid *fid,
 177                  const struct page *page, int offset);
 178 #endif
 179
 180 /** @} mdc */
 181
 182 #endif