drivers/staging/lustre/lustre/include/lustre_export.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) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2015, 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 /** \defgroup obd_export PortalRPC export definitions
  37  *
  38  * @{
  39  */
  40
  41 #ifndef __EXPORT_H
  42 #define __EXPORT_H
  43
  44 /** \defgroup export export
  45  *
  46  * @{
  47  */
  48
  49 #include "lprocfs_status.h"
  50 #include "lustre/lustre_idl.h"
  51 #include "lustre_dlm.h"
  52
  53 enum obd_option {
  54         OBD_OPT_FORCE =  0x0001,
  55         OBD_OPT_FAILOVER =      0x0002,
  56         OBD_OPT_ABORT_RECOV =   0x0004,
  57 };
  58
  59 /**
  60  * Export structure. Represents target-side of connection in portals.
  61  * Also used in Lustre to connect between layers on the same node when
  62  * there is no network-connection in-between.
  63  * For every connected client there is an export structure on the server
  64  * attached to the same obd device.
  65  */
  66 struct obd_export {
  67         /**
  68          * Export handle, it's id is provided to client on connect
  69          * Subsequent client RPCs contain this handle id to identify
  70          * what export they are talking to.
  71          */
  72         struct portals_handle     exp_handle;
  73         atomic_t              exp_refcount;
  74         /**
  75          * Set of counters below is to track where export references are
  76          * kept. The exp_rpc_count is used for reconnect handling also,
  77          * the cb_count and locks_count are for debug purposes only for now.
  78          * The sum of them should be less than exp_refcount by 3
  79          */
  80         atomic_t              exp_rpc_count; /* RPC references */
  81         atomic_t              exp_cb_count; /* Commit callback references */
  82         /** Number of queued replay requests to be processes */
  83         atomic_t                  exp_replay_count;
  84         atomic_t              exp_locks_count; /** Lock references */
  85 #if LUSTRE_TRACKS_LOCK_EXP_REFS
  86         struct list_head                exp_locks_list;
  87         spinlock_t                exp_locks_list_guard;
  88 #endif
  89         /** UUID of client connected to this export */
  90         struct obd_uuid    exp_client_uuid;
  91         /** To link all exports on an obd device */
  92         struct list_head                exp_obd_chain;
  93         struct hlist_node         exp_uuid_hash; /** uuid-export hash*/
  94         /** Obd device of this export */
  95         struct obd_device       *exp_obd;
  96         /**
  97          * "reverse" import to send requests (e.g. from ldlm) back to client
  98          * exp_lock protect its change
  99          */
 100         struct obd_import       *exp_imp_reverse;
 101         struct lprocfs_stats     *exp_md_stats;
 102         /** Active connection */
 103         struct ptlrpc_connection *exp_connection;
 104         /** Connection count value from last successful reconnect rpc */
 105         __u32                exp_conn_cnt;
 106         /** Hash list of all ldlm locks granted on this export */
 107         struct cfs_hash        *exp_lock_hash;
 108         /**
 109          * Hash list for Posix lock deadlock detection, added with
 110          * ldlm_lock::l_exp_flock_hash.
 111          */
 112         struct cfs_hash        *exp_flock_hash;
 113         struct list_head                exp_outstanding_replies;
 114         struct list_head                exp_uncommitted_replies;
 115         spinlock_t                exp_uncommitted_replies_lock;
 116         /** Last committed transno for this export */
 117         __u64                exp_last_committed;
 118         /** On replay all requests waiting for replay are linked here */
 119         struct list_head                exp_req_replay_queue;
 120         /**
 121          * protects exp_flags, exp_outstanding_replies and the change
 122          * of exp_imp_reverse
 123          */
 124         spinlock_t                exp_lock;
 125         /** Compatibility flags for this export are embedded into
 126          *  exp_connect_data
 127          */
 128         struct obd_connect_data   exp_connect_data;
 129         enum obd_option    exp_flags;
 130         unsigned long        exp_failed:1,
 131                                   exp_disconnected:1,
 132                                   exp_connecting:1,
 133                                   exp_flvr_changed:1,
 134                                   exp_flvr_adapt:1;
 135         /* also protected by exp_lock */
 136         enum lustre_sec_part      exp_sp_peer;
 137         struct sptlrpc_flavor     exp_flvr;          /* current */
 138         struct sptlrpc_flavor     exp_flvr_old[2];      /* about-to-expire */
 139         time64_t                  exp_flvr_expire[2];   /* seconds */
 140
 141         /** protects exp_hp_rpcs */
 142         spinlock_t                exp_rpc_lock;
 143         struct list_head                  exp_hp_rpcs;  /* (potential) HP RPCs */
 144
 145         /** blocking dlm lock list, protected by exp_bl_list_lock */
 146         struct list_head                exp_bl_list;
 147         spinlock_t                exp_bl_list_lock;
 148 };
 149
 150 static inline __u64 *exp_connect_flags_ptr(struct obd_export *exp)
 151 {
 152         return &exp->exp_connect_data.ocd_connect_flags;
 153 }
 154
 155 static inline __u64 exp_connect_flags(struct obd_export *exp)
 156 {
 157         return *exp_connect_flags_ptr(exp);
 158 }
 159
 160 static inline int exp_max_brw_size(struct obd_export *exp)
 161 {
 162         if (exp_connect_flags(exp) & OBD_CONNECT_BRW_SIZE)
 163                 return exp->exp_connect_data.ocd_brw_size;
 164
 165         return ONE_MB_BRW_SIZE;
 166 }
 167
 168 static inline int exp_connect_multibulk(struct obd_export *exp)
 169 {
 170         return exp_max_brw_size(exp) > ONE_MB_BRW_SIZE;
 171 }
 172
 173 static inline int exp_connect_cancelset(struct obd_export *exp)
 174 {
 175         return !!(exp_connect_flags(exp) & OBD_CONNECT_CANCELSET);
 176 }
 177
 178 static inline int exp_connect_lru_resize(struct obd_export *exp)
 179 {
 180         return !!(exp_connect_flags(exp) & OBD_CONNECT_LRU_RESIZE);
 181 }
 182
 183 static inline int exp_connect_rmtclient(struct obd_export *exp)
 184 {
 185         return !!(exp_connect_flags(exp) & OBD_CONNECT_RMT_CLIENT);
 186 }
 187
 188 static inline int client_is_remote(struct obd_export *exp)
 189 {
 190         struct obd_import *imp = class_exp2cliimp(exp);
 191
 192         return !!(imp->imp_connect_data.ocd_connect_flags &
 193                   OBD_CONNECT_RMT_CLIENT);
 194 }
 195
 196 static inline int exp_connect_vbr(struct obd_export *exp)
 197 {
 198         return !!(exp_connect_flags(exp) & OBD_CONNECT_VBR);
 199 }
 200
 201 static inline int exp_connect_som(struct obd_export *exp)
 202 {
 203         return !!(exp_connect_flags(exp) & OBD_CONNECT_SOM);
 204 }
 205
 206 static inline int exp_connect_umask(struct obd_export *exp)
 207 {
 208         return !!(exp_connect_flags(exp) & OBD_CONNECT_UMASK);
 209 }
 210
 211 static inline int imp_connect_lru_resize(struct obd_import *imp)
 212 {
 213         struct obd_connect_data *ocd;
 214
 215         ocd = &imp->imp_connect_data;
 216         return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
 217 }
 218
 219 static inline int exp_connect_layout(struct obd_export *exp)
 220 {
 221         return !!(exp_connect_flags(exp) & OBD_CONNECT_LAYOUTLOCK);
 222 }
 223
 224 static inline bool exp_connect_lvb_type(struct obd_export *exp)
 225 {
 226         if (exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE)
 227                 return true;
 228         else
 229                 return false;
 230 }
 231
 232 static inline bool imp_connect_lvb_type(struct obd_import *imp)
 233 {
 234         struct obd_connect_data *ocd;
 235
 236         ocd = &imp->imp_connect_data;
 237         if (ocd->ocd_connect_flags & OBD_CONNECT_LVB_TYPE)
 238                 return true;
 239         else
 240                 return false;
 241 }
 242
 243 static inline __u64 exp_connect_ibits(struct obd_export *exp)
 244 {
 245         struct obd_connect_data *ocd;
 246
 247         ocd = &exp->exp_connect_data;
 248         return ocd->ocd_ibits_known;
 249 }
 250
 251 static inline bool imp_connect_disp_stripe(struct obd_import *imp)
 252 {
 253         struct obd_connect_data *ocd;
 254
 255         ocd = &imp->imp_connect_data;
 256         return ocd->ocd_connect_flags & OBD_CONNECT_DISP_STRIPE;
 257 }
 258
 259 struct obd_export *class_conn2export(struct lustre_handle *conn);
 260
 261 #define KKUC_CT_DATA_MAGIC      0x092013cea
 262 struct kkuc_ct_data {
 263         __u32           kcd_magic;
 264         struct obd_uuid kcd_uuid;
 265         __u32           kcd_archive;
 266 };
 267
 268 /** @} export */
 269
 270 #endif /* __EXPORT_H */
 271 /** @} obd_export */