|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* Copyright (c) 2008 Voltaire, Inc. All rights reserved.
|
|
Packit |
13e616 |
* Copyright (c) 2008 Mellanox Technologies LTD. All rights reserved.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* This software is available to you under a choice of one of two
|
|
Packit |
13e616 |
* licenses. You may choose to be licensed under the terms of the GNU
|
|
Packit |
13e616 |
* General Public License (GPL) Version 2, available from the file
|
|
Packit |
13e616 |
* COPYING in the main directory of this source tree, or the
|
|
Packit |
13e616 |
* OpenIB.org BSD license below:
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* Redistribution and use in source and binary forms, with or
|
|
Packit |
13e616 |
* without modification, are permitted provided that the following
|
|
Packit |
13e616 |
* conditions are met:
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* - Redistributions of source code must retain the above
|
|
Packit |
13e616 |
* copyright notice, this list of conditions and the following
|
|
Packit |
13e616 |
* disclaimer.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* - Redistributions in binary form must reproduce the above
|
|
Packit |
13e616 |
* copyright notice, this list of conditions and the following
|
|
Packit |
13e616 |
* disclaimer in the documentation and/or other materials
|
|
Packit |
13e616 |
* provided with the distribution.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
Packit |
13e616 |
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
Packit |
13e616 |
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
Packit |
13e616 |
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
Packit |
13e616 |
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
Packit |
13e616 |
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
Packit |
13e616 |
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
Packit |
13e616 |
* SOFTWARE.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* Abstract:
|
|
Packit |
13e616 |
* Header file that describes Unicast Cache functions.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* Environment:
|
|
Packit |
13e616 |
* Linux User Mode
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* $Revision: 1.4 $
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#ifndef _OSM_UCAST_CACHE_H_
|
|
Packit |
13e616 |
#define _OSM_UCAST_CACHE_H_
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#include <iba/ib_types.h>
|
|
Packit |
13e616 |
#include <complib/cl_qmap.h>
|
|
Packit |
13e616 |
#include <opensm/osm_switch.h>
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
#ifdef __cplusplus
|
|
Packit |
13e616 |
# define BEGIN_C_DECLS extern "C" {
|
|
Packit |
13e616 |
# define END_C_DECLS }
|
|
Packit |
13e616 |
#else /* !__cplusplus */
|
|
Packit |
13e616 |
# define BEGIN_C_DECLS
|
|
Packit |
13e616 |
# define END_C_DECLS
|
|
Packit |
13e616 |
#endif /* __cplusplus */
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
BEGIN_C_DECLS
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
struct osm_ucast_mgr;
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****h* OpenSM/Unicast Manager/Unicast Cache
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* Unicast Cache
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The Unicast Cache object encapsulates the information
|
|
Packit |
13e616 |
* needed to cache and write unicast routing of the subnet.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* The Unicast Cache object is NOT thread safe.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* This object should be treated as opaque and should be
|
|
Packit |
13e616 |
* manipulated only through the provided functions.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* AUTHOR
|
|
Packit |
13e616 |
* Yevgeny Kliteynik, Mellanox
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Unicast Cache/osm_ucast_cache_invalidate
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_ucast_cache_invalidate
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The osm_ucast_cache_invalidate function purges the
|
|
Packit |
13e616 |
* unicast cache and marks the cache as invalid.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
void osm_ucast_cache_invalidate(IN struct osm_ucast_mgr *p_mgr);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_mgr
|
|
Packit |
13e616 |
* [in] Pointer to the ucast mgr object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUE
|
|
Packit |
13e616 |
* This function does not return any value.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Unicast Manager object
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Unicast Cache/osm_ucast_cache_check_new_link
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_ucast_cache_check_new_link
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The osm_ucast_cache_check_new_link checks whether
|
|
Packit |
13e616 |
* the newly discovered link still allows us to use
|
|
Packit |
13e616 |
* cached unicast routing.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
void osm_ucast_cache_check_new_link(IN struct osm_ucast_mgr *p_mgr,
|
|
Packit |
13e616 |
IN osm_node_t * p_node_1,
|
|
Packit |
13e616 |
IN uint8_t port_num_1,
|
|
Packit |
13e616 |
IN osm_node_t * p_node_2,
|
|
Packit |
13e616 |
IN uint8_t port_num_2);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_mgr
|
|
Packit |
13e616 |
* [in] Pointer to the unicast manager object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* p_node_1
|
|
Packit |
13e616 |
* [in] Pointer to the first node of the link.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* port_num_1
|
|
Packit |
13e616 |
* [in] Port number of the first node.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* p_node_2
|
|
Packit |
13e616 |
* [in] Pointer to the second node of the link.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* port_num_2
|
|
Packit |
13e616 |
* [in] Port number of the second node.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUE
|
|
Packit |
13e616 |
* This function does not return any value.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
* The function checks whether the link was previously
|
|
Packit |
13e616 |
* cached/dropped or is this a completely new link.
|
|
Packit |
13e616 |
* If it decides that the new link makes cached routing
|
|
Packit |
13e616 |
* invalid, the cache is purged and marked as invalid.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Unicast Cache object
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Unicast Cache/osm_ucast_cache_add_link
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_ucast_cache_add_link
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The osm_ucast_cache_add_link adds link to the cache.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
void osm_ucast_cache_add_link(IN struct osm_ucast_mgr *p_mgr,
|
|
Packit |
13e616 |
IN osm_physp_t * physp1,
|
|
Packit |
13e616 |
IN osm_physp_t * physp2);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_mgr
|
|
Packit |
13e616 |
* [in] Pointer to the unicast manager object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* physp1
|
|
Packit |
13e616 |
* [in] Pointer to the first physical port of the link.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* physp2
|
|
Packit |
13e616 |
* [in] Pointer to the second physical port of the link.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUE
|
|
Packit |
13e616 |
* This function does not return any value.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
* Since the cache operates with ports and not links,
|
|
Packit |
13e616 |
* the function adds two port entries (both sides of the
|
|
Packit |
13e616 |
* link) to the cache.
|
|
Packit |
13e616 |
* If it decides that the dropped link makes cached routing
|
|
Packit |
13e616 |
* invalid, the cache is purged and marked as invalid.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Unicast Manager object
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Unicast Cache/osm_ucast_cache_add_node
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_ucast_cache_add_node
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The osm_ucast_cache_add_node adds node and all
|
|
Packit |
13e616 |
* its links to the cache.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
void osm_ucast_cache_add_node(IN struct osm_ucast_mgr *p_mgr,
|
|
Packit |
13e616 |
IN osm_node_t * p_node);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_mgr
|
|
Packit |
13e616 |
* [in] Pointer to the unicast manager object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* p_node
|
|
Packit |
13e616 |
* [in] Pointer to the node object that should be cached.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUE
|
|
Packit |
13e616 |
* This function does not return any value.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
* If the function decides that the dropped node makes cached
|
|
Packit |
13e616 |
* routing invalid, the cache is purged and marked as invalid.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Unicast Manager object
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
/****f* OpenSM: Unicast Cache/osm_ucast_cache_process
|
|
Packit |
13e616 |
* NAME
|
|
Packit |
13e616 |
* osm_ucast_cache_process
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* DESCRIPTION
|
|
Packit |
13e616 |
* The osm_ucast_cache_process function writes the
|
|
Packit |
13e616 |
* cached unicast routing on the subnet switches.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SYNOPSIS
|
|
Packit |
13e616 |
*/
|
|
Packit |
13e616 |
int osm_ucast_cache_process(IN struct osm_ucast_mgr *p_mgr);
|
|
Packit |
13e616 |
/*
|
|
Packit |
13e616 |
* PARAMETERS
|
|
Packit |
13e616 |
* p_mgr
|
|
Packit |
13e616 |
* [in] Pointer to the unicast manager object.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* RETURN VALUE
|
|
Packit |
13e616 |
* This function returns zero on sucess and non-zero
|
|
Packit |
13e616 |
* value otherwise.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* NOTES
|
|
Packit |
13e616 |
* Iterates through all the subnet switches and writes
|
|
Packit |
13e616 |
* the LFTs that were calculated during the last routing
|
|
Packit |
13e616 |
* engine execution to the switches.
|
|
Packit |
13e616 |
*
|
|
Packit |
13e616 |
* SEE ALSO
|
|
Packit |
13e616 |
* Unicast Manager object
|
|
Packit |
13e616 |
*********/
|
|
Packit |
13e616 |
|
|
Packit |
13e616 |
END_C_DECLS
|
|
Packit |
13e616 |
#endif /* _OSM_UCAST_CACHE_H_ */
|