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, 2012, 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 struct mds_client_data;
54 struct mdt_client_data;
55 struct mds_idmap_table;
56 struct mdt_idmap_table;
57
58 /**
59 * Target-specific export data
60 */
61 struct tg_export_data {
62 /** Protects led_lcd below */
63 struct mutex ted_lcd_lock;
64 /** Per-client data for each export */
65 struct lsd_client_data *ted_lcd;
66 /** Offset of record in last_rcvd file */
67 loff_t ted_lr_off;
68 /** Client index in last_rcvd file */
69 int ted_lr_idx;
70 };
71
72 /**
73 * MDT-specific export data
74 */
75 struct mdt_export_data {
76 struct tg_export_data med_ted;
77 /** List of all files opened by client on this MDT */
78 struct list_head med_open_head;
79 spinlock_t med_open_lock; /* med_open_head, mfd_list */
80 /** Bitmask of all ibit locks this MDT understands */
81 __u64 med_ibits_known;
82 struct mutex med_idmap_mutex;
83 struct lustre_idmap_table *med_idmap;
84 };
85
86 struct ec_export_data { /* echo client */
87 struct list_head eced_locks;
88 };
89
90 /* In-memory access to client data from OST struct */
91 /** Filter (oss-side) specific import data */
92 struct filter_export_data {
93 struct tg_export_data fed_ted;
94 spinlock_t fed_lock; /**< protects fed_mod_list */
95 long fed_dirty; /* in bytes */
96 long fed_grant; /* in bytes */
97 struct list_head fed_mod_list; /* files being modified */
98 int fed_mod_count;/* items in fed_writing list */
99 long fed_pending; /* bytes just being written */
100 __u32 fed_group;
101 __u8 fed_pagesize; /* log2 of client page size */
102 };
103
104 struct mgs_export_data {
105 struct list_head med_clients; /* mgc fs client via this exp */
106 spinlock_t med_lock; /* protect med_clients */
107 };
108
109 enum obd_option {
110 OBD_OPT_FORCE = 0x0001,
111 OBD_OPT_FAILOVER = 0x0002,
112 OBD_OPT_ABORT_RECOV = 0x0004,
113 };
114
115 /**
116 * Export structure. Represents target-side of connection in portals.
117 * Also used in Lustre to connect between layers on the same node when
118 * there is no network-connection in-between.
119 * For every connected client there is an export structure on the server
120 * attached to the same obd device.
121 */
122 struct obd_export {
123 /**
124 * Export handle, it's id is provided to client on connect
125 * Subsequent client RPCs contain this handle id to identify
126 * what export they are talking to.
127 */
128 struct portals_handle exp_handle;
129 atomic_t exp_refcount;
130 /**
131 * Set of counters below is to track where export references are
132 * kept. The exp_rpc_count is used for reconnect handling also,
133 * the cb_count and locks_count are for debug purposes only for now.
134 * The sum of them should be less than exp_refcount by 3
135 */
136 atomic_t exp_rpc_count; /* RPC references */
137 atomic_t exp_cb_count; /* Commit callback references */
138 /** Number of queued replay requests to be processes */
139 atomic_t exp_replay_count;
140 atomic_t exp_locks_count; /** Lock references */
141 #if LUSTRE_TRACKS_LOCK_EXP_REFS
142 struct list_head exp_locks_list;
143 spinlock_t exp_locks_list_guard;
144 #endif
145 /** UUID of client connected to this export */
146 struct obd_uuid exp_client_uuid;
147 /** To link all exports on an obd device */
148 struct list_head exp_obd_chain;
149 struct hlist_node exp_uuid_hash; /** uuid-export hash*/
150 /** Obd device of this export */
151 struct obd_device *exp_obd;
152 /**
153 * "reverse" import to send requests (e.g. from ldlm) back to client
154 * exp_lock protect its change
155 */
156 struct obd_import *exp_imp_reverse;
157 struct lprocfs_stats *exp_md_stats;
158 /** Active connection */
159 struct ptlrpc_connection *exp_connection;
160 /** Connection count value from last successful reconnect rpc */
161 __u32 exp_conn_cnt;
162 /** Hash list of all ldlm locks granted on this export */
163 struct cfs_hash *exp_lock_hash;
164 /**
165 * Hash list for Posix lock deadlock detection, added with
166 * ldlm_lock::l_exp_flock_hash.
167 */
168 struct cfs_hash *exp_flock_hash;
169 struct list_head exp_outstanding_replies;
170 struct list_head exp_uncommitted_replies;
171 spinlock_t exp_uncommitted_replies_lock;
172 /** Last committed transno for this export */
173 __u64 exp_last_committed;
174 /** On replay all requests waiting for replay are linked here */
175 struct list_head exp_req_replay_queue;
176 /**
177 * protects exp_flags, exp_outstanding_replies and the change
178 * of exp_imp_reverse
179 */
180 spinlock_t exp_lock;
181 /** Compatibility flags for this export are embedded into
182 * exp_connect_data */
183 struct obd_connect_data exp_connect_data;
184 enum obd_option exp_flags;
185 unsigned long exp_failed:1,
186 exp_disconnected:1,
187 exp_connecting:1,
188 exp_flvr_changed:1,
189 exp_flvr_adapt:1;
190 /* also protected by exp_lock */
191 enum lustre_sec_part exp_sp_peer;
192 struct sptlrpc_flavor exp_flvr; /* current */
193 struct sptlrpc_flavor exp_flvr_old[2]; /* about-to-expire */
194 time64_t exp_flvr_expire[2]; /* seconds */
195
196 /** protects exp_hp_rpcs */
197 spinlock_t exp_rpc_lock;
198 struct list_head exp_hp_rpcs; /* (potential) HP RPCs */
199
200 /** blocking dlm lock list, protected by exp_bl_list_lock */
201 struct list_head exp_bl_list;
202 spinlock_t exp_bl_list_lock;
203
204 /** Target specific data */
205 union {
206 struct tg_export_data eu_target_data;
207 struct mdt_export_data eu_mdt_data;
208 struct filter_export_data eu_filter_data;
209 struct ec_export_data eu_ec_data;
210 struct mgs_export_data eu_mgs_data;
211 } u;
212 };
213
214 #define exp_target_data u.eu_target_data
215 #define exp_mdt_data u.eu_mdt_data
216 #define exp_filter_data u.eu_filter_data
217 #define exp_ec_data u.eu_ec_data
218
exp_connect_flags_ptr(struct obd_export * exp)219 static inline __u64 *exp_connect_flags_ptr(struct obd_export *exp)
220 {
221 return &exp->exp_connect_data.ocd_connect_flags;
222 }
223
exp_connect_flags(struct obd_export * exp)224 static inline __u64 exp_connect_flags(struct obd_export *exp)
225 {
226 return *exp_connect_flags_ptr(exp);
227 }
228
exp_max_brw_size(struct obd_export * exp)229 static inline int exp_max_brw_size(struct obd_export *exp)
230 {
231 LASSERT(exp != NULL);
232 if (exp_connect_flags(exp) & OBD_CONNECT_BRW_SIZE)
233 return exp->exp_connect_data.ocd_brw_size;
234
235 return ONE_MB_BRW_SIZE;
236 }
237
exp_connect_multibulk(struct obd_export * exp)238 static inline int exp_connect_multibulk(struct obd_export *exp)
239 {
240 return exp_max_brw_size(exp) > ONE_MB_BRW_SIZE;
241 }
242
exp_connect_cancelset(struct obd_export * exp)243 static inline int exp_connect_cancelset(struct obd_export *exp)
244 {
245 LASSERT(exp != NULL);
246 return !!(exp_connect_flags(exp) & OBD_CONNECT_CANCELSET);
247 }
248
exp_connect_lru_resize(struct obd_export * exp)249 static inline int exp_connect_lru_resize(struct obd_export *exp)
250 {
251 LASSERT(exp != NULL);
252 return !!(exp_connect_flags(exp) & OBD_CONNECT_LRU_RESIZE);
253 }
254
exp_connect_rmtclient(struct obd_export * exp)255 static inline int exp_connect_rmtclient(struct obd_export *exp)
256 {
257 LASSERT(exp != NULL);
258 return !!(exp_connect_flags(exp) & OBD_CONNECT_RMT_CLIENT);
259 }
260
client_is_remote(struct obd_export * exp)261 static inline int client_is_remote(struct obd_export *exp)
262 {
263 struct obd_import *imp = class_exp2cliimp(exp);
264
265 return !!(imp->imp_connect_data.ocd_connect_flags &
266 OBD_CONNECT_RMT_CLIENT);
267 }
268
exp_connect_vbr(struct obd_export * exp)269 static inline int exp_connect_vbr(struct obd_export *exp)
270 {
271 LASSERT(exp != NULL);
272 LASSERT(exp->exp_connection);
273 return !!(exp_connect_flags(exp) & OBD_CONNECT_VBR);
274 }
275
exp_connect_som(struct obd_export * exp)276 static inline int exp_connect_som(struct obd_export *exp)
277 {
278 LASSERT(exp != NULL);
279 return !!(exp_connect_flags(exp) & OBD_CONNECT_SOM);
280 }
281
exp_connect_umask(struct obd_export * exp)282 static inline int exp_connect_umask(struct obd_export *exp)
283 {
284 return !!(exp_connect_flags(exp) & OBD_CONNECT_UMASK);
285 }
286
imp_connect_lru_resize(struct obd_import * imp)287 static inline int imp_connect_lru_resize(struct obd_import *imp)
288 {
289 struct obd_connect_data *ocd;
290
291 LASSERT(imp != NULL);
292 ocd = &imp->imp_connect_data;
293 return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
294 }
295
exp_connect_layout(struct obd_export * exp)296 static inline int exp_connect_layout(struct obd_export *exp)
297 {
298 return !!(exp_connect_flags(exp) & OBD_CONNECT_LAYOUTLOCK);
299 }
300
exp_connect_lvb_type(struct obd_export * exp)301 static inline bool exp_connect_lvb_type(struct obd_export *exp)
302 {
303 LASSERT(exp != NULL);
304 if (exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE)
305 return true;
306 else
307 return false;
308 }
309
imp_connect_lvb_type(struct obd_import * imp)310 static inline bool imp_connect_lvb_type(struct obd_import *imp)
311 {
312 struct obd_connect_data *ocd;
313
314 LASSERT(imp != NULL);
315 ocd = &imp->imp_connect_data;
316 if (ocd->ocd_connect_flags & OBD_CONNECT_LVB_TYPE)
317 return true;
318 else
319 return false;
320 }
321
exp_connect_ibits(struct obd_export * exp)322 static inline __u64 exp_connect_ibits(struct obd_export *exp)
323 {
324 struct obd_connect_data *ocd;
325
326 ocd = &exp->exp_connect_data;
327 return ocd->ocd_ibits_known;
328 }
329
imp_connect_disp_stripe(struct obd_import * imp)330 static inline bool imp_connect_disp_stripe(struct obd_import *imp)
331 {
332 struct obd_connect_data *ocd;
333
334 LASSERT(imp != NULL);
335 ocd = &imp->imp_connect_data;
336 return ocd->ocd_connect_flags & OBD_CONNECT_DISP_STRIPE;
337 }
338
339 struct obd_export *class_conn2export(struct lustre_handle *conn);
340
341 /** @} export */
342
343 #endif /* __EXPORT_H */
344 /** @} obd_export */
345