/usr/include/infiniband/opensm/osm_sm_mad_ctrl.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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 | /*
* Copyright (c) 2004-2009 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:
* Declaration of osm_sm_mad_ctrl_t.
* This object represents a controller that receives the IBA NodeInfo
* attribute from a node.
* This object is part of the OpenSM family of objects.
*/
#ifndef _OSM_SM_MAD_CTRL_H_
#define _OSM_SM_MAD_CTRL_H_
#include <complib/cl_passivelock.h>
#include <complib/cl_dispatcher.h>
#include <opensm/osm_base.h>
#include <opensm/osm_stats.h>
#include <opensm/osm_madw.h>
#include <opensm/osm_mad_pool.h>
#include <opensm/osm_subnet.h>
#include <opensm/osm_log.h>
#include <opensm/osm_vl15intf.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/SM MAD Controller
* NAME
* SM MAD Controller
*
* DESCRIPTION
* The SM MAD Controller object encapsulates
* the information needed to receive MADs from the transport layer.
*
* The SM MAD Controller object is thread safe.
*
* This object should be treated as opaque and should be
* manipulated only through the provided functions.
*
* AUTHOR
* Steve King, Intel
*
*********/
/****s* OpenSM: SM MAD Controller/osm_sm_mad_ctrl_t
* NAME
* osm_sm_mad_ctrl_t
*
* DESCRIPTION
* SM MAD Controller structure.
*
* This object should be treated as opaque and should
* be manipulated only through the provided functions.
*
* SYNOPSIS
*/
typedef struct osm_sm_mad_ctrl {
osm_log_t *p_log;
osm_subn_t *p_subn;
osm_mad_pool_t *p_mad_pool;
osm_vl15_t *p_vl15;
osm_vendor_t *p_vendor;
osm_bind_handle_t h_bind;
cl_plock_t *p_lock;
cl_dispatcher_t *p_disp;
cl_disp_reg_handle_t h_disp;
osm_stats_t *p_stats;
} osm_sm_mad_ctrl_t;
/*
* FIELDS
* p_log
* Pointer to the log object.
*
* p_subn
* Pointer to the subnet object.
*
* p_mad_pool
* Pointer to the MAD pool.
*
* p_vendor
* Pointer to the vendor specific interfaces object.
*
* h_bind
* Bind handle returned by the transport layer.
*
* p_lock
* Pointer to the serializing lock.
*
* p_disp
* Pointer to the Dispatcher.
*
* h_disp
* Handle returned from dispatcher registration.
*
* p_stats
* Pointer to the OpenSM statistics block.
*
* SEE ALSO
* SM MAD Controller object
* SM MADr object
*********/
/****f* OpenSM: SM MAD Controller/osm_sm_mad_ctrl_construct
* NAME
* osm_sm_mad_ctrl_construct
*
* DESCRIPTION
* This function constructs a SM MAD Controller object.
*
* SYNOPSIS
*/
void osm_sm_mad_ctrl_construct(IN osm_sm_mad_ctrl_t * p_ctrl);
/*
* PARAMETERS
* p_ctrl
* [in] Pointer to a SM MAD Controller
* object to construct.
*
* RETURN VALUE
* This function does not return a value.
*
* NOTES
* Allows calling osm_sm_mad_ctrl_init, and osm_sm_mad_ctrl_destroy.
*
* Calling osm_sm_mad_ctrl_construct is a prerequisite to calling any other
* method except osm_sm_mad_ctrl_init.
*
* SEE ALSO
* SM MAD Controller object, osm_sm_mad_ctrl_init,
* osm_sm_mad_ctrl_destroy
*********/
/****f* OpenSM: SM MAD Controller/osm_sm_mad_ctrl_destroy
* NAME
* osm_sm_mad_ctrl_destroy
*
* DESCRIPTION
* The osm_sm_mad_ctrl_destroy function destroys the object, releasing
* all resources.
*
* SYNOPSIS
*/
void osm_sm_mad_ctrl_destroy(IN osm_sm_mad_ctrl_t * p_ctrl);
/*
* PARAMETERS
* p_ctrl
* [in] Pointer to the object to destroy.
*
* RETURN VALUE
* This function does not return a value.
*
* NOTES
* Performs any necessary cleanup of the specified
* SM MAD Controller object.
* Further operations should not be attempted on the destroyed object.
* This function should only be called after a call to
* osm_sm_mad_ctrl_construct or osm_sm_mad_ctrl_init.
*
* SEE ALSO
* SM MAD Controller object, osm_sm_mad_ctrl_construct,
* osm_sm_mad_ctrl_init
*********/
/****f* OpenSM: SM MAD Controller/osm_sm_mad_ctrl_init
* NAME
* osm_sm_mad_ctrl_init
*
* DESCRIPTION
* The osm_sm_mad_ctrl_init function initializes a
* SM MAD Controller object for use.
*
* SYNOPSIS
*/
ib_api_status_t osm_sm_mad_ctrl_init(IN osm_sm_mad_ctrl_t * p_ctrl,
IN osm_subn_t * p_subn,
IN osm_mad_pool_t * p_mad_pool,
IN osm_vl15_t * p_vl15,
IN osm_vendor_t * p_vendor,
IN osm_log_t * p_log,
IN osm_stats_t * p_stats,
IN cl_plock_t * p_lock,
IN cl_dispatcher_t * p_disp);
/*
* PARAMETERS
* p_ctrl
* [in] Pointer to an osm_sm_mad_ctrl_t object to initialize.
*
* p_mad_pool
* [in] Pointer to the MAD pool.
*
* p_vl15
* [in] Pointer to the VL15 interface object.
*
* p_vendor
* [in] Pointer to the vendor specific interfaces object.
*
* p_log
* [in] Pointer to the log object.
*
* p_stats
* [in] Pointer to the OpenSM stastics block.
*
* p_lock
* [in] Pointer to the OpenSM serializing lock.
*
* p_disp
* [in] Pointer to the OpenSM central Dispatcher.
*
* RETURN VALUES
* IB_SUCCESS if the SM MAD Controller object was initialized
* successfully.
*
* NOTES
* Allows calling other SM MAD Controller methods.
*
* SEE ALSO
* SM MAD Controller object, osm_sm_mad_ctrl_construct,
* osm_sm_mad_ctrl_destroy
*********/
/****f* OpenSM: SM/osm_sm_mad_ctrl_bind
* NAME
* osm_sm_mad_ctrl_bind
*
* DESCRIPTION
* Binds the SM MAD Controller object to a port guid.
*
* SYNOPSIS
*/
ib_api_status_t osm_sm_mad_ctrl_bind(IN osm_sm_mad_ctrl_t * p_ctrl,
IN ib_net64_t port_guid);
/*
* PARAMETERS
* p_ctrl
* [in] Pointer to an osm_sm_mad_ctrl_t object to initialize.
*
* port_guid
* [in] Local port GUID with which to bind.
*
*
* RETURN VALUES
* None
*
* NOTES
* A given SM MAD Controller object can only be bound to one
* port at a time.
*
* SEE ALSO
*********/
/****f* OpenSM: SM/osm_sm_mad_ctrl_get_bind_handle
* NAME
* osm_sm_mad_ctrl_get_bind_handle
*
* DESCRIPTION
* Returns the bind handle.
*
* SYNOPSIS
*/
static inline osm_bind_handle_t
osm_sm_mad_ctrl_get_bind_handle(IN const osm_sm_mad_ctrl_t * p_ctrl)
{
return p_ctrl->h_bind;
}
/*
* PARAMETERS
* p_ctrl
* [in] Pointer to an osm_sm_mad_ctrl_t object.
*
* RETURN VALUES
* Returns the bind handle, which may be OSM_BIND_INVALID_HANDLE
* if no port has been bound.
*
* NOTES
* A given SM MAD Controller object can only be bound to one
* port at a time.
*
* SEE ALSO
*********/
END_C_DECLS
#endif /* _OSM_SM_MAD_CTRL_H_ */
|