/usr/include/infiniband/opensm/osm_ucast_cache.h is in libopensm-dev 3.3.20-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 | /*
* Copyright (c) 2008 Voltaire, Inc. All rights reserved.
* Copyright (c) 2008 Mellanox Technologies LTD. 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:
* Header file that describes Unicast Cache functions.
*
* Environment:
* Linux User Mode
*
* $Revision: 1.4 $
*/
#ifndef _OSM_UCAST_CACHE_H_
#define _OSM_UCAST_CACHE_H_
#include <iba/ib_types.h>
#include <complib/cl_qmap.h>
#include <opensm/osm_switch.h>
#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
struct osm_ucast_mgr;
/****h* OpenSM/Unicast Manager/Unicast Cache
* NAME
* Unicast Cache
*
* DESCRIPTION
* The Unicast Cache object encapsulates the information
* needed to cache and write unicast routing of the subnet.
*
* The Unicast Cache object is NOT thread safe.
*
* This object should be treated as opaque and should be
* manipulated only through the provided functions.
*
* AUTHOR
* Yevgeny Kliteynik, Mellanox
*
*********/
/****f* OpenSM: Unicast Cache/osm_ucast_cache_invalidate
* NAME
* osm_ucast_cache_invalidate
*
* DESCRIPTION
* The osm_ucast_cache_invalidate function purges the
* unicast cache and marks the cache as invalid.
*
* SYNOPSIS
*/
void osm_ucast_cache_invalidate(struct osm_ucast_mgr *p_mgr);
/*
* PARAMETERS
* p_mgr
* [in] Pointer to the ucast mgr object.
*
* RETURN VALUE
* This function does not return any value.
*
* NOTES
*
* SEE ALSO
* Unicast Manager object
*********/
/****f* OpenSM: Unicast Cache/osm_ucast_cache_check_new_link
* NAME
* osm_ucast_cache_check_new_link
*
* DESCRIPTION
* The osm_ucast_cache_check_new_link checks whether
* the newly discovered link still allows us to use
* cached unicast routing.
*
* SYNOPSIS
*/
void osm_ucast_cache_check_new_link(struct osm_ucast_mgr *p_mgr,
osm_node_t * p_node_1, uint8_t port_num_1,
osm_node_t * p_node_2, uint8_t port_num_2);
/*
* PARAMETERS
* p_mgr
* [in] Pointer to the unicast manager object.
*
* physp1
* [in] Pointer to the first physical port of the link.
*
* physp2
* [in] Pointer to the second physical port of the link.
*
* RETURN VALUE
* This function does not return any value.
*
* NOTES
* The function checks whether the link was previously
* cached/dropped or is this a completely new link.
* If it decides that the new link makes cached routing
* invalid, the cache is purged and marked as invalid.
*
* SEE ALSO
* Unicast Cache object
*********/
/****f* OpenSM: Unicast Cache/osm_ucast_cache_add_link
* NAME
* osm_ucast_cache_add_link
*
* DESCRIPTION
* The osm_ucast_cache_add_link adds link to the cache.
*
* SYNOPSIS
*/
void osm_ucast_cache_add_link(struct osm_ucast_mgr *p_mgr,
osm_physp_t * physp1, osm_physp_t * physp2);
/*
* PARAMETERS
* p_mgr
* [in] Pointer to the unicast manager object.
*
* physp1
* [in] Pointer to the first physical port of the link.
*
* physp2
* [in] Pointer to the second physical port of the link.
*
* RETURN VALUE
* This function does not return any value.
*
* NOTES
* Since the cache operates with ports and not links,
* the function adds two port entries (both sides of the
* link) to the cache.
* If it decides that the dropped link makes cached routing
* invalid, the cache is purged and marked as invalid.
*
* SEE ALSO
* Unicast Manager object
*********/
/****f* OpenSM: Unicast Cache/osm_ucast_cache_add_node
* NAME
* osm_ucast_cache_add_node
*
* DESCRIPTION
* The osm_ucast_cache_add_node adds node and all
* its links to the cache.
*
* SYNOPSIS
*/
void osm_ucast_cache_add_node(struct osm_ucast_mgr *p_mgr, osm_node_t * p_node);
/*
* PARAMETERS
* p_mgr
* [in] Pointer to the unicast manager object.
*
* p_node
* [in] Pointer to the node object that should be cached.
*
* RETURN VALUE
* This function does not return any value.
*
* NOTES
* If the function decides that the dropped node makes cached
* routing invalid, the cache is purged and marked as invalid.
*
* SEE ALSO
* Unicast Manager object
*********/
/****f* OpenSM: Unicast Cache/osm_ucast_cache_process
* NAME
* osm_ucast_cache_process
*
* DESCRIPTION
* The osm_ucast_cache_process function writes the
* cached unicast routing on the subnet switches.
*
* SYNOPSIS
*/
int osm_ucast_cache_process(struct osm_ucast_mgr *p_mgr);
/*
* PARAMETERS
* p_mgr
* [in] Pointer to the unicast manager object.
*
* RETURN VALUE
* This function returns zero on sucess and non-zero
* value otherwise.
*
* NOTES
* Iterates through all the subnet switches and writes
* the LFTs that were calculated during the last routing
* engine execution to the switches.
*
* SEE ALSO
* Unicast Manager object
*********/
END_C_DECLS
#endif /* _OSM_UCAST_CACHE_H_ */
|