d6b92ffa99
kernel APIs. List of sources used: 1) rdma-core was cloned from "https://github.com/linux-rdma/rdma-core.git" Top commit d65138ef93af30b3ea249f3a84aa6a24ba7f8a75 2) OpenSM was cloned from git://git.openfabrics.org/~halr/opensm.git Top commit 85f841cf209f791c89a075048a907020e924528d 3) libibmad was cloned from "git://git.openfabrics.org/~iraweiny/libibmad.git" Tag 1.3.13 with some additional patches from Mellanox. 4) infiniband-diags was cloned from "git://git.openfabrics.org/~iraweiny/infiniband-diags.git" Tag 1.6.7 with some additional patches from Mellanox. Added the required Makefiles for building and installing. Sponsored by: Mellanox Technologies
300 lines
7.9 KiB
C
300 lines
7.9 KiB
C
/*
|
|
* Copyright (c) 2004, 2005 Voltaire, Inc. All rights reserved.
|
|
* Copyright (c) 2002-2005 Mellanox Technologies LTD. All rights reserved.
|
|
* Copyright (c) 1996-2003 Intel Corporation. All rights reserved.
|
|
*
|
|
* This software is available to you under a choice of one of two
|
|
* licenses. You may choose to be licensed under the terms of the GNU
|
|
* General Public License (GPL) Version 2, available from the file
|
|
* COPYING in the main directory of this source tree, or the
|
|
* OpenIB.org BSD license below:
|
|
*
|
|
* Redistribution and use in source and binary forms, with or
|
|
* without modification, are permitted provided that the following
|
|
* conditions are met:
|
|
*
|
|
* - Redistributions of source code must retain the above
|
|
* copyright notice, this list of conditions and the following
|
|
* disclaimer.
|
|
*
|
|
* - Redistributions in binary form must reproduce the above
|
|
* copyright notice, this list of conditions and the following
|
|
* disclaimer in the documentation and/or other materials
|
|
* provided with the distribution.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*
|
|
*/
|
|
|
|
/*
|
|
* Abstract:
|
|
* Definition of interface for the MTL Vendor
|
|
* This object is part of the OpenSM family of objects.
|
|
*/
|
|
|
|
#ifndef _OSM_TRANSACTION_MGR_H_
|
|
#define _OSM_TRANSACTION_MGR_H_
|
|
|
|
/*
|
|
#include <vapi_types.h>
|
|
#include <evapi.h>
|
|
*/
|
|
|
|
#include <iba/ib_types.h>
|
|
#include <iba/ib_al.h>
|
|
#include <complib/cl_qlist.h>
|
|
#include <complib/cl_qmap.h>
|
|
#include <complib/cl_timer.h>
|
|
#include <complib/cl_thread.h>
|
|
#include <complib/cl_types_osd.h>
|
|
#include <complib/cl_spinlock.h>
|
|
#include <opensm/osm_base.h>
|
|
#include <opensm/osm_log.h>
|
|
#include <opensm/osm_madw.h>
|
|
#ifdef OSM_VENDOR_INTF_MTL
|
|
#include <ib_mgt.h>
|
|
#include <opensm/osm_mtl_bind.h>
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
# define BEGIN_C_DECLS extern "C" {
|
|
# define END_C_DECLS }
|
|
#else /* !__cplusplus */
|
|
# define BEGIN_C_DECLS
|
|
# define END_C_DECLS
|
|
#endif /* __cplusplus */
|
|
|
|
BEGIN_C_DECLS
|
|
/****s* OpenSM: Transaction Manager/osm_madw_req_t
|
|
* NAME
|
|
* osm_madw_req_t
|
|
*
|
|
* DESCRIPTION
|
|
* The structure defining each object in the transaction_mgr.
|
|
* For every request mad sent, we will save such an object for it.
|
|
*
|
|
* SYNOPSIS
|
|
*/
|
|
typedef struct _osm_madw_req {
|
|
cl_list_item_t list_item;
|
|
cl_map_item_t map_item;
|
|
osm_madw_t *p_madw;
|
|
uint64_t waking_time;
|
|
uint8_t retry_cnt;
|
|
osm_bind_handle_t *p_bind;
|
|
} osm_madw_req_t;
|
|
|
|
/*
|
|
* FIELDS
|
|
* list_item
|
|
* List item for qlist linkage. Must be first element!!
|
|
*
|
|
* map_item
|
|
* Map item for qmap linkage.
|
|
*
|
|
* p_madw
|
|
* pointer to mad wrapper that is expecting to get a response.
|
|
*
|
|
* waking_time
|
|
* Time stamp (in microseconds) when the p_madw needs to wake up.
|
|
* This value is
|
|
* cl_get_time_stamp() + timeout during the sending of the mad.
|
|
* where timeout should be given in microseconds.
|
|
*
|
|
* retry_cnt
|
|
* The number of outstanding retries to be called.
|
|
*********/
|
|
|
|
/****s* OpenSM: Transaction Manager/osm_transaction_mgr_t
|
|
* NAME
|
|
* osm_transaction_mgr_t
|
|
*
|
|
* DESCRIPTION
|
|
* This structure defines the transaction manager.
|
|
* It holds a qlist and a qmap, a lock on the transaction manager, and
|
|
* a timer used for the list.
|
|
* The manager is responsible for keeping track of every request mad that was
|
|
* sent. It is used for finding mads according to their transaction id, and for
|
|
* acting as an event wheel - reporting as error each packet was supposed to get
|
|
* a response and didn't get one by the timeout time expected.
|
|
*
|
|
* Both the list and the map hold the osm_madw_req_t objects - one for every madw.
|
|
*
|
|
* Managing of the list:
|
|
* The timer wakes on the timeout of the first madw. If the waking_time is greater than
|
|
* the current time - then the mad received a response. If not - the mad didn't get
|
|
* its response.
|
|
*
|
|
* SYNOPSIS
|
|
*/
|
|
typedef struct _osm_transaction_mgr {
|
|
cl_qmap_t *madw_by_tid_map_p;
|
|
cl_qlist_t *madw_reqs_list_p;
|
|
cl_spinlock_t transaction_mgr_lock;
|
|
cl_timer_t madw_list_timer;
|
|
} osm_transaction_mgr_t;
|
|
|
|
/*
|
|
* FIELDS
|
|
* madw_by_tid_map_p
|
|
* A qmap with key = transaction id. and value of osm_madw_req_t.
|
|
*
|
|
* madw_reqs_list_p
|
|
* A qlist of all the madw with their waking time.
|
|
*
|
|
* transaction_mgr_lock
|
|
* Lock used on the transaction manager - make sure changes on it are serial.
|
|
*
|
|
* madw_list_timer
|
|
* Timer on the list.
|
|
*********/
|
|
|
|
/****f* OpenSM: Transaction Manager/osm_transaction_mgr_init
|
|
* NAME
|
|
* osm_transaction_mgr_init
|
|
*
|
|
* DESCRIPTION
|
|
* Initialize the transaction manager.
|
|
* Will update the p_transaction_mgr in the vendor object with
|
|
* the new Transaction Manager created.*
|
|
*
|
|
* SYNOPSIS
|
|
*/
|
|
void osm_transaction_mgr_init(IN osm_vendor_t * const p_vend);
|
|
|
|
/*
|
|
* PARAMETERS
|
|
* p_vend
|
|
* [in] Pointer to a Osm Vendor object.
|
|
*
|
|
*********/
|
|
|
|
/****f* OpenSM: Transaction Manager/osm_transaction_mgr_destroy
|
|
* NAME
|
|
* osm_transaction_mgr_destroy
|
|
*
|
|
* DESCRIPTION
|
|
* Destroy the transaction manager.
|
|
* Will de-allocate all memory allocated by the Transaction
|
|
* Manager up to now.
|
|
*
|
|
* SYNOPSIS
|
|
*/
|
|
void osm_transaction_mgr_destroy(IN osm_vendor_t * const p_vend);
|
|
|
|
/*
|
|
* PARAMETERS
|
|
* p_vend
|
|
* [in] Pointer to a Osm Vendor object.
|
|
*
|
|
*********/
|
|
|
|
/****f* OpenSM: Transaction Manager/osm_transaction_mgr_insert_madw
|
|
* NAME
|
|
* osm_transaction_mgr_insert_madw
|
|
*
|
|
* DESCRIPTION
|
|
* Insert a new madw to the manager. The madw is added with a waking_time,
|
|
* Which is equal to the current_time + timeout. This is the maximum time
|
|
* that the madw can leave without being handled (e.g - get a response).
|
|
* If there are no madw saved in the manager - start the timer for vendor
|
|
* timeout period.
|
|
*
|
|
* SYNOPSIS
|
|
*/
|
|
ib_api_status_t
|
|
osm_transaction_mgr_insert_madw(IN osm_bind_handle_t * p_bind,
|
|
IN osm_madw_t * p_madw);
|
|
/*
|
|
* PARAMETERS
|
|
* p_vend
|
|
* [in] Pointer to a mtl bind object.
|
|
*
|
|
* p_madw
|
|
* [in] Pointer to the Mad Wrapper to be added.
|
|
*
|
|
*********/
|
|
|
|
/****f* OpenSM: Transaction Manager/osm_transaction_mgr_erase_madw
|
|
* NAME
|
|
* osm_transaction_mgr_erase_madw
|
|
*
|
|
* DESCRIPTION
|
|
* Erase a madw object from the manager.
|
|
* The removal is done using the transaction id of the mad - using
|
|
* it the madw_p is allocated (in the qmap) and removed from the
|
|
* qmap and qlist.
|
|
*
|
|
* SYNOPSIS
|
|
*/
|
|
ib_api_status_t
|
|
osm_transaction_mgr_erase_madw(IN osm_vendor_t * const p_vend,
|
|
IN ib_mad_t * p_mad);
|
|
/*
|
|
* PARAMETERS
|
|
* p_vend
|
|
* [in] Pointer to a Osm Vendor object.
|
|
*
|
|
* p_mad
|
|
* [in] Pointer to the Mad to be removed.
|
|
*
|
|
*********/
|
|
|
|
/****f* OpenSM: Transaction Manager/osm_transaction_mgr_get_madw_for_tid
|
|
* NAME
|
|
* osm_transaction_mgr_get_madw_for_tid
|
|
*
|
|
* DESCRIPTION
|
|
* Return the mad wrapper, given the p_mad (and in it the transaction id)
|
|
*
|
|
* SYNOPSIS
|
|
*/
|
|
ib_api_status_t
|
|
osm_transaction_mgr_get_madw_for_tid(IN osm_vendor_t * const p_vend,
|
|
IN ib_mad_t * const p_mad,
|
|
OUT osm_madw_t ** req_madw_p);
|
|
/*
|
|
* PARAMETERS
|
|
* p_vend
|
|
* [in] Pointer to a Osm Vendor object.
|
|
*
|
|
* p_mad
|
|
* [in] Pointer to the Mad to be located.
|
|
*
|
|
* req_madw_p
|
|
* [out] Pointer to the mad Wrapper to be found.
|
|
*
|
|
*********/
|
|
|
|
/****f* OpenSM: Transaction Manager/osm_transaction_mgr_callback
|
|
* NAME
|
|
* osm_transaction_mgr_callback
|
|
*
|
|
* DESCRIPTION
|
|
* This callback is called on timeout of the timer.
|
|
* It checks the time of the head madw in the qlist, and compares it to
|
|
* the current time.
|
|
* Will send an error callback if the time of the madw is less than the
|
|
* current time - this means that the madw wasn't removed in the timeout
|
|
* it was supposed to be handled.
|
|
*
|
|
* SYNOPSIS
|
|
*/
|
|
void osm_transaction_mgr_callback(IN void *context);
|
|
/*
|
|
* PARAMETERS
|
|
* context
|
|
* [in] void* context
|
|
*
|
|
*********/
|
|
|
|
END_C_DECLS
|
|
#endif /* _OSM_TRANSACTION_MGR_H_ */
|