/usr/include/infiniband/opensm/osm_db_pack.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 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 | /*
* 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.
*
*/
/****h* OpenSM/DB-Pack
* NAME
* Database Types
*
* DESCRIPTION
* This module provides packing and unpacking of the database
* storage into specific types.
*
* The following domains/conversions are supported:
* guid2lid - key is a guid and data is a lid.
*
* AUTHOR
* Eitan Zahavi, Mellanox Technologies LTD
*
*********/
#ifndef _OSM_DB_PACK_H_
#define _OSM_DB_PACK_H_
#include <opensm/osm_db.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
/****f* OpenSM: DB-Pack/osm_db_guid2lid_init
* NAME
* osm_db_guid2lid_init
*
* DESCRIPTION
* Initialize a domain for the guid2lid table
*
* SYNOPSIS
*/
static inline osm_db_domain_t *osm_db_guid2lid_init(IN osm_db_t * p_db)
{
return (osm_db_domain_init(p_db, "guid2lid"));
}
/*
* PARAMETERS
* p_db
* [in] Pointer to the database object to construct
*
* RETURN VALUES
* The pointer to the new allocated domain object or NULL.
*
* NOTE: DB domains are destroyed by the osm_db_destroy
*
* SEE ALSO
* Database, osm_db_init, osm_db_destroy
*********/
/****f* OpenSM: DB-Pack/osm_db_guid2lid_init
* NAME
* osm_db_guid2lid_init
*
* DESCRIPTION
* Initialize a domain for the guid2lid table
*
* SYNOPSIS
*/
typedef struct osm_db_guid_elem {
cl_list_item_t item;
uint64_t guid;
} osm_db_guid_elem_t;
/*
* FIELDS
* item
* required for list manipulations
*
* guid
*
************/
/****f* OpenSM: DB-Pack/osm_db_guid2lid_guids
* NAME
* osm_db_guid2lid_guids
*
* DESCRIPTION
* Provides back a list of guid elements.
*
* SYNOPSIS
*/
int osm_db_guid2lid_guids(IN osm_db_domain_t * p_g2l,
OUT cl_qlist_t * p_guid_list);
/*
* PARAMETERS
* p_g2l
* [in] Pointer to the guid2lid domain
*
* p_guid_list
* [out] A quick list of guid elements of type osm_db_guid_elem_t
*
* RETURN VALUES
* 0 if successful
*
* NOTE: the output qlist should be initialized and each item freed
* by the caller, then destroyed.
*
* SEE ALSO
* osm_db_guid2lid_init, osm_db_guid2lid_guids, osm_db_guid2lid_get
* osm_db_guid2lid_set, osm_db_guid2lid_delete
*********/
/****f* OpenSM: DB-Pack/osm_db_guid2lid_get
* NAME
* osm_db_guid2lid_get
*
* DESCRIPTION
* Get a lid range by given guid.
*
* SYNOPSIS
*/
int osm_db_guid2lid_get(IN osm_db_domain_t * p_g2l, IN uint64_t guid,
OUT uint16_t * p_min_lid, OUT uint16_t * p_max_lid);
/*
* PARAMETERS
* p_g2l
* [in] Pointer to the guid2lid domain
*
* guid
* [in] The guid to look for
*
* p_min_lid
* [out] Pointer to the resulting min lid in host order.
*
* p_max_lid
* [out] Pointer to the resulting max lid in host order.
*
* RETURN VALUES
* 0 if successful. The lid will be set to 0 if not found.
*
* SEE ALSO
* osm_db_guid2lid_init, osm_db_guid2lid_guids
* osm_db_guid2lid_set, osm_db_guid2lid_delete
*********/
/****f* OpenSM: DB-Pack/osm_db_guid2lid_set
* NAME
* osm_db_guid2lid_set
*
* DESCRIPTION
* Set a lid range for the given guid.
*
* SYNOPSIS
*/
int osm_db_guid2lid_set(IN osm_db_domain_t * p_g2l, IN uint64_t guid,
IN uint16_t min_lid, IN uint16_t max_lid);
/*
* PARAMETERS
* p_g2l
* [in] Pointer to the guid2lid domain
*
* guid
* [in] The guid to look for
*
* min_lid
* [in] The min lid value to set
*
* max_lid
* [in] The max lid value to set
*
* RETURN VALUES
* 0 if successful
*
* SEE ALSO
* osm_db_guid2lid_init, osm_db_guid2lid_guids
* osm_db_guid2lid_get, osm_db_guid2lid_delete
*********/
/****f* OpenSM: DB-Pack/osm_db_guid2lid_delete
* NAME
* osm_db_guid2lid_delete
*
* DESCRIPTION
* Delete the entry by the given guid
*
* SYNOPSIS
*/
int osm_db_guid2lid_delete(IN osm_db_domain_t * p_g2l, IN uint64_t guid);
/*
* PARAMETERS
* p_g2l
* [in] Pointer to the guid2lid domain
*
* guid
* [in] The guid to look for
*
* RETURN VALUES
* 0 if successful otherwise 1
*
* SEE ALSO
* osm_db_guid2lid_init, osm_db_guid2lid_guids
* osm_db_guid2lid_get, osm_db_guid2lid_set
*********/
/****f* OpenSM: DB-Pack/osm_db_guid2mkey_init
* NAME
* osm_db_guid2mkey_init
*
* DESCRIPTION
* Initialize a domain for the guid2mkey table
*
* SYNOPSIS
*/
static inline osm_db_domain_t *osm_db_guid2mkey_init(IN osm_db_t * p_db)
{
return osm_db_domain_init(p_db, "guid2mkey");
}
/*
* PARAMETERS
* p_db
* [in] Pointer to the database object to construct
*
* RETURN VALUES
* The pointer to the new allocated domain object or NULL.
*
* NOTE: DB domains are destroyed by the osm_db_destroy
*
* SEE ALSO
* Database, osm_db_init, osm_db_destroy
*********/
/****f* OpenSM: DB-Pack/osm_db_guid2mkey_guids
* NAME
* osm_db_guid2mkey_guids
*
* DESCRIPTION
* Provides back a list of guid elements.
*
* SYNOPSIS
*/
int osm_db_guid2mkey_guids(IN osm_db_domain_t * p_g2m,
OUT cl_qlist_t * p_guid_list);
/*
* PARAMETERS
* p_g2l
* [in] Pointer to the guid2mkey domain
*
* p_guid_list
* [out] A quick list of guid elements of type osm_db_guid_elem_t
*
* RETURN VALUES
* 0 if successful
*
* NOTE: the output qlist should be initialized and each item freed
* by the caller, then destroyed.
*
* SEE ALSO
* osm_db_guid2mkey_init, osm_db_guid2mkey_guids, osm_db_guid2mkey_get
* osm_db_guid2mkey_set, osm_db_guid2mkey_delete
*********/
/****f* OpenSM: DB-Pack/osm_db_guid2mkey_get
* NAME
* osm_db_guid2mkey_get
*
* DESCRIPTION
* Get the mkey for the given guid.
*
* SYNOPSIS
*/
int osm_db_guid2mkey_get(IN osm_db_domain_t * p_g2m, IN uint64_t guid,
OUT uint64_t * p_mkey);
/*
* PARAMETERS
* p_g2m
* [in] Pointer to the guid2mkey domain
*
* guid
* [in] The guid to look for
*
* p_mkey
* [out] Pointer to the resulting mkey in host order.
*
* RETURN VALUES
* 0 if successful. The lid will be set to 0 if not found.
*
* SEE ALSO
* osm_db_guid2mkey_init, osm_db_guid2mkey_guids
* osm_db_guid2mkey_set, osm_db_guid2mkey_delete
*********/
/****f* OpenSM: DB-Pack/osm_db_guid2mkey_set
* NAME
* osm_db_guid2mkey_set
*
* DESCRIPTION
* Set the mkey for the given guid.
*
* SYNOPSIS
*/
int osm_db_guid2mkey_set(IN osm_db_domain_t * p_g2m, IN uint64_t guid,
IN uint64_t mkey);
/*
* PARAMETERS
* p_g2m
* [in] Pointer to the guid2mkey domain
*
* guid
* [in] The guid to look for
*
* mkey
* [in] The mkey value to set, in host order
*
* RETURN VALUES
* 0 if successful
*
* SEE ALSO
* osm_db_guid2mkey_init, osm_db_guid2mkey_guids
* osm_db_guid2mkey_get, osm_db_guid2mkey_delete
*********/
/****f* OpenSM: DB-Pack/osm_db_guid2mkey_delete
* NAME
* osm_db_guid2mkey_delete
*
* DESCRIPTION
* Delete the entry by the given guid
*
* SYNOPSIS
*/
int osm_db_guid2mkey_delete(IN osm_db_domain_t * p_g2m, IN uint64_t guid);
/*
* PARAMETERS
* p_g2m
* [in] Pointer to the guid2mkey domain
*
* guid
* [in] The guid to look for
*
* RETURN VALUES
* 0 if successful otherwise 1
*
* SEE ALSO
* osm_db_guid2mkey_init, osm_db_guid2mkey_guids
* osm_db_guid2mkey_get, osm_db_guid2mkey_set
*********/
/****f* OpenSM: DB-Pack/osm_db_neighbor_init
* NAME
* osm_db_neighbor_init
*
* DESCRIPTION
* Initialize a domain for the neighbors table
*
* SYNOPSIS
*/
static inline osm_db_domain_t *osm_db_neighbor_init(IN osm_db_t * p_db)
{
return osm_db_domain_init(p_db, "neighbors");
}
/*
* PARAMETERS
* p_db
* [in] Pointer to the database object to construct
*
* RETURN VALUES
* The pointer to the new allocated domain object or NULL.
*
* NOTE: DB domains are destroyed by the osm_db_destroy
*
* SEE ALSO
* Database, osm_db_init, osm_db_destroy
*********/
/****f* OpenSM: DB-Pack/osm_db_neighbor_elem
* NAME
* osm_db_neighbor_elem
*
* DESCRIPTION
* Initialize a domain for the neighbor table
*
* SYNOPSIS
*/
typedef struct osm_db_neighbor_elem {
cl_list_item_t item;
uint64_t guid;
uint8_t portnum;
} osm_db_neighbor_elem_t;
/*
* FIELDS
* item
* required for list manipulations
*
* guid
* portnum
*
************/
/****f* OpenSM: DB-Pack/osm_db_neighbor_guids
* NAME
* osm_db_neighbor_guids
*
* DESCRIPTION
* Provides back a list of neighbor elements.
*
* SYNOPSIS
*/
int osm_db_neighbor_guids(IN osm_db_domain_t * p_neighbor,
OUT cl_qlist_t * p_guid_list);
/*
* PARAMETERS
* p_neighbor
* [in] Pointer to the neighbor domain
*
* p_guid_list
* [out] A quick list of neighbor elements of type osm_db_neighbor_elem_t
*
* RETURN VALUES
* 0 if successful
*
* NOTE: the output qlist should be initialized and each item freed
* by the caller, then destroyed.
*
* SEE ALSO
* osm_db_neighbor_init, osm_db_neighbor_guids, osm_db_neighbor_get
* osm_db_neighbor_set, osm_db_neighbor_delete
*********/
/****f* OpenSM: DB-Pack/osm_db_neighbor_get
* NAME
* osm_db_neighbor_get
*
* DESCRIPTION
* Get a neighbor's guid by given guid/port.
*
* SYNOPSIS
*/
int osm_db_neighbor_get(IN osm_db_domain_t * p_neighbor, IN uint64_t guid1,
IN uint8_t port1, OUT uint64_t * p_guid2,
OUT uint8_t * p_port2);
/*
* PARAMETERS
* p_neighbor
* [in] Pointer to the neighbor domain
*
* guid1
* [in] The guid to look for
*
* port1
* [in] The port to look for
*
* p_guid2
* [out] Pointer to the resulting guid of the neighboring port.
*
* p_port2
* [out] Pointer to the resulting port of the neighboring port.
*
* RETURN VALUES
* 0 if successful. The lid will be set to 0 if not found.
*
* SEE ALSO
* osm_db_neighbor_init, osm_db_neighbor_guids
* osm_db_neighbor_set, osm_db_neighbor_delete
*********/
/****f* OpenSM: DB-Pack/osm_db_neighbor_set
* NAME
* osm_db_neighbor_set
*
* DESCRIPTION
* Set up a relationship between two ports
*
* SYNOPSIS
*/
int osm_db_neighbor_set(IN osm_db_domain_t * p_neighbor, IN uint64_t guid1,
IN uint8_t port1, IN uint64_t guid2, IN uint8_t port2);
/*
* PARAMETERS
* p_neighbor
* [in] Pointer to the neighbor domain
*
* guid1
* [in] The first guid in the relationship
*
* port1
* [in] The first port in the relationship
*
* guid2
* [in] The second guid in the relationship
*
* port2
* [in] The second port in the relationship
*
* RETURN VALUES
* 0 if successful
*
* SEE ALSO
* osm_db_neighbor_init, osm_db_neighbor_guids
* osm_db_neighbor_get, osm_db_neighbor_delete
*********/
/****f* OpenSM: DB-Pack/osm_db_neighbor_delete
* NAME
* osm_db_neighbor_delete
*
* DESCRIPTION
* Delete the relationship between two ports
*
* SYNOPSIS
*/
int osm_db_neighbor_delete(IN osm_db_domain_t * p_neighbor,
IN uint64_t guid, IN uint8_t port);
/*
* PARAMETERS
* p_neighbor
* [in] Pointer to the neighbor domain
*
* guid
* [in] The guid to look for
*
* port
* [in] The port to look for
*
* RETURN VALUES
* 0 if successful otherwise 1
*
* SEE ALSO
* osm_db_neighbor_init, osm_db_neighbor_guids
* osm_db_neighbor_get, osm_db_neighbor_set
*********/
END_C_DECLS
#endif /* _OSM_DB_PACK_H_ */
|