File: psm_utils.h

package info (click to toggle)
infinipath-psm 3.3+20.604758e7-6
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 2,452 kB
  • sloc: ansic: 34,270; makefile: 358; asm: 47; sh: 18
file content (292 lines) | stat: -rw-r--r-- 9,459 bytes parent folder | download | duplicates (2)
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
/*
 * Copyright (c) 2013. Intel Corporation. All rights reserved.
 * Copyright (c) 2006-2012. QLogic Corporation. All rights reserved.
 * Copyright (c) 2003-2006, PathScale, Inc. 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.
 */

#ifndef _PSMI_IN_USER_H
#error psm_utils.h not meant to be included directly, include psm_user.h instead
#endif

#ifndef _PSMI_UTILS_H
#define _PSMI_UTILS_H

#include <arpa/inet.h> /* ipv4addr */
#include <stdlib.h>    /* malloc/free */

/*
 * Endpoint 'id' hash table, with iterator interface
 */
struct psmi_epid_table {
    struct psmi_epid_tabentry	*table;
    int			         tabsize;
    int				 tabsize_used;
    pthread_mutex_t		 tablock;
};
/*
 * Endpoint address hash table
 */
struct psmi_epid_tabentry {
    void      *entry;
    uint64_t   key;
    psm_ep_t   ep;
    psm_epid_t epid;
};

extern struct psmi_epid_table psmi_epid_table;
#define EPADDR_DELETED	((void *)-1)	/* tag used to mark deleted entries */
#define PSMI_EPID_TABSIZE_CHUNK	 128
#define PSMI_EPID_TABLOAD_FACTOR ((float)0.7)

psm_error_t  psmi_epid_init();
psm_error_t  psmi_epid_fini();
void	    *psmi_epid_lookup(psm_ep_t ep, psm_epid_t epid);
void	    *psmi_epid_remove(psm_ep_t ep, psm_epid_t epid);
psm_error_t  psmi_epid_add(psm_ep_t ep, psm_epid_t epid, void *entry);
#define PSMI_EP_HOSTNAME    ((psm_ep_t) -1) /* Special endpoint handle we use
					     * to register hostnames */
#define PSMI_EP_CROSSTALK   ((psm_ep_t) -2) /* Second special endpoint handle
					     * to log which nodes we've seen
					     * crosstalk from */
struct psmi_eptab_iterator {
    int		i;  /* last index looked up */
    psm_ep_t	ep;
};
void  psmi_epid_itor_init(struct psmi_eptab_iterator *itor, psm_ep_t ep);
void *psmi_epid_itor_next(struct psmi_eptab_iterator *itor);
void  psmi_epid_itor_fini(struct psmi_eptab_iterator *itor);

uint64_t psmi_epid_hca_type(psm_epid_t epid);
uint64_t psmi_epid_sl(psm_epid_t epid);
/*
 * Hostname manipulation
 */
#define	     PSMI_EP_HOSTNAME_LEN   64   /* hostname only */
#define	     PSMI_EP_NAME_LEN       96   /* hostname:LID:context:subcontext */
char       * psmi_gethostname(void);
const char * psmi_epaddr_get_hostname(psm_epid_t epid);
const char * psmi_epaddr_get_name(psm_epid_t epid);
psm_error_t  psmi_epid_set_hostname(uint64_t nid, const char *hostname, 
				   int overwrite);

/* 
 * Memory allocation, use macros only.
 *
 * In all calls, ep can be a specific endpoint (valid psm_ep_t) or PSMI_EP_NONE
 * if no endpoint is available.
 *
 *   psmi_malloc(ep, memtype, size)
 *   psmi_calloc(ep, memtype, elemsz, numelems)
 *   psmi_strdup(ep, memtype, ptr)
 *   psmi_free(ptr)
 *
 */
typedef enum psmi_memtype {
	TOTAL = 0,	    /* Logged automatically by malloc/calloc */
	UNDEFINED,	    /* For tracking "other types" of allocations */
	PER_PEER_ENDPOINT,  /* For tracking "per peer" allocations */
	NETWORK_BUFFERS,    /* For tracking network buffers */
	DESCRIPTORS,	    /* For tracking send/recv descriptors */
	UNEXPECTED_BUFFERS, /* For tracking unexpected recv buffers */
	STATS,		    /* For tracking stats-related allocs */
}
psmi_memtype_t;

/* 
 * We track allocation stats.
 */
struct psmi_stats_malloc {
    int64_t	m_all_total;
    int64_t	m_all_max;
    int64_t	m_perpeer_total;
    int64_t	m_perpeer_max;
    int64_t	m_netbufs_total;
    int64_t	m_netbufs_max;
    int64_t	m_descriptors_total;
    int64_t	m_descriptors_max;
    int64_t	m_unexpbufs_total;
    int64_t	m_unexpbufs_max;
    int64_t	m_undefined_total;
    int64_t	m_undefined_max;
    int64_t	m_stats_total;
    int64_t	m_stats_max;
};

extern struct psmi_stats_malloc psmi_stats_memory;

void *psmi_malloc_internal(psm_ep_t ep, psmi_memtype_t mt, size_t sz, 
			   const char *curloc);
void *psmi_calloc_internal(psm_ep_t ep, psmi_memtype_t mt, size_t num, size_t sz,
			   const char *curloc);
void *psmi_strdup_internal(psm_ep_t ep, const char *string, const char *curloc);
void  psmi_free_internal(void *ptr);

#define psmi_strdup(ep,string) psmi_strdup_internal(ep,string, PSMI_CURLOC)
#define psmi_calloc(ep,mt,nelem,elemsz) \
	psmi_calloc_internal(ep,mt,nelem,elemsz,PSMI_CURLOC)
#define psmi_malloc(ep,mt,sz) psmi_malloc_internal(ep,mt,sz,PSMI_CURLOC)
#define psmi_free(sz)	psmi_free_internal(sz)

#ifndef PSM_IS_TEST
#define malloc(sz)       _use_psmi_malloc_instead_of_plain_malloc
#define calloc(sz,nelm)  _use_psmi_calloc_instead_of_plain_calloc
#ifdef strdup
#undef strdup
#endif
#define strdup(ptr)  _use_psmi_strdup_instead_of_plain_strdup
#define free(ptr)    _use_psmi_free_instead_of_plain_free
#endif /* PSM_IS_TEST */

void psmi_log_memstats(psmi_memtype_t type, int64_t nbytes);

/*
 * Parsing int parameters set in string tuples.
 */
int psmi_parse_str_tuples(const char *str, int ntup, int *vals);

/*
 * Resource Limiting based on PSM memory mode.
 */
#define PSMI_MEMMODE_NORMAL  0
#define PSMI_MEMMODE_MINIMAL 1
#define PSMI_MEMMODE_LARGE   2
#define PSMI_MEMMODE_NUM     3

struct psmi_rlimit_mpool {
    const char *env;
    const char *descr;
    int		env_level;
    uint32_t	minval;
    uint32_t	maxval;
    struct {
	    uint32_t	obj_chunk;
	    uint32_t	obj_max;
    }
    mode[PSMI_MEMMODE_NUM];
};
psm_error_t psmi_parse_mpool_env(const psm_mq_t mq, int level,
				    const struct psmi_rlimit_mpool *rlim,
				    uint32_t *valo, uint32_t *chunkszo);
int psmi_parse_memmode(void);

/*
 * Parsing environment variables
 */

union psmi_envvar_val {
    void	  *e_void;
    char	  *e_str;
    int	          e_int;
    unsigned int  e_uint;
    long          e_long;
    unsigned long e_ulong;
    unsigned long long e_ulonglong;
};

#define PSMI_ENVVAR_LEVEL_USER	    1
#define PSMI_ENVVAR_LEVEL_HIDDEN    2

#define PSMI_ENVVAR_TYPE_YESNO		0
#define PSMI_ENVVAR_TYPE_STR		1
#define PSMI_ENVVAR_TYPE_INT		2
#define PSMI_ENVVAR_TYPE_UINT		3
#define PSMI_ENVVAR_TYPE_UINT_FLAGS	4
#define PSMI_ENVVAR_TYPE_LONG		5
#define PSMI_ENVVAR_TYPE_ULONG		6
#define PSMI_ENVVAR_TYPE_ULONG_FLAGS	7
#define PSMI_ENVVAR_TYPE_ULONG_ULONG    8

#define PSMI_ENVVAR_VAL_YES ((union psmi_envvar_val) 1)
#define PSMI_ENVVAR_VAL_NO  ((union psmi_envvar_val) 0)

int psmi_getenv(const char *name, const char *descr, int level,
		int type, union psmi_envvar_val defval,
		union psmi_envvar_val *newval);

/*
 * Misc functionality
 */
uintptr_t psmi_getpagesize(void);
uint64_t  psmi_cycles_left(uint64_t start_cycles, int64_t timeout_ns);
uint32_t  psmi_get_ipv4addr();
void	  psmi_syslog(psm_ep_t ep, int to_console, int level, 
		      const char *format, ...);
void	  psmi_uuid_unparse(const psm_uuid_t uuid, char *out);
int	  psmi_uuid_compare(const psm_uuid_t uuA, const psm_uuid_t uuB);
void     *psmi_memcpyo(void *dst, const void *src, size_t n);
uint32_t  psmi_crc(unsigned char *buf, int len);
uint32_t  psmi_get_hca_type(psmi_context_t *context);

/*
 * Diagnostics, all in psm_diags.c
 */
int	psmi_diags(void);

/*
 * Fault injection
 */
struct psmi_faultinj_spec;
int    psmi_faultinj_enabled; /* use macro to test */
#if 1 /* possible to disable at compile time */
#define PSMI_FAULTINJ_ENABLED()	(!!psmi_faultinj_enabled)
#else
#define PSMI_FAULTINJ_ENABLED()	0
#endif

void   psmi_faultinj_init();
void   psmi_faultinj_fini();
struct psmi_faultinj_spec *psmi_faultinj_getspec(char *spec_name,
						 int num, int denom);
#define PSMI_FAULTINJ_STATIC_DECL(var, spec_name, num, denom)		\
	static struct psmi_faultinj_spec *var = NULL;			\
	if (PSMI_FAULTINJ_ENABLED() && (var) == NULL)			\
	    (var) = psmi_faultinj_getspec((spec_name), (num), (denom)); 
int    psmi_faultinj_is_fault(struct psmi_faultinj_spec *spec);

/*
 * PSM core component set/get options
 */
psm_error_t psmi_core_setopt(const void *core_obj, int optname, 
			     const void *optval, uint64_t optlen);

psm_error_t psmi_core_getopt(const void *core_obj, int optname, 
			     void *optval, uint64_t *optlen);

/*
 * PSM AM component set/get options
 */
psm_error_t psmi_am_setopt(const void *am_obj, int optname, 
			     const void *optval, uint64_t optlen);

psm_error_t psmi_am_getopt(const void *am_obj, int optname, 
			   void *optval, uint64_t *optlen);

#endif /* _PSMI_UTILS_H */