/usr/include/infiniband/opensm/osm_partition.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 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 | /*
* Copyright (c) 2004-2009 Voltaire, Inc. All rights reserved.
* Copyright (c) 2002-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_prtn_t.
* This object represents an IBA Partition.
* This object is part of the OpenSM family of objects.
*/
#ifndef _OSM_PARTITION_H_
#define _OSM_PARTITION_H_
#include <iba/ib_types.h>
#include <complib/cl_qmap.h>
#include <complib/cl_map.h>
#include <opensm/osm_log.h>
#include <opensm/osm_subnet.h>
#include <opensm/osm_multicast.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/Partition
* NAME
* Partition
*
* DESCRIPTION
* The Partition object encapsulates the information needed by the
* OpenSM to manage Partitions. The OpenSM allocates one Partition
* object per Partition in the IBA subnet.
*
* The Partition 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
* Steve King, Intel
*
*********/
/****s* OpenSM: Partition/osm_prtn_t
* NAME
* osm_prtn_t
*
* DESCRIPTION
* Partition structure.
*
* The osm_prtn_t object should be treated as opaque and should
* be manipulated only through the provided functions.
*
* SYNOPSIS
*/
typedef struct osm_prtn {
cl_map_item_t map_item;
ib_net16_t pkey;
uint8_t sl;
cl_map_t full_guid_tbl;
cl_map_t part_guid_tbl;
char name[32];
osm_mgrp_t **mgrps;
int nmgrps;
} osm_prtn_t;
/*
* FIELDS
* map_item
* Linkage structure for cl_qmap. MUST BE FIRST MEMBER!
*
* pkey
* The IBA defined P_KEY of this Partition.
*
* sl
* The Service Level (SL) associated with this Partiton.
*
* full_guid_tbl
* Container of pointers to all Port objects in the Partition
* with full membership, indexed by port GUID.
*
* part_guid_tbl
* Container of pointers to all Port objects in the Partition
* with limited membership, indexed by port GUID.
*
* name
* Name of the Partition as specified in partition
* configuration.
*
* mgrps
* List of well known Multicast Groups
* that were created for this partition (when configured).
* This includes the IPoIB broadcast group.
*
* nmgrps
* Number of known Multicast Groups.
*
* SEE ALSO
* Partition
*********/
/****f* OpenSM: Partition/osm_prtn_delete
* NAME
* osm_prtn_delete
*
* DESCRIPTION
* This function destroys and deallocates a Partition object.
*
* SYNOPSIS
*/
void osm_prtn_delete(IN osm_subn_t * p_subn, IN OUT osm_prtn_t ** pp_prtn);
/*
* PARAMETERS
* pp_prtn
* [in][out] Pointer to a pointer to a Partition 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 Partition object.
*
* SEE ALSO
* Partition, osm_prtn_new
*********/
/****f* OpenSM: Partition/osm_prtn_new
* NAME
* osm_prtn_new
*
* DESCRIPTION
* This function allocates and initializes a Partition object.
*
* SYNOPSIS
*/
osm_prtn_t *osm_prtn_new(IN const char *name, IN uint16_t pkey);
/*
* PARAMETERS
* name
* [in] Partition name string
*
* pkey
* [in] Partition P_Key value
*
* RETURN VALUE
* Pointer to the initialize Partition object.
*
* NOTES
* Allows calling other partition methods.
*
* SEE ALSO
* Partition
*********/
/****f* OpenSM: Partition/osm_prtn_is_guid
* NAME
* osm_prtn_is_guid
*
* DESCRIPTION
* Indicates if a port is a member of the partition.
*
* SYNOPSIS
*/
static inline boolean_t osm_prtn_is_guid(IN const osm_prtn_t * p_prtn,
IN ib_net64_t guid)
{
return (cl_map_get(&p_prtn->full_guid_tbl, guid) != NULL) ||
(cl_map_get(&p_prtn->part_guid_tbl, guid) != NULL);
}
/*
* PARAMETERS
* p_prtn
* [in] Pointer to an osm_prtn_t object.
*
* guid
* [in] Port GUID.
*
* RETURN VALUES
* TRUE if the specified port GUID is a member of the partition,
* FALSE otherwise.
*
* NOTES
*
* SEE ALSO
*********/
/****f* OpenSM: Partition/osm_prtn_make_partitions
* NAME
* osm_prtn_make_partitions
*
* DESCRIPTION
* Makes all partitions in subnet.
*
* SYNOPSIS
*/
ib_api_status_t osm_prtn_make_partitions(IN osm_log_t * p_log,
IN osm_subn_t * p_subn);
/*
* PARAMETERS
* p_log
* [in] Pointer to a log object.
*
* p_subn
* [in] Pointer to subnet object.
*
* RETURN VALUES
* IB_SUCCESS value on success.
*
* NOTES
*
* SEE ALSO
*********/
/****f* OpenSM: Partition/osm_prtn_find_by_name
* NAME
* osm_prtn_find_by_name
*
* DESCRIPTION
* Fides partition by name.
*
* SYNOPSIS
*/
osm_prtn_t *osm_prtn_find_by_name(IN osm_subn_t * p_subn, IN const char *name);
/*
* PARAMETERS
* p_subn
* [in] Pointer to a subnet object.
*
* name
* [in] Required partition name.
*
* RETURN VALUES
* Pointer to the partition object on success.
*
* NOTES
*
* SEE ALSO
*********/
END_C_DECLS
#endif /* _OSM_PARTITION_H_ */
|