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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 #ifndef __LNET_API_H__
34 #define __LNET_API_H__
36 /** \defgroup lnet LNet
38 * The Lustre Networking subsystem.
40 * LNet is an asynchronous message-passing API, which provides an unreliable
41 * connectionless service that can't guarantee any order. It supports OFA IB,
42 * TCP/IP, and Cray Portals, and routes between heterogeneous networks.
47 # error This include is only for kernel use.
50 #include <lnet/types.h>
52 /** \defgroup lnet_init_fini Initialization and cleanup
53 * The LNet must be properly initialized before any LNet calls can be made.
55 int LNetNIInit(lnet_pid_t requested_pid);
57 /** @} lnet_init_fini */
59 /** \defgroup lnet_addr LNet addressing and basic types
61 * Addressing scheme and basic data types of LNet.
63 * The LNet API is memory-oriented, so LNet must be able to address not only
64 * end-points but also memory region within a process address space.
65 * An ::lnet_nid_t addresses an end-point. An ::lnet_pid_t identifies a process
66 * in a node. A portal represents an opening in the address space of a
67 * process. Match bits is criteria to identify a region of memory inside a
68 * portal, and offset specifies an offset within the memory region.
70 * LNet creates a table of portals for each process during initialization.
71 * This table has MAX_PORTALS entries and its size can't be dynamically
72 * changed. A portal stays empty until the owning process starts to add
73 * memory regions to it. A portal is sometimes called an index because
74 * it's an entry in the portals table of a process.
78 int LNetGetId(unsigned int index, struct lnet_process_id *id);
79 int LNetDist(lnet_nid_t nid, lnet_nid_t *srcnid, __u32 *order);
80 lnet_nid_t LNetPrimaryNID(lnet_nid_t nid);
85 /** \defgroup lnet_me Match entries
87 * A match entry (abbreviated as ME) describes a set of criteria to accept
90 * A portal is essentially a match list plus a set of attributes. A match
91 * list is a chain of MEs. Each ME includes a pointer to a memory descriptor
92 * and a set of match criteria. The match criteria can be used to reject
93 * incoming requests based on process ID or the match bits provided in the
94 * request. MEs can be dynamically inserted into a match list by LNetMEAttach()
95 * and LNetMEInsert(), and removed from its list by LNetMEUnlink().
97 int LNetMEAttach(unsigned int portal,
98 struct lnet_process_id match_id_in,
100 __u64 ignore_bits_in,
101 enum lnet_unlink unlink_in,
102 enum lnet_ins_pos pos_in,
103 struct lnet_handle_me *handle_out);
105 int LNetMEInsert(struct lnet_handle_me current_in,
106 struct lnet_process_id match_id_in,
108 __u64 ignore_bits_in,
109 enum lnet_unlink unlink_in,
110 enum lnet_ins_pos position_in,
111 struct lnet_handle_me *handle_out);
113 int LNetMEUnlink(struct lnet_handle_me current_in);
116 /** \defgroup lnet_md Memory descriptors
118 * A memory descriptor contains information about a region of a user's
119 * memory (either in kernel or user space) and optionally points to an
120 * event queue where information about the operations performed on the
121 * memory descriptor are recorded. Memory descriptor is abbreviated as
122 * MD and can be used interchangeably with the memory region it describes.
124 * The LNet API provides two operations to create MDs: LNetMDAttach()
125 * and LNetMDBind(); one operation to unlink and release the resources
126 * associated with a MD: LNetMDUnlink().
128 int LNetMDAttach(struct lnet_handle_me current_in,
129 struct lnet_md md_in,
130 enum lnet_unlink unlink_in,
131 struct lnet_handle_md *md_handle_out);
133 int LNetMDBind(struct lnet_md md_in,
134 enum lnet_unlink unlink_in,
135 struct lnet_handle_md *md_handle_out);
137 int LNetMDUnlink(struct lnet_handle_md md_in);
140 /** \defgroup lnet_eq Events and event queues
142 * Event queues (abbreviated as EQ) are used to log operations performed on
143 * local MDs. In particular, they signal the completion of a data transmission
144 * into or out of a MD. They can also be used to hold acknowledgments for
145 * completed PUT operations and indicate when a MD has been unlinked. Multiple
146 * MDs can share a single EQ. An EQ may have an optional event handler
147 * associated with it. If an event handler exists, it will be run for each
148 * event that is deposited into the EQ.
150 * In addition to the struct lnet_handle_eq, the LNet API defines two types
151 * associated with events: The ::lnet_event_kind defines the kinds of events
152 * that can be stored in an EQ. The struct lnet_event defines a structure that
153 * holds the information about with an event.
155 * There are five functions for dealing with EQs: LNetEQAlloc() is used to
156 * create an EQ and allocate the resources needed, while LNetEQFree()
157 * releases these resources and free the EQ. LNetEQGet() retrieves the next
158 * event from an EQ, and LNetEQWait() can be used to block a process until
159 * an EQ has at least one event. LNetEQPoll() can be used to test or wait
162 int LNetEQAlloc(unsigned int count_in,
163 lnet_eq_handler_t handler,
164 struct lnet_handle_eq *handle_out);
166 int LNetEQFree(struct lnet_handle_eq eventq_in);
168 int LNetEQGet(struct lnet_handle_eq eventq_in,
169 struct lnet_event *event_out);
171 int LNetEQWait(struct lnet_handle_eq eventq_in,
172 struct lnet_event *event_out);
174 int LNetEQPoll(struct lnet_handle_eq *eventqs_in,
177 struct lnet_event *event_out,
181 /** \defgroup lnet_data Data movement operations
183 * The LNet API provides two data movement operations: LNetPut()
186 int LNetPut(lnet_nid_t self,
187 struct lnet_handle_md md_in,
188 enum lnet_ack_req ack_req_in,
189 struct lnet_process_id target_in,
190 unsigned int portal_in,
192 unsigned int offset_in,
195 int LNetGet(lnet_nid_t self,
196 struct lnet_handle_md md_in,
197 struct lnet_process_id target_in,
198 unsigned int portal_in,
200 unsigned int offset_in);
204 /** \defgroup lnet_misc Miscellaneous operations.
205 * Miscellaneous operations.
208 int LNetSetLazyPortal(int portal);
209 int LNetClearLazyPortal(int portal);
210 int LNetCtl(unsigned int cmd, void *arg);
211 void LNetDebugPeer(struct lnet_process_id id);