4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef __LNET_TYPES_H__
38 #define __LNET_TYPES_H__
43 #include <libcfs/types.h>
45 /** \addtogroup lnet_addr
48 /** Portal reserved for LNet's own use.
49 * \see lustre/include/lustre/lustre_idl.h for Lustre portal assignments.
51 #define LNET_RESERVED_PORTAL 0
54 * Address of an end-point in an LNet network.
56 * A node can have multiple end-points and hence multiple addresses.
57 * An LNet network can be a simple network (e.g. tcp0) or a network of
58 * LNet networks connected by LNet routers. Therefore an end-point address
59 * has two parts: network ID, and address within a network.
61 * \see LNET_NIDNET, LNET_NIDADDR, and LNET_MKNID.
63 typedef __u64 lnet_nid_t;
65 * ID of a process in a node. Shortened as PID to distinguish from
66 * lnet_process_id_t, the global process ID.
68 typedef __u32 lnet_pid_t;
70 /** wildcard NID that matches any end-point address */
71 #define LNET_NID_ANY ((lnet_nid_t) -1)
72 /** wildcard PID that matches any lnet_pid_t */
73 #define LNET_PID_ANY ((lnet_pid_t) -1)
75 #define LNET_PID_RESERVED 0xf0000000 /* reserved bits in PID */
76 #define LNET_PID_USERFLAG 0x80000000 /* set in userspace peers */
78 #define LNET_TIME_FOREVER (-1)
80 /* how an LNET NID encodes net:address */
81 /** extract the address part of an lnet_nid_t */
83 static inline __u32 LNET_NIDADDR(lnet_nid_t nid)
85 return nid & 0xffffffff;
88 static inline __u32 LNET_NIDNET(lnet_nid_t nid)
90 return (nid >> 32) & 0xffffffff;
93 static inline lnet_nid_t LNET_MKNID(__u32 net, __u32 addr)
95 return (((__u64)net) << 32) | addr;
98 static inline __u32 LNET_NETNUM(__u32 net)
103 static inline __u32 LNET_NETTYP(__u32 net)
105 return (net >> 16) & 0xffff;
108 static inline __u32 LNET_MKNET(__u32 type, __u32 num)
110 return (type << 16) | num;
114 * Objects maintained by the LNet are accessed through handles. Handle types
115 * have names of the form lnet_handle_xx_t, where xx is one of the two letter
116 * object type codes ('eq' for event queue, 'md' for memory descriptor, and
117 * 'me' for match entry).
118 * Each type of object is given a unique handle type to enhance type checking.
119 * The type lnet_handle_any_t can be used when a generic handle is needed.
120 * Every handle value can be converted into a value of type lnet_handle_any_t
121 * without loss of information.
127 typedef lnet_handle_any_t lnet_handle_eq_t;
128 typedef lnet_handle_any_t lnet_handle_md_t;
129 typedef lnet_handle_any_t lnet_handle_me_t;
131 #define LNET_WIRE_HANDLE_COOKIE_NONE (-1)
134 * Invalidate handle \a h.
136 static inline void LNetInvalidateHandle(lnet_handle_any_t *h)
138 h->cookie = LNET_WIRE_HANDLE_COOKIE_NONE;
142 * Compare handles \a h1 and \a h2.
144 * \return 1 if handles are equal, 0 if otherwise.
146 static inline int LNetHandleIsEqual (lnet_handle_any_t h1, lnet_handle_any_t h2)
148 return (h1.cookie == h2.cookie);
152 * Check whether handle \a h is invalid.
154 * \return 1 if handle is invalid, 0 if valid.
156 static inline int LNetHandleIsInvalid(lnet_handle_any_t h)
158 return (LNET_WIRE_HANDLE_COOKIE_NONE == h.cookie);
172 /** \addtogroup lnet_me
176 * Specifies whether the match entry or memory descriptor should be unlinked
177 * automatically (LNET_UNLINK) or not (LNET_RETAIN).
185 * Values of the type lnet_ins_pos_t are used to control where a new match
186 * entry is inserted. The value LNET_INS_BEFORE is used to insert the new
187 * entry before the current entry or before the head of the list. The value
188 * LNET_INS_AFTER is used to insert the new entry after the current entry
189 * or after the last item in the list.
192 /** insert ME before current position or head of the list */
194 /** insert ME after current position or tail of the list */
196 /** attach ME at tail of local CPU partition ME list */
202 /** \addtogroup lnet_md
206 * Defines the visible parts of a memory descriptor. Values of this type
207 * are used to initialize memory descriptors.
211 * Specify the memory region associated with the memory descriptor.
212 * If the options field has:
213 * - LNET_MD_KIOV bit set: The start field points to the starting
214 * address of an array of lnet_kiov_t and the length field specifies
215 * the number of entries in the array. The length can't be bigger
216 * than LNET_MAX_IOV. The lnet_kiov_t is used to describe page-based
217 * fragments that are not necessarily mapped in virtal memory.
218 * - LNET_MD_IOVEC bit set: The start field points to the starting
219 * address of an array of struct iovec and the length field specifies
220 * the number of entries in the array. The length can't be bigger
221 * than LNET_MAX_IOV. The struct iovec is used to describe fragments
222 * that have virtual addresses.
223 * - Otherwise: The memory region is contiguous. The start field
224 * specifies the starting address for the memory region and the
225 * length field specifies its length.
227 * When the memory region is fragmented, all fragments but the first
228 * one must start on page boundary, and all but the last must end on
234 * Specifies the maximum number of operations that can be performed
235 * on the memory descriptor. An operation is any action that could
236 * possibly generate an event. In the usual case, the threshold value
237 * is decremented for each operation on the MD. When the threshold
238 * drops to zero, the MD becomes inactive and does not respond to
239 * operations. A threshold value of LNET_MD_THRESH_INF indicates that
240 * there is no bound on the number of operations that may be applied
245 * Specifies the largest incoming request that the memory descriptor
246 * should respond to. When the unused portion of a MD (length -
247 * local offset) falls below this value, the MD becomes inactive and
248 * does not respond to further operations. This value is only used
249 * if the LNET_MD_MAX_SIZE option is set.
253 * Specifies the behavior of the memory descriptor. A bitwise OR
254 * of the following values can be used:
255 * - LNET_MD_OP_PUT: The LNet PUT operation is allowed on this MD.
256 * - LNET_MD_OP_GET: The LNet GET operation is allowed on this MD.
257 * - LNET_MD_MANAGE_REMOTE: The offset used in accessing the memory
258 * region is provided by the incoming request. By default, the
259 * offset is maintained locally. When maintained locally, the
260 * offset is incremented by the length of the request so that
261 * the next operation (PUT or GET) will access the next part of
262 * the memory region. Note that only one offset variable exists
263 * per memory descriptor. If both PUT and GET operations are
264 * performed on a memory descriptor, the offset is updated each time.
265 * - LNET_MD_TRUNCATE: The length provided in the incoming request can
266 * be reduced to match the memory available in the region (determined
267 * by subtracting the offset from the length of the memory region).
268 * By default, if the length in the incoming operation is greater
269 * than the amount of memory available, the operation is rejected.
270 * - LNET_MD_ACK_DISABLE: An acknowledgment should not be sent for
271 * incoming PUT operations, even if requested. By default,
272 * acknowledgments are sent for PUT operations that request an
273 * acknowledgment. Acknowledgments are never sent for GET operations.
274 * The data sent in the REPLY serves as an implicit acknowledgment.
275 * - LNET_MD_KIOV: The start and length fields specify an array of
277 * - LNET_MD_IOVEC: The start and length fields specify an array of
279 * - LNET_MD_MAX_SIZE: The max_size field is valid.
282 * - LNET_MD_KIOV or LNET_MD_IOVEC allows for a scatter/gather
283 * capability for memory descriptors. They can't be both set.
284 * - When LNET_MD_MAX_SIZE is set, the total length of the memory
285 * region (i.e. sum of all fragment lengths) must not be less than
288 unsigned int options;
290 * A user-specified value that is associated with the memory
291 * descriptor. The value does not need to be a pointer, but must fit
292 * in the space used by a pointer. This value is recorded in events
293 * associated with operations on this MD.
297 * A handle for the event queue used to log the operations performed on
298 * the memory region. If this argument is a NULL handle (i.e. nullified
299 * by LNetInvalidateHandle()), operations performed on this memory
300 * descriptor are not logged.
302 lnet_handle_eq_t eq_handle;
305 /* Max Transfer Unit (minimum supported everywhere).
306 * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks)
307 * these limits are system wide and not interface-local. */
308 #define LNET_MTU_BITS 20
309 #define LNET_MTU (1 << LNET_MTU_BITS)
311 /** limit on the number of fragments in discontiguous MDs */
312 #define LNET_MAX_IOV 256
314 /* Max payload size */
315 #ifndef CONFIG_LNET_MAX_PAYLOAD
316 # error "CONFIG_LNET_MAX_PAYLOAD must be defined in config.h"
318 # define LNET_MAX_PAYLOAD CONFIG_LNET_MAX_PAYLOAD
319 # if (LNET_MAX_PAYLOAD < LNET_MTU)
320 # error "LNET_MAX_PAYLOAD too small - error in configure --with-max-payload-mb"
321 # elif defined(__KERNEL__)
322 # if (LNET_MAX_PAYLOAD > (PAGE_SIZE * LNET_MAX_IOV))
323 /* PAGE_SIZE is a constant: check with cpp! */
324 # error "LNET_MAX_PAYLOAD too large - error in configure --with-max-payload-mb"
330 * Options for the MD structure. See lnet_md_t::options.
332 #define LNET_MD_OP_PUT (1 << 0)
333 /** See lnet_md_t::options. */
334 #define LNET_MD_OP_GET (1 << 1)
335 /** See lnet_md_t::options. */
336 #define LNET_MD_MANAGE_REMOTE (1 << 2)
337 /* unused (1 << 3) */
338 /** See lnet_md_t::options. */
339 #define LNET_MD_TRUNCATE (1 << 4)
340 /** See lnet_md_t::options. */
341 #define LNET_MD_ACK_DISABLE (1 << 5)
342 /** See lnet_md_t::options. */
343 #define LNET_MD_IOVEC (1 << 6)
344 /** See lnet_md_t::options. */
345 #define LNET_MD_MAX_SIZE (1 << 7)
346 /** See lnet_md_t::options. */
347 #define LNET_MD_KIOV (1 << 8)
349 /* For compatibility with Cray Portals */
350 #define LNET_MD_PHYS 0
352 /** Infinite threshold on MD operations. See lnet_md_t::threshold */
353 #define LNET_MD_THRESH_INF (-1)
355 /* NB lustre portals uses struct iovec internally! */
356 typedef struct iovec lnet_md_iovec_t;
359 * A page-based fragment of a MD.
362 /** Pointer to the page where the fragment resides */
363 struct page *kiov_page;
364 /** Length in bytes of the fragment */
365 unsigned int kiov_len;
367 * Starting offset of the fragment within the page. Note that the
368 * end of the fragment must not pass the end of the page; i.e.,
369 * kiov_len + kiov_offset <= PAGE_CACHE_SIZE.
371 unsigned int kiov_offset;
375 /** \addtogroup lnet_eq
379 * Six types of events can be logged in an event queue.
382 /** An incoming GET operation has completed on the MD. */
385 * An incoming PUT operation has completed on the MD. The
386 * underlying layers will not alter the memory (on behalf of this
387 * operation) once this event has been logged.
391 * A REPLY operation has completed. This event is logged after the
392 * data (if any) from the REPLY has been written into the MD.
395 /** An acknowledgment has been received. */
398 * An outgoing send (PUT or GET) operation has completed. This event
399 * is logged after the entire buffer has been sent and it is safe for
400 * the caller to reuse the buffer.
403 * - The LNET_EVENT_SEND doesn't guarantee message delivery. It can
404 * happen even when the message has not yet been put out on wire.
405 * - It's unsafe to assume that in an outgoing GET operation
406 * the LNET_EVENT_SEND event would happen before the
407 * LNET_EVENT_REPLY event. The same holds for LNET_EVENT_SEND and
408 * LNET_EVENT_ACK events in an outgoing PUT operation.
412 * A MD has been unlinked. Note that LNetMDUnlink() does not
413 * necessarily trigger an LNET_EVENT_UNLINK event.
419 #define LNET_SEQ_BASETYPE long
420 typedef unsigned LNET_SEQ_BASETYPE lnet_seq_t;
421 #define LNET_SEQ_GT(a,b) (((signed LNET_SEQ_BASETYPE)((a) - (b))) > 0)
424 * Information about an event on a MD.
427 /** The identifier (nid, pid) of the target. */
428 lnet_process_id_t target;
429 /** The identifier (nid, pid) of the initiator. */
430 lnet_process_id_t initiator;
432 * The NID of the immediate sender. If the request has been forwarded
433 * by routers, this is the NID of the last hop; otherwise it's the
434 * same as the initiator.
437 /** Indicates the type of the event. */
438 lnet_event_kind_t type;
439 /** The portal table index specified in the request */
440 unsigned int pt_index;
441 /** A copy of the match bits specified in the request. */
443 /** The length (in bytes) specified in the request. */
444 unsigned int rlength;
446 * The length (in bytes) of the data that was manipulated by the
447 * operation. For truncated operations, the manipulated length will be
448 * the number of bytes specified by the MD (possibly with an offset,
449 * see lnet_md_t). For all other operations, the manipulated length
450 * will be the length of the requested operation, i.e. rlength.
452 unsigned int mlength;
454 * The handle to the MD associated with the event. The handle may be
455 * invalid if the MD has been unlinked.
457 lnet_handle_md_t md_handle;
459 * A snapshot of the state of the MD immediately after the event has
460 * been processed. In particular, the threshold field in md will
461 * reflect the value of the threshold after the operation occurred.
465 * 64 bits of out-of-band user data. Only valid for LNET_EVENT_PUT.
470 * Indicates the completion status of the operation. It's 0 for
471 * successful operations, otherwise it's an error code.
475 * Indicates whether the MD has been unlinked. Note that:
476 * - An event with unlinked set is the last event on the MD.
477 * - This field is also set for an explicit LNET_EVENT_UNLINK event.
482 * The displacement (in bytes) into the memory region that the
483 * operation used. The offset can be determined by the operation for
484 * a remote managed MD or by the local MD.
485 * \see lnet_md_t::options
489 * The sequence number for this event. Sequence numbers are unique
492 volatile lnet_seq_t sequence;
496 * Event queue handler function type.
498 * The EQ handler runs for each event that is deposited into the EQ. The
499 * handler is supplied with a pointer to the event that triggered the
500 * handler invocation.
502 * The handler must not block, must be reentrant, and must not call any LNet
503 * API functions. It should return as quickly as possible.
505 typedef void (*lnet_eq_handler_t)(lnet_event_t *event);
506 #define LNET_EQ_HANDLER_NONE NULL
509 /** \addtogroup lnet_data
513 * Specify whether an acknowledgment should be sent by target when the PUT
514 * operation completes (i.e., when the data has been written to a MD of the
517 * \see lnet_md_t::options for the discussion on LNET_MD_ACK_DISABLE by which
518 * acknowledgments can be disabled for a MD.
521 /** Request an acknowledgment */
523 /** Request that no acknowledgment should be generated. */