/usr/include/infiniband/opensm/osm_mcm_port.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 | /*
* Copyright (c) 2004-2009 Voltaire, Inc. All rights reserved.
* Copyright (c) 2002-2012 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_mcm_port_t.
* This object represents the membership of a port in a multicast group.
* This object is part of the OpenSM family of objects.
*/
#ifndef _OSM_MCM_PORT_H_
#define _OSM_MCM_PORT_H_
#include <iba/ib_types.h>
#include <complib/cl_qmap.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
struct osm_mgrp;
/****s* OpenSM: MCM Port Object/osm_mcm_port_t
* NAME
* osm_mcm_port_t
*
* DESCRIPTION
* This object represents a particular port as a member of a
* multicast group.
*
* This object should be treated as opaque and should
* be manipulated only through the provided functions.
*
* SYNOPSIS
*/
typedef struct osm_mcm_port {
cl_map_item_t map_item;
cl_list_item_t list_item;
osm_port_t *port;
struct osm_mgrp *mgrp;
} osm_mcm_port_t;
/*
* FIELDS
* map_item
* Map Item for qmap linkage. Must be first element!!
*
* list_item
* Linkage structure for cl_qlist.
*
* port
* Reference to the parent port
*
* mgrp
* The pointer to multicast group where this port is member of
*
* SEE ALSO
* MCM Port Object
*********/
/****f* OpenSM: MCM Port Object/osm_mcm_port_new
* NAME
* osm_mcm_port_new
*
* DESCRIPTION
* The osm_mcm_port_new function allocates and initializes a
* MCM Port Object for use.
*
* SYNOPSIS
*/
osm_mcm_port_t *osm_mcm_port_new(IN osm_port_t * port, IN struct osm_mgrp *mgrp);
/*
* PARAMETERS
* port
* [in] Pointer to the port object
*
* mgrp
* [in] Pointer to multicast group where this port is joined
*
* RETURN VALUES
* Pointer to the allocated and initialized MCM Port object.
*
* NOTES
*
* SEE ALSO
* MCM Port Object, osm_mcm_port_delete,
*********/
/****f* OpenSM: MCM Port Object/osm_mcm_port_delete
* NAME
* osm_mcm_port_delete
*
* DESCRIPTION
* The osm_mcm_port_delete function destroys and dellallocates an
* MCM Port Object, releasing all resources.
*
* SYNOPSIS
*/
void osm_mcm_port_delete(IN osm_mcm_port_t * p_mcm);
/*
* PARAMETERS
* p_mcm
* [in] Pointer to a MCM Port Object to delete.
*
* RETURN VALUE
* This function does not return a value.
*
* NOTES
*
* SEE ALSO
* MCM Port Object, osm_mcm_port_new
*********/
/****s* OpenSM: MCM Port Object/osm_mcm_alias_guid_t
* NAME
* osm_mcm_alias_guid_t
*
* DESCRIPTION
* This object represents an alias guid for a mcm port.
*
* The osm_mcm_alias_guid_t object should be treated as opaque and should
* be manipulated only through the provided functions.
*
* SYNOPSIS
*/
typedef struct osm_mcm_alias_guid {
cl_map_item_t map_item;
ib_net64_t alias_guid;
osm_mcm_port_t *p_base_mcm_port;
ib_gid_t port_gid;
uint8_t scope_state;
boolean_t proxy_join;
} osm_mcm_alias_guid_t;
/*
* FIELDS
* map_item
* Linkage structure for cl_qmap. MUST BE FIRST MEMBER!
*
* alias_guid
* Alias GUID for port obtained from SM GUIDInfo attribute
*
* p_base_mcm_port
* Pointer to osm_mcm_port_t for base port GUID
*
* port_gid
* GID of the member port
*
* scope_state
*
* proxy_join
* If FALSE - Join was performed by the endport identified
* by PortGID. If TRUE - Join was performed on behalf of
* the endport identified by PortGID by another port within
* the same partition.
*
* SEE ALSO
* MCM Port, Physical Port, Physical Port Table
*/
/****f* OpenSM: MCM Port Object/osm_mcm_alias_guid_new
* NAME
* osm_mcm_alias_guid_new
*
* DESCRIPTION
* This function allocates and initializes an mcm alias guid object.
*
* SYNOPSIS
*/
osm_mcm_alias_guid_t *osm_mcm_alias_guid_new(IN osm_mcm_port_t *p_base_mcm_port,
IN ib_member_rec_t *mcmr,
IN boolean_t proxy);
/*
* PARAMETERS
* p_base_mcm_port
* [in] Pointer to the mcm port for this base GUID
*
* mcmr
* [in] Pointer to MCMember record of the join request
*
* proxy
* [in] proxy_join state analyzed from the request
*
* RETURN VALUE
* Pointer to the initialized mcm alias guid object.
*
* NOTES
* Allows calling other mcm alias guid methods.
*
* SEE ALSO
* MCM Port Object
*********/
/****f* OpenSM: MCM Port Object/osm_mcm_alias_guid_delete
* NAME
* osm_mcm_alias_guid_delete
*
* DESCRIPTION
* This function destroys and deallocates an mcm alias guid object.
*
* SYNOPSIS
*/
void osm_mcm_alias_guid_delete(IN OUT osm_mcm_alias_guid_t ** pp_mcm_alias_guid);
/*
* PARAMETERS
* pp_mcm_alias_guid
* [in][out] Pointer to a pointer to an mcm alias guid object to
* delete. On return, this pointer is NULL.
*
* RETURN VALUE
* This function does not return a value.
*
* NOTES
* Performs any necessary cleanup of the specified mcm alias guid object.
*
* SEE ALSO
* MCM Port Object
*********/
END_C_DECLS
#endif /* _OSM_MCM_PORT_H_ */
|