Whamcloud - gitweb
LU-10391 lnet: switch to large lnet_processid for matching
[fs/lustre-release.git] / lnet / include / lnet / api.h
index 9d1c49c..c139be1 100644 (file)
@@ -1,6 +1,4 @@
-/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
- * vim:expandtab:shiftwidth=8:tabstop=8:
- *
+/*
  * GPL HEADER START
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * You should have received a copy of the GNU General Public License
  * version 2 along with this program; If not, see
- * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
- *
- * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
- * CA 95054 USA or visit www.sun.com if you need additional information or
- * have any questions.
+ * http://www.gnu.org/licenses/gpl-2.0.html
  *
  * GPL HEADER END
  */
 /*
  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
+ *
+ * Copyright (c) 2016, 2017, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
- * Lustre is a trademark of Sun Microsystems, Inc.
  */
 
 #ifndef __LNET_API_H__
  * LNet is an asynchronous message-passing API, which provides an unreliable
  * connectionless service that can't guarantee any order. It supports OFA IB,
  * TCP/IP, and Cray Portals, and routes between heterogeneous networks.
- *
- * LNet can run both in OS kernel space and in userspace as a library.
  * @{
  */
 
-#include <lnet/types.h>
+#ifndef __KERNEL__
+# error This include is only for kernel use.
+#endif
+
+#include <uapi/linux/lnet/lnet-types.h>
 
 /** \defgroup lnet_init_fini Initialization and cleanup
  * The LNet must be properly initialized before any LNet calls can be made.
  * @{ */
-int LNetInit(void);
-void LNetFini(void);
-
 int LNetNIInit(lnet_pid_t requested_pid);
 int LNetNIFini(void);
 /** @} lnet_init_fini */
@@ -80,9 +74,10 @@ int LNetNIFini(void);
  *
  * \see LNetMEAttach
  * @{ */
-int LNetGetId(unsigned int index, lnet_process_id_t *id);
+int LNetGetId(unsigned int index, struct lnet_process_id *id);
 int LNetDist(lnet_nid_t nid, lnet_nid_t *srcnid, __u32 *order);
-void LNetSnprintHandle(char *str, int str_len, lnet_handle_any_t handle);
+lnet_nid_t LNetPrimaryNID(lnet_nid_t nid);
+bool LNetIsPeerLocal(lnet_nid_t nid);
 
 /** @} lnet_addr */
 
@@ -96,26 +91,16 @@ void LNetSnprintHandle(char *str, int str_len, lnet_handle_any_t handle);
  * list is a chain of MEs. Each ME includes a pointer to a memory descriptor
  * and a set of match criteria. The match criteria can be used to reject
  * incoming requests based on process ID or the match bits provided in the
- * request. MEs can be dynamically inserted into a match list by LNetMEAttach()
- * and LNetMEInsert(), and removed from its list by LNetMEUnlink().
+ * request. MEs can be dynamically inserted into a match list by LNetMEAttach(),
+ * and must then be attached to an MD with LNetMDAttach().
  * @{ */
-int LNetMEAttach(unsigned int      portal,
-                lnet_process_id_t match_id_in, 
-                __u64             match_bits_in,
-                __u64             ignore_bits_in, 
-                lnet_unlink_t     unlink_in,
-                lnet_ins_pos_t    pos_in, 
-                lnet_handle_me_t *handle_out);
-
-int LNetMEInsert(lnet_handle_me_t  current_in, 
-                lnet_process_id_t match_id_in,
-                __u64             match_bits_in, 
-                __u64             ignore_bits_in,
-                lnet_unlink_t     unlink_in, 
-                lnet_ins_pos_t    position_in,
-                lnet_handle_me_t *handle_out);
-
-int LNetMEUnlink(lnet_handle_me_t current_in);
+struct lnet_me *
+LNetMEAttach(unsigned int portal,
+            struct lnet_processid *match_id_in,
+            __u64 match_bits_in,
+            __u64 ignore_bits_in,
+            enum lnet_unlink unlink_in,
+            enum lnet_ins_pos pos_in);
 /** @} lnet_me */
 
 /** \defgroup lnet_md Memory descriptors
@@ -130,80 +115,42 @@ int LNetMEUnlink(lnet_handle_me_t current_in);
  * and LNetMDBind(); one operation to unlink and release the resources
  * associated with a MD: LNetMDUnlink().
  * @{ */
-int LNetMDAttach(lnet_handle_me_t  current_in, 
-                lnet_md_t         md_in,
-                lnet_unlink_t     unlink_in, 
-                lnet_handle_md_t *handle_out);
-
-int LNetMDBind(lnet_md_t         md_in,
-              lnet_unlink_t     unlink_in, 
-              lnet_handle_md_t *handle_out);
-
-int LNetMDUnlink(lnet_handle_md_t md_in);
-/** @} lnet_md */
-
-/** \defgroup lnet_eq Events and event queues
- *
- * Event queues (abbreviated as EQ) are used to log operations performed on
- * local MDs. In particular, they signal the completion of a data transmission
- * into or out of a MD. They can also be used to hold acknowledgments for
- * completed PUT operations and indicate when a MD has been unlinked. Multiple
- * MDs can share a single EQ. An EQ may have an optional event handler
- * associated with it. If an event handler exists, it will be run for each
- * event that is deposited into the EQ.
- *
- * In addition to the lnet_handle_eq_t, the LNet API defines two types
- * associated with events: The ::lnet_event_kind_t defines the kinds of events
- * that can be stored in an EQ. The lnet_event_t defines a structure that
- * holds the information about with an event.
- *
- * There are five functions for dealing with EQs: LNetEQAlloc() is used to
- * create an EQ and allocate the resources needed, while LNetEQFree()
- * releases these resources and free the EQ. LNetEQGet() retrieves the next
- * event from an EQ, and LNetEQWait() can be used to block a process until
- * an EQ has at least one event. LNetEQPoll() can be used to test or wait
- * on multiple EQs.
- * @{ */
-int LNetEQAlloc(unsigned int       count_in,
-               lnet_eq_handler_t  handler,
-               lnet_handle_eq_t  *handle_out);
+int LNetMDAttach(struct lnet_me *current_in,
+                const struct lnet_md *md_in,
+                enum lnet_unlink unlink_in,
+                struct lnet_handle_md *md_handle_out);
 
-int LNetEQFree(lnet_handle_eq_t eventq_in);
+int LNetMDBind(const struct lnet_md *md_in,
+              enum lnet_unlink unlink_in,
+              struct lnet_handle_md *md_handle_out);
 
-int LNetEQGet(lnet_handle_eq_t  eventq_in, 
-             lnet_event_t     *event_out);
+int __LNetMDUnlink(struct lnet_handle_md md_in, bool discard);
+#define LNetMDUnlink(handle) __LNetMDUnlink(handle, false)
 
-
-int LNetEQWait(lnet_handle_eq_t  eventq_in, 
-              lnet_event_t     *event_out);
-
-int LNetEQPoll(lnet_handle_eq_t *eventqs_in, 
-              int               neq_in, 
-              int               timeout_ms,
-              lnet_event_t     *event_out, 
-              int              *which_eq_out);
-/** @} lnet_eq */
+void lnet_assert_handler_unused(lnet_handler_t handler);
+/** @} lnet_md */
 
 /** \defgroup lnet_data Data movement operations
  *
  * The LNet API provides two data movement operations: LNetPut()
  * and LNetGet().
  * @{ */
-int LNetPut(lnet_nid_t        self,
-           lnet_handle_md_t  md_in, 
-           lnet_ack_req_t    ack_req_in,
-           lnet_process_id_t target_in, 
+int LNetPut(lnet_nid_t       self,
+           struct lnet_handle_md md_in,
+           enum lnet_ack_req   ack_req_in,
+           struct lnet_process_id target_in,
            unsigned int      portal_in,
-           __u64             match_bits_in,
-           unsigned int      offset_in, 
-           __u64             hdr_data_in);
-
-int LNetGet(lnet_nid_t        self,
-           lnet_handle_md_t  md_in, 
-           lnet_process_id_t target_in,
-           unsigned int      portal_in, 
-           __u64             match_bits_in, 
-           unsigned int      offset_in);
+           __u64             match_bits_in,
+           unsigned int      offset_in,
+           __u64             hdr_data_in);
+
+int LNetGet(lnet_nid_t       self,
+           struct lnet_handle_md md_in,
+           struct lnet_process_id target_in,
+           unsigned int      portal_in,
+           __u64             match_bits_in,
+           unsigned int      offset_in,
+           bool              recovery);
 /** @} lnet_data */
 
 
@@ -214,15 +161,10 @@ int LNetGet(lnet_nid_t        self,
 int LNetSetLazyPortal(int portal);
 int LNetClearLazyPortal(int portal);
 int LNetCtl(unsigned int cmd, void *arg);
-int LNetSetAsync(lnet_process_id_t id, int nasync);
+void LNetDebugPeer(struct lnet_process_id id);
+int LNetGetPeerDiscoveryStatus(void);
+int LNetAddPeer(lnet_nid_t *nids, __u32 num_nids);
 
-#ifndef __KERNEL__
-/* Temporary workaround to allow uOSS and test programs force server
- * mode in userspace. See comments near ln_server_mode_flag in
- * lnet/lib-types.h */
-
-void lnet_server_mode();
-#endif
 /** @} lnet_misc */
 
 /** @} lnet */