/usr/include/infiniband/opensm/osm_remote_sm.h is in libopensm-dev 3.3.15-2.
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 | /*
* 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_t, osm_remote_sm_t.
* This object represents an IBA subnet.
* This object is part of the OpenSM family of objects.
*/
#ifndef _OSM_REMOTE_SM_H_
#define _OSM_REMOTE_SM_H_
#include <iba/ib_types.h>
#include <opensm/osm_base.h>
#include <opensm/osm_port.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/Remote SM
* NAME
* Remote SM
*
* DESCRIPTION
* The Remote SM object encapsulates the information tracked for
* other SM ports on the subnet.
*
* The Remote SM 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: Remote SM/osm_remote_sm_t
* NAME
* osm_remote_sm_t
*
* DESCRIPTION
* Remote Subnet Manager structure.
*
* This object should be treated as opaque and should
* be manipulated only through the provided functions.
*
* SYNOPSIS
*/
typedef struct osm_remote_sm {
cl_map_item_t map_item;
ib_sm_info_t smi;
} osm_remote_sm_t;
/*
* FIELDS
* map_item
* Linkage for the cl_qmap container. MUST BE FIRST ELEMENT!!
* p_port
* Pointer to the port object for this SM.
*
* smi
* The SMInfo attribute for this SM.
*
* SEE ALSO
*********/
/****f* OpenSM: SM/osm_remote_sm_construct
* NAME
* osm_remote_sm_construct
*
* DESCRIPTION
* This function constructs an Remote SM object.
*
* SYNOPSIS
*/
void osm_remote_sm_construct(IN osm_remote_sm_t * p_sm);
/*
* PARAMETERS
* p_sm
* [in] Pointer to an Remote SM object to construct.
*
* RETURN VALUE
* This function does not return a value.
*
* NOTES
* Allows calling osm_remote_sm_init, osm_remote_sm_destroy
*
* Calling osm_remote_sm_construct is a prerequisite to calling any other
* method except osm_remote_sm_init.
*
* SEE ALSO
* SM object, osm_remote_sm_init, osm_remote_sm_destroy
*********/
/****f* OpenSM: SM/osm_remote_sm_destroy
* NAME
* osm_remote_sm_destroy
*
* DESCRIPTION
* The osm_remote_sm_destroy function destroys an SM, releasing
* all resources.
*
* SYNOPSIS
*/
void osm_remote_sm_destroy(IN osm_remote_sm_t * p_sm);
/*
* PARAMETERS
* p_sm
* [in] Pointer to an Remote SM object to destroy.
*
* RETURN VALUE
* This function does not return a value.
*
* NOTES
* Performs any necessary cleanup of the specified Remote SM object.
* Further operations should not be attempted on the destroyed object.
* This function should only be called after a call to
* osm_remote_sm_construct or osm_remote_sm_init.
*
* SEE ALSO
* Remote SM object, osm_remote_sm_construct, osm_remote_sm_init
*********/
/****f* OpenSM: SM/osm_remote_sm_init
* NAME
* osm_remote_sm_init
*
* DESCRIPTION
* The osm_remote_sm_init function initializes an Remote SM object for use.
*
* SYNOPSIS
*/
void osm_remote_sm_init(IN osm_remote_sm_t * p_sm, IN const ib_sm_info_t * p_smi);
/*
* PARAMETERS
* p_sm
* [in] Pointer to an osm_remote_sm_t object to initialize.
*
* p_port
* [in] Pointer to the Remote SM's port object.
*
* p_smi
* [in] Pointer to the SMInfo attribute for this SM.
*
* RETURN VALUES
* This function does not return a value.
*
* NOTES
* Allows calling other Remote SM methods.
*
* SEE ALSO
* Remote SM object, osm_remote_sm_construct, osm_remote_sm_destroy
*********/
END_C_DECLS
#endif /* _OSM_REMOTE_SM_H_ */
|