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, lnet_process_id_t *id);
79 int LNetDist(lnet_nid_t nid, lnet_nid_t *srcnid, __u32 *order);
80 void LNetSnprintHandle(char *str, int str_len, lnet_handle_any_t handle);
81 lnet_nid_t LNetPrimaryNID(lnet_nid_t nid);
86 /** \defgroup lnet_me Match entries
88 * A match entry (abbreviated as ME) describes a set of criteria to accept
91 * A portal is essentially a match list plus a set of attributes. A match
92 * list is a chain of MEs. Each ME includes a pointer to a memory descriptor
93 * and a set of match criteria. The match criteria can be used to reject
94 * incoming requests based on process ID or the match bits provided in the
95 * request. MEs can be dynamically inserted into a match list by LNetMEAttach()
96 * and LNetMEInsert(), and removed from its list by LNetMEUnlink().
98 int LNetMEAttach(unsigned int portal,
99 lnet_process_id_t match_id_in,
101 __u64 ignore_bits_in,
102 lnet_unlink_t unlink_in,
103 lnet_ins_pos_t pos_in,
104 lnet_handle_me_t *handle_out);
106 int LNetMEInsert(lnet_handle_me_t current_in,
107 lnet_process_id_t match_id_in,
109 __u64 ignore_bits_in,
110 lnet_unlink_t unlink_in,
111 lnet_ins_pos_t position_in,
112 lnet_handle_me_t *handle_out);
114 int LNetMEUnlink(lnet_handle_me_t current_in);
117 /** \defgroup lnet_md Memory descriptors
119 * A memory descriptor contains information about a region of a user's
120 * memory (either in kernel or user space) and optionally points to an
121 * event queue where information about the operations performed on the
122 * memory descriptor are recorded. Memory descriptor is abbreviated as
123 * MD and can be used interchangeably with the memory region it describes.
125 * The LNet API provides two operations to create MDs: LNetMDAttach()
126 * and LNetMDBind(); one operation to unlink and release the resources
127 * associated with a MD: LNetMDUnlink().
129 int LNetMDAttach(lnet_handle_me_t current_in,
131 lnet_unlink_t unlink_in,
132 lnet_handle_md_t *handle_out);
134 int LNetMDBind(lnet_md_t md_in,
135 lnet_unlink_t unlink_in,
136 lnet_handle_md_t *handle_out);
138 int LNetMDUnlink(lnet_handle_md_t md_in);
141 /** \defgroup lnet_eq Events and event queues
143 * Event queues (abbreviated as EQ) are used to log operations performed on
144 * local MDs. In particular, they signal the completion of a data transmission
145 * into or out of a MD. They can also be used to hold acknowledgments for
146 * completed PUT operations and indicate when a MD has been unlinked. Multiple
147 * MDs can share a single EQ. An EQ may have an optional event handler
148 * associated with it. If an event handler exists, it will be run for each
149 * event that is deposited into the EQ.
151 * In addition to the lnet_handle_eq_t, the LNet API defines two types
152 * associated with events: The ::lnet_event_kind_t defines the kinds of events
153 * that can be stored in an EQ. The lnet_event_t defines a structure that
154 * holds the information about with an event.
156 * There are five functions for dealing with EQs: LNetEQAlloc() is used to
157 * create an EQ and allocate the resources needed, while LNetEQFree()
158 * releases these resources and free the EQ. LNetEQGet() retrieves the next
159 * event from an EQ, and LNetEQWait() can be used to block a process until
160 * an EQ has at least one event. LNetEQPoll() can be used to test or wait
163 int LNetEQAlloc(unsigned int count_in,
164 lnet_eq_handler_t handler,
165 lnet_handle_eq_t *handle_out);
167 int LNetEQFree(lnet_handle_eq_t eventq_in);
169 int LNetEQGet(lnet_handle_eq_t eventq_in,
170 lnet_event_t *event_out);
173 int LNetEQWait(lnet_handle_eq_t eventq_in,
174 lnet_event_t *event_out);
176 int LNetEQPoll(lnet_handle_eq_t *eventqs_in,
179 lnet_event_t *event_out,
183 /** \defgroup lnet_data Data movement operations
185 * The LNet API provides two data movement operations: LNetPut()
188 int LNetPut(lnet_nid_t self,
189 lnet_handle_md_t md_in,
190 lnet_ack_req_t ack_req_in,
191 lnet_process_id_t target_in,
192 unsigned int portal_in,
194 unsigned int offset_in,
197 int LNetGet(lnet_nid_t self,
198 lnet_handle_md_t md_in,
199 lnet_process_id_t target_in,
200 unsigned int portal_in,
202 unsigned int offset_in);
206 /** \defgroup lnet_misc Miscellaneous operations.
207 * Miscellaneous operations.
210 int LNetSetLazyPortal(int portal);
211 int LNetClearLazyPortal(int portal);
212 int LNetCtl(unsigned int cmd, void *arg);
213 void LNetDebugPeer(lnet_process_id_t id);