/usr/include/infiniband/opensm/osm_router.h is in libopensm-dev 3.3.18-3.
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 | /*
* Copyright (c) 2004-2009 Voltaire, Inc. All rights reserved.
* Copyright (c) 2002-2005,2008 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:
* Declaration of osm_router_t.
* This object represents an IBA router.
* This object is part of the OpenSM family of objects.
*/
#ifndef _OSM_ROUTER_H_
#define _OSM_ROUTER_H_
#include <iba/ib_types.h>
#include <opensm/osm_base.h>
#include <opensm/osm_madw.h>
#include <opensm/osm_node.h>
#include <opensm/osm_port.h>
#include <opensm/osm_mcast_tbl.h>
#include <opensm/osm_port_profile.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
/****h* OpenSM/Router
* NAME
* Router
*
* DESCRIPTION
* The Router object encapsulates the information needed by the
* OpenSM to manage routers. The OpenSM allocates one router object
* per router in the IBA subnet.
*
* The Router object is not thread safe, thus callers must provide
* serialization.
*
* This object should be treated as opaque and should be
* manipulated only through the provided functions.
*
* AUTHOR
* Hal Rosenstock, Voltaire
*
*********/
/****s* OpenSM: Router/osm_router_t
* NAME
* osm_router_t
*
* DESCRIPTION
* Router structure.
*
* This object should be treated as opaque and should
* be manipulated only through the provided functions.
*
* SYNOPSIS
*/
typedef struct osm_router {
cl_map_item_t map_item;
osm_port_t *p_port;
} osm_router_t;
/*
* FIELDS
* map_item
* Linkage structure for cl_qmap. MUST BE FIRST MEMBER!
*
* p_port
* Pointer to the Port object for this router.
*
* SEE ALSO
* Router object
*********/
/****f* OpenSM: Router/osm_router_delete
* NAME
* osm_router_delete
*
* DESCRIPTION
* Destroys and deallocates the object.
*
* SYNOPSIS
*/
void osm_router_delete(IN OUT osm_router_t ** pp_rtr);
/*
* PARAMETERS
* p_rtr
* [in] Pointer to the object to destroy.
*
* RETURN VALUE
* None.
*
* NOTES
*
* SEE ALSO
* Router object, osm_router_new
*********/
/****f* OpenSM: Router/osm_router_new
* NAME
* osm_router_new
*
* DESCRIPTION
* The osm_router_new function initializes a Router object for use.
*
* SYNOPSIS
*/
osm_router_t *osm_router_new(IN osm_port_t * p_port);
/*
* PARAMETERS
* p_node
* [in] Pointer to the node object of this router
*
* RETURN VALUES
* Pointer to the new initialized router object.
*
* NOTES
*
* SEE ALSO
* Router object, osm_router_new
*********/
/****f* OpenSM: Router/osm_router_get_port_ptr
* NAME
* osm_router_get_port_ptr
*
* DESCRIPTION
* Returns a pointer to the Port object for this router.
*
* SYNOPSIS
*/
static inline osm_port_t *osm_router_get_port_ptr(IN const osm_router_t * p_rtr)
{
return p_rtr->p_port;
}
/*
* PARAMETERS
* p_rtr
* [in] Pointer to an osm_router_t object.
*
* RETURN VALUES
* Returns a pointer to the Port object for this router.
*
* NOTES
*
* SEE ALSO
* Router object
*********/
/****f* OpenSM: Router/osm_router_get_node_ptr
* NAME
* osm_router_get_node_ptr
*
* DESCRIPTION
* Returns a pointer to the Node object for this router.
*
* SYNOPSIS
*/
static inline osm_node_t *osm_router_get_node_ptr(IN const osm_router_t * p_rtr)
{
return p_rtr->p_port->p_node;
}
/*
* PARAMETERS
* p_rtr
* [in] Pointer to an osm_router_t object.
*
* RETURN VALUES
* Returns a pointer to the Node object for this router.
*
* NOTES
*
* SEE ALSO
* Router object
*********/
END_C_DECLS
#endif /* _OSM_ROUTER_H_ */
|