Whamcloud - gitweb
LU-14392 gnilnd: re-enable large I/o buffers
[fs/lustre-release.git] / lnet / include / uapi / linux / lnet / lnet-types.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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  */
31
32 #ifndef __UAPI_LNET_TYPES_H__
33 #define __UAPI_LNET_TYPES_H__
34
35 #include <linux/string.h>
36 #include <asm/byteorder.h>
37
38 /** \addtogroup lnet
39  * @{ */
40
41 #include <linux/lnet/lnet-idl.h>
42
43 /** \addtogroup lnet_addr
44  * @{ */
45
46 #define LNET_VERSION            "0.7.0"
47
48 /** Portal reserved for LNet's own use.
49  * \see lustre/include/lustre/lustre_idl.h for Lustre portal assignments.
50  */
51 #define LNET_RESERVED_PORTAL      0
52
53 /** wildcard NID that matches any end-point address */
54 #define LNET_NID_ANY      ((lnet_nid_t) -1)
55 /** wildcard PID that matches any lnet_pid_t */
56 #define LNET_PID_ANY      ((lnet_pid_t) -1)
57
58 static inline int LNET_NID_IS_ANY(const struct lnet_nid *nid)
59 {
60         /* A NULL pointer can be used to mean "ANY" */
61         return !nid || nid->nid_type == 0xFF;
62 }
63
64 #define LNET_ANY_NID ((struct lnet_nid)                 \
65                       {0xFF, 0xFF, ~0, {~0, ~0, ~0, ~0} })
66
67 #define LNET_PID_RESERVED 0xf0000000 /* reserved bits in PID */
68 #define LNET_PID_USERFLAG 0x80000000 /* set in userspace peers */
69 #define LNET_PID_LUSTRE 12345
70
71 /* how an LNET NID encodes net:address */
72 /** extract the address part of an lnet_nid_t */
73
74 static inline __u32 LNET_NIDADDR(lnet_nid_t nid)
75 {
76         return nid & 0xffffffff;
77 }
78
79 static inline __u32 LNET_NIDNET(lnet_nid_t nid)
80 {
81         return (nid >> 32) & 0xffffffff;
82 }
83
84 static inline lnet_nid_t LNET_MKNID(__u32 net, __u32 addr)
85 {
86         return (((__u64)net) << 32) | addr;
87 }
88
89 static inline __u32 LNET_NETNUM(__u32 net)
90 {
91         return net & 0xffff;
92 }
93
94 static inline __u32 LNET_NETTYP(__u32 net)
95 {
96         return (net >> 16) & 0xff;
97 }
98
99 static inline __u32 LNET_MKNET(__u32 type, __u32 num)
100 {
101         return (type << 16) | num;
102 }
103
104 /** The lolnd NID (i.e. myself) */
105 #define LNET_NID_LO_0 LNET_MKNID(LNET_MKNET(LOLND, 0), 0)
106
107 #define LNET_NET_ANY LNET_NIDNET(LNET_NID_ANY)
108
109 static inline int nid_is_nid4(const struct lnet_nid *nid)
110 {
111         return NID_ADDR_BYTES(nid) == 4;
112 }
113
114 /* LOLND may not be defined yet, so we cannot use an inline */
115 #define nid_is_lo0(__nid)                                               \
116         ((__nid)->nid_type == LOLND &&                                  \
117          nid_is_nid4(__nid) &&                                          \
118          (__nid)->nid_num == 0 &&                                       \
119          (__nid)->nid_addr[0] == 0)
120
121 static inline __u32 LNET_NID_NET(const struct lnet_nid *nid)
122 {
123         return LNET_MKNET(nid->nid_type, __be16_to_cpu(nid->nid_num));
124 }
125
126 static inline void lnet_nid4_to_nid(lnet_nid_t nid4, struct lnet_nid *nid)
127 {
128         if (nid4 == LNET_NID_ANY) {
129                 /* equal to setting to LNET_ANY_NID */
130                 memset(nid, 0xff, sizeof(*nid));
131                 return;
132         }
133
134         nid->nid_size = 0;
135         nid->nid_type = LNET_NETTYP(LNET_NIDNET(nid4));
136         nid->nid_num = __cpu_to_be16(LNET_NETNUM(LNET_NIDNET(nid4)));
137         nid->nid_addr[0] = __cpu_to_be32(LNET_NIDADDR(nid4));
138         nid->nid_addr[1] = nid->nid_addr[2] = nid->nid_addr[3] = 0;
139 }
140
141 static inline lnet_nid_t lnet_nid_to_nid4(const struct lnet_nid *nid)
142 {
143         if (LNET_NID_IS_ANY(nid))
144                 return LNET_NID_ANY;
145
146         return LNET_MKNID(LNET_NID_NET(nid), __be32_to_cpu(nid->nid_addr[0]));
147 }
148
149 static inline int nid_same(const struct lnet_nid *n1,
150                             const struct lnet_nid *n2)
151 {
152         return n1->nid_size == n2->nid_size &&
153                 n1->nid_type == n2->nid_type &&
154                 n1->nid_num == n2->nid_num &&
155                 n1->nid_addr[0] == n2->nid_addr[0] &&
156                 n1->nid_addr[1] == n2->nid_addr[1] &&
157                 n1->nid_addr[2] == n2->nid_addr[2] &&
158                 n1->nid_addr[3] == n2->nid_addr[3];
159 }
160
161 /* This can be used when we need to hash a nid */
162 static inline unsigned long nidhash(const struct lnet_nid *nid)
163 {
164         int i;
165         unsigned long hash = 0;
166
167         hash ^= LNET_NID_NET(nid);
168         for (i = 0; i < 4; i++)
169                 hash ^= nid->nid_addr[i];
170         return hash;
171 }
172
173 struct lnet_counters_health {
174         __u32   lch_rst_alloc;
175         __u32   lch_resend_count;
176         __u32   lch_response_timeout_count;
177         __u32   lch_local_interrupt_count;
178         __u32   lch_local_dropped_count;
179         __u32   lch_local_aborted_count;
180         __u32   lch_local_no_route_count;
181         __u32   lch_local_timeout_count;
182         __u32   lch_local_error_count;
183         __u32   lch_remote_dropped_count;
184         __u32   lch_remote_error_count;
185         __u32   lch_remote_timeout_count;
186         __u32   lch_network_timeout_count;
187 };
188
189 struct lnet_counters {
190         struct lnet_counters_common lct_common;
191         struct lnet_counters_health lct_health;
192 };
193
194 /*
195  * This is a hard-coded limit on the number of interfaces supported by
196  * the interface bonding implemented by the ksocknal LND. It must be
197  * defined here because it is used in LNet data structures that are
198  * common to all LNDs.
199  */
200 #define LNET_INTERFACES_NUM     16
201
202 /* The minimum number of interfaces per node supported by LNet. */
203 #define LNET_INTERFACES_MIN     16
204 /* The default - arbitrary - value of the lnet_max_interfaces tunable. */
205 #define LNET_INTERFACES_MAX_DEFAULT     200
206
207 /**
208  * Objects maintained by the LNet are accessed through handles. Handle types
209  * have names of the form lnet_handle_xx, where xx is one of the two letter
210  * object type codes ('md' for memory descriptor, and
211  * 'me' for match entry). Each type of object is given a unique handle type
212  * to enhance type checking.
213  */
214 #define LNET_WIRE_HANDLE_COOKIE_NONE   (~0ULL)
215
216 struct lnet_handle_md {
217         __u64   cookie;
218 };
219
220 /**
221  * Invalidate md handle \a h.
222  */
223 static inline void LNetInvalidateMDHandle(struct lnet_handle_md *h)
224 {
225         h->cookie = LNET_WIRE_HANDLE_COOKIE_NONE;
226 }
227
228 /**
229  * Check whether handler \a h is invalid.
230  *
231  * \return 1 if handle is invalid, 0 if valid.
232  */
233 static inline int LNetMDHandleIsInvalid(struct lnet_handle_md h)
234 {
235         return (LNET_WIRE_HANDLE_COOKIE_NONE == h.cookie);
236 }
237
238 /**
239  * Global process ID.
240  */
241 struct lnet_process_id {
242         /** node id */
243         lnet_nid_t nid;
244         /** process id */
245         lnet_pid_t pid;
246 };
247
248 /**
249  * Global process ID - with large addresses
250  */
251 struct lnet_processid {
252         /** node id */
253         struct lnet_nid nid;
254         /** process id */
255         lnet_pid_t pid;
256 };
257
258 static inline void
259 lnet_pid4_to_pid(struct lnet_process_id pid4, struct lnet_processid *pid)
260 {
261         pid->pid = pid4.pid;
262         lnet_nid4_to_nid(pid4.nid, &pid->nid);
263 }
264
265 static inline struct lnet_process_id
266 lnet_pid_to_pid4(struct lnet_processid *pid)
267 {
268         struct lnet_process_id ret;
269
270         ret.pid = pid->pid;
271         ret.nid = lnet_nid_to_nid4(&pid->nid);
272         return ret;
273 }
274
275 /** @} lnet_addr */
276
277 /** \addtogroup lnet_me
278  * @{ */
279
280 /**
281  * Specifies whether the match entry or memory descriptor should be unlinked
282  * automatically (LNET_UNLINK) or not (LNET_RETAIN).
283  */
284 enum lnet_unlink {
285         LNET_RETAIN = 0,
286         LNET_UNLINK
287 };
288
289 /**
290  * Values of the type enum lnet_ins_pos are used to control where a new match
291  * entry is inserted. The value LNET_INS_BEFORE is used to insert the new
292  * entry before the current entry or before the head of the list. The value
293  * LNET_INS_AFTER is used to insert the new entry after the current entry
294  * or after the last item in the list.
295  */
296 enum lnet_ins_pos {
297         /** insert ME before current position or head of the list */
298         LNET_INS_BEFORE,
299         /** insert ME after current position or tail of the list */
300         LNET_INS_AFTER,
301         /** attach ME at tail of local CPU partition ME list */
302         LNET_INS_LOCAL
303 };
304
305 /** @} lnet_me */
306
307 /** \addtogroup lnet_md
308  * @{ */
309
310 /**
311  * Event queue handler function type.
312  *
313  * The EQ handler runs for each event that is deposited into the EQ. The
314  * handler is supplied with a pointer to the event that triggered the
315  * handler invocation.
316  *
317  * The handler must not block, must be reentrant, and must not call any LNet
318  * API functions. It should return as quickly as possible.
319  */
320 struct lnet_event;
321 typedef void (*lnet_handler_t)(struct lnet_event *event);
322
323 /**
324  * Defines the visible parts of a memory descriptor. Values of this type
325  * are used to initialize memory descriptors.
326  */
327 struct lnet_md {
328         /**
329          * Specify the memory region associated with the memory descriptor.
330          * If the options field has:
331          * - LNET_MD_KIOV bit set: The start field points to the starting
332          * address of an array of struct bio_vec and the length field specifies
333          * the number of entries in the array. The length can't be bigger
334          * than LNET_MAX_IOV. The struct bio_vec is used to describe page-based
335          * fragments that are not necessarily mapped in virtal memory.
336          * - Otherwise: The memory region is contiguous. The start field
337          * specifies the starting address for the memory region and the
338          * length field specifies its length.
339          *
340          * When the memory region is fragmented, all fragments but the first
341          * one must start on page boundary, and all but the last must end on
342          * page boundary.
343          */
344         void            *start;
345         unsigned int     length;
346         /**
347          * Specifies the maximum number of operations that can be performed
348          * on the memory descriptor. An operation is any action that could
349          * possibly generate an event. In the usual case, the threshold value
350          * is decremented for each operation on the MD. When the threshold
351          * drops to zero, the MD becomes inactive and does not respond to
352          * operations. A threshold value of LNET_MD_THRESH_INF indicates that
353          * there is no bound on the number of operations that may be applied
354          * to a MD.
355          */
356         int              threshold;
357         /**
358          * Specifies the largest incoming request that the memory descriptor
359          * should respond to. When the unused portion of a MD (length -
360          * local offset) falls below this value, the MD becomes inactive and
361          * does not respond to further operations. This value is only used
362          * if the LNET_MD_MAX_SIZE option is set.
363          */
364         int              max_size;
365         /**
366          * Specifies the behavior of the memory descriptor. A bitwise OR
367          * of the following values can be used:
368          * - LNET_MD_OP_PUT: The LNet PUT operation is allowed on this MD.
369          * - LNET_MD_OP_GET: The LNet GET operation is allowed on this MD.
370          * - LNET_MD_MANAGE_REMOTE: The offset used in accessing the memory
371          *   region is provided by the incoming request. By default, the
372          *   offset is maintained locally. When maintained locally, the
373          *   offset is incremented by the length of the request so that
374          *   the next operation (PUT or GET) will access the next part of
375          *   the memory region. Note that only one offset variable exists
376          *   per memory descriptor. If both PUT and GET operations are
377          *   performed on a memory descriptor, the offset is updated each time.
378          * - LNET_MD_TRUNCATE: The length provided in the incoming request can
379          *   be reduced to match the memory available in the region (determined
380          *   by subtracting the offset from the length of the memory region).
381          *   By default, if the length in the incoming operation is greater
382          *   than the amount of memory available, the operation is rejected.
383          * - LNET_MD_ACK_DISABLE: An acknowledgment should not be sent for
384          *   incoming PUT operations, even if requested. By default,
385          *   acknowledgments are sent for PUT operations that request an
386          *   acknowledgment. Acknowledgments are never sent for GET operations.
387          *   The data sent in the REPLY serves as an implicit acknowledgment.
388          * - LNET_MD_KIOV: The start and length fields specify an array of
389          *   struct bio_vec.
390          * - LNET_MD_MAX_SIZE: The max_size field is valid.
391          * - LNET_MD_BULK_HANDLE: The bulk_handle field is valid.
392          * - LNET_MD_TRACK_RESPONSE: Enable response tracking on this MD
393          *   regardless of the value of the lnet_response_tracking param.
394          * - LNET_MD_NO_TRACK_RESPONSE: Disable response tracking on this MD
395          *   regardless of the value of the lnet_response_tracking param.
396          * - LNET_MD_GNILND: Disable warning about exceeding LNET_MAX_IOV.
397          *
398          * Note:
399          * - LNET_MD_KIOV allows for a scatter/gather capability for memory
400          *   descriptors.
401          * - When LNET_MD_MAX_SIZE is set, the total length of the memory
402          *   region (i.e. sum of all fragment lengths) must not be less than
403          *   \a max_size.
404          */
405         unsigned int     options;
406         /**
407          * A user-specified value that is associated with the memory
408          * descriptor. The value does not need to be a pointer, but must fit
409          * in the space used by a pointer. This value is recorded in events
410          * associated with operations on this MD.
411          */
412         void            *user_ptr;
413         /**
414          * The event handler used to log the operations performed on
415          * the memory region. If this argument is NULL operations
416          * performed on this memory descriptor are not logged.
417          */
418         lnet_handler_t  handler;
419         /**
420          * The bulk MD handle which was registered to describe the buffers
421          * either to be used to transfer data to the peer or receive data
422          * from the peer. This allows LNet to properly determine the NUMA
423          * node on which the memory was allocated and use that to select the
424          * nearest local network interface. This value is only used
425          * if the LNET_MD_BULK_HANDLE option is set.
426          */
427         struct lnet_handle_md bulk_handle;
428 };
429
430 /* Max Transfer Unit (minimum supported everywhere).
431  * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks)
432  * these limits are system wide and not interface-local. */
433 #define LNET_MTU_BITS   20
434 #define LNET_MTU        (1 << LNET_MTU_BITS)
435
436 /**
437  * Options for the MD structure. See struct lnet_md::options.
438  */
439 #define LNET_MD_OP_PUT               (1 << 0)
440 /** See struct lnet_md::options. */
441 #define LNET_MD_OP_GET               (1 << 1)
442 /** See struct lnet_md::options. */
443 #define LNET_MD_MANAGE_REMOTE        (1 << 2)
444 /* unused                            (1 << 3) */
445 /** See struct lnet_md::options. */
446 #define LNET_MD_TRUNCATE             (1 << 4)
447 /** See struct lnet_md::options. */
448 #define LNET_MD_ACK_DISABLE          (1 << 5)
449 /** See struct lnet_md::options. */
450 /* deprecated #define LNET_MD_IOVEC  (1 << 6) */
451 /** See struct lnet_md::options. */
452 #define LNET_MD_MAX_SIZE             (1 << 7)
453 /** See struct lnet_md::options. */
454 #define LNET_MD_KIOV                 (1 << 8)
455 /** See struct lnet_md::options. */
456 #define LNET_MD_BULK_HANDLE          (1 << 9)
457 /** See struct lnet_md::options. */
458 #define LNET_MD_TRACK_RESPONSE       (1 << 10)
459 /** See struct lnet_md::options. */
460 #define LNET_MD_NO_TRACK_RESPONSE    (1 << 11)
461 /** See struct lnet_md::options. */
462 #define LNET_MD_GNILND               (1 << 12)
463
464 /** Infinite threshold on MD operations. See struct lnet_md::threshold */
465 #define LNET_MD_THRESH_INF       (-1)
466
467 /** @} lnet_md */
468
469 /** \addtogroup lnet_eq
470  * @{ */
471
472 /**
473  * Six types of events can be logged in an event queue.
474  */
475 enum lnet_event_kind {
476         /** An incoming GET operation has completed on the MD. */
477         LNET_EVENT_GET          = 1,
478         /**
479          * An incoming PUT operation has completed on the MD. The
480          * underlying layers will not alter the memory (on behalf of this
481          * operation) once this event has been logged.
482          */
483         LNET_EVENT_PUT,
484         /**
485          * A REPLY operation has completed. This event is logged after the
486          * data (if any) from the REPLY has been written into the MD.
487          */
488         LNET_EVENT_REPLY,
489         /** An acknowledgment has been received. */
490         LNET_EVENT_ACK,
491         /**
492          * An outgoing send (PUT or GET) operation has completed. This event
493          * is logged after the entire buffer has been sent and it is safe for
494          * the caller to reuse the buffer.
495          *
496          * Note:
497          * - The LNET_EVENT_SEND doesn't guarantee message delivery. It can
498          *   happen even when the message has not yet been put out on wire.
499          * - It's unsafe to assume that in an outgoing GET operation
500          *   the LNET_EVENT_SEND event would happen before the
501          *   LNET_EVENT_REPLY event. The same holds for LNET_EVENT_SEND and
502          *   LNET_EVENT_ACK events in an outgoing PUT operation.
503          */
504         LNET_EVENT_SEND,
505         /**
506          * A MD has been unlinked. Note that LNetMDUnlink() does not
507          * necessarily trigger an LNET_EVENT_UNLINK event.
508          * \see LNetMDUnlink
509          */
510         LNET_EVENT_UNLINK,
511 };
512
513 #define LNET_SEQ_GT(a, b)       (((signed long)((a) - (b))) > 0)
514
515 /**
516  * Information about an event on a MD.
517  */
518 struct lnet_event {
519         /** The identifier (nid, pid) of the target. */
520         struct lnet_process_id   target;
521         /** The identifier (nid, pid) of the initiator. */
522         struct lnet_process_id   initiator;
523         /** The source NID on the initiator. */
524         struct lnet_process_id   source;
525         /**
526          * The NID of the immediate sender. If the request has been forwarded
527          * by routers, this is the NID of the last hop; otherwise it's the
528          * same as the source.
529          */
530         lnet_nid_t          sender;
531         /** Indicates the type of the event. */
532         enum lnet_event_kind    type;
533         /** The portal table index specified in the request */
534         unsigned int        pt_index;
535         /** A copy of the match bits specified in the request. */
536         __u64               match_bits;
537         /** The length (in bytes) specified in the request. */
538         unsigned int        rlength;
539         /**
540          * The length (in bytes) of the data that was manipulated by the
541          * operation. For truncated operations, the manipulated length will be
542          * the number of bytes specified by the MD (possibly with an offset,
543          * see struct lnet_md). For all other operations, the manipulated length
544          * will be the length of the requested operation, i.e. rlength.
545          */
546         unsigned int        mlength;
547         /**
548          * The handle to the MD associated with the event. The handle may be
549          * invalid if the MD has been unlinked.
550          */
551         struct lnet_handle_md   md_handle;
552         /**
553          * A snapshot of relevant state of the MD immediately after the event
554          * has been processed.
555          */
556         void                    *md_start;
557         void                    *md_user_ptr;
558         unsigned int            md_options;
559         /**
560          * 64 bits of out-of-band user data. Only valid for LNET_EVENT_PUT.
561          * \see LNetPut
562          */
563         __u64               hdr_data;
564         /**
565          * The message type, to ensure a handler for LNET_EVENT_SEND can
566          * distinguish between LNET_MSG_GET and LNET_MSG_PUT.
567          */
568         __u32               msg_type;
569         /**
570          * Indicates the completion status of the operation. It's 0 for
571          * successful operations, otherwise it's an error code.
572          */
573         int                 status;
574         /**
575          * Indicates whether the MD has been unlinked. Note that:
576          * - An event with unlinked set is the last event on the MD.
577          * - This field is also set for an explicit LNET_EVENT_UNLINK event.
578          * \see LNetMDUnlink
579          */
580         int                 unlinked;
581         /**
582          * The displacement (in bytes) into the memory region that the
583          * operation used. The offset can be determined by the operation for
584          * a remote managed MD or by the local MD.
585          * \see struct lnet_md::options
586          */
587         unsigned int        offset;
588         /**
589          * The sequence number for this event. Sequence numbers are unique
590          * to each event.
591          */
592         volatile unsigned long sequence;
593 };
594
595 /** \addtogroup lnet_data
596  * @{ */
597
598 /**
599  * Specify whether an acknowledgment should be sent by target when the PUT
600  * operation completes (i.e., when the data has been written to a MD of the
601  * target process).
602  *
603  * \see struct lnet_md::options for the discussion on LNET_MD_ACK_DISABLE
604  * by which acknowledgments can be disabled for a MD.
605  */
606 enum lnet_ack_req {
607         /** Request an acknowledgment */
608         LNET_ACK_REQ,
609         /** Request that no acknowledgment should be generated. */
610         LNET_NOACK_REQ
611 };
612
613 /**
614  * UDSP action types. There are two available actions:
615  *      1. PRIORITY - set priority of matching LNet constructs
616  *      2. PREFERRED LIST - set preferred list of matching LNet constructs
617  */
618 enum lnet_udsp_action_type {
619         EN_LNET_UDSP_ACTION_NONE = 0,
620         /** assign a priority to matching constructs */
621         EN_LNET_UDSP_ACTION_PRIORITY = 1,
622         /** assign a preferred list of NIDs to matching constructs */
623         EN_LNET_UDSP_ACTION_PREFERRED_LIST = 2,
624 };
625
626 /** @} lnet_data */
627
628 /** @} lnet */
629 #endif