xref: /freebsd/contrib/ofed/opensm/include/complib/cl_nodenamemap.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1 /*
2  * Copyright (c) 2008 Voltaire, Inc. All rights reserved.
3  * Copyright (c) 2007 Lawrence Livermore National Lab
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  *
33  */
34 
35 #ifndef _CL_NODE_NAME_MAP_H_
36 #define _CL_NODE_NAME_MAP_H_
37 
38 #include <stdio.h>
39 #include <stdint.h>
40 #include <complib/cl_qmap.h>
41 
42 /* NOTE: this may modify the parameter "nodedesc". */
43 char *clean_nodedesc(char *nodedesc);
44 
45 typedef struct _name_map_item {
46 	cl_map_item_t item;
47 	uint64_t guid;
48 	char *name;
49 } name_map_item_t;
50 
51 typedef cl_qmap_t nn_map_t;
52 
53 /**
54  * Node name map interface.
55  * It is OK to pass NULL for the node_name_map[_fp] parameters.
56  */
57 nn_map_t *open_node_name_map(const char *node_name_map);
58 void  close_node_name_map(nn_map_t *map);
59 char *remap_node_name(nn_map_t *map, uint64_t target_guid, char *nodedesc);
60 	/* NOTE: parameter "nodedesc" may be modified here. */
61 int parse_node_map(const char *file_name,
62 		   int (*create)(void *, uint64_t, char *), void *cxt);
63 
64 #endif				/* _CL_NODE_NAME_MAP_H_ */
65