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
|
/* Copyright (c) 2013, Linaro Limited
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file
*
* ODP Linux helper API
*
* This file is an optional helper to odp.h APIs. These functions are provided
* to ease common setups in a Linux system. User is free to implement the same
* setups in otherways (not via this API).
*/
#ifndef ODPH_LINUX_H_
#define ODPH_LINUX_H_
#ifdef __cplusplus
extern "C" {
#endif
#include <pthread.h>
#include <getopt.h>
#include <sys/types.h>
/** @addtogroup odph_linux ODPH LINUX
* @{
*/
/** Thread parameter for Linux pthreads and processes */
typedef struct {
void *(*start)(void *); /**< Thread entry point function */
void *arg; /**< Argument for the function */
odp_thread_type_t thr_type; /**< ODP thread type */
odp_instance_t instance; /**< ODP instance handle */
} odph_linux_thr_params_t;
/** Linux pthread state information */
typedef struct {
pthread_t thread; /**< Pthread ID */
pthread_attr_t attr; /**< Pthread attributes */
int cpu; /**< CPU ID */
/** Copy of thread params */
odph_linux_thr_params_t thr_params;
} odph_linux_pthread_t;
/** Linux process state information */
typedef struct {
pid_t pid; /**< Process ID */
int cpu; /**< CPU ID */
int status; /**< Process state change status */
} odph_linux_process_t;
/** odpthread linux type: whether an ODP thread is a linux thread or process */
typedef enum odph_odpthread_linuxtype_e {
ODPTHREAD_NOT_STARTED = 0,
ODPTHREAD_PROCESS,
ODPTHREAD_PTHREAD
} odph_odpthread_linuxtype_t;
/** odpthread parameters for odp threads (pthreads and processes) */
typedef struct {
int (*start)(void *); /**< Thread entry point function */
void *arg; /**< Argument for the function */
odp_thread_type_t thr_type; /**< ODP thread type */
odp_instance_t instance; /**< ODP instance handle */
} odph_odpthread_params_t;
/** The odpthread starting arguments, used both in process or thread mode */
typedef struct {
odph_odpthread_linuxtype_t linuxtype; /**< process or pthread */
odph_odpthread_params_t thr_params; /**< odpthread start parameters */
} odph_odpthread_start_args_t;
/** Linux odpthread state information, used both in process or thread mode */
typedef struct {
odph_odpthread_start_args_t start_args; /**< start arguments */
int cpu; /**< CPU ID */
int last; /**< true if last table entry */
union {
struct { /* for thread implementation */
pthread_t thread_id; /**< Pthread ID */
pthread_attr_t attr; /**< Pthread attributes */
} thread;
struct { /* for process implementation */
pid_t pid; /**< Process ID */
int status; /**< Process state chge status*/
} proc;
};
} odph_odpthread_t;
/**
* Creates and launches odpthreads (as linux threads or processes)
*
* Creates, pins and launches threads to separate CPU's based on the cpumask.
*
* @param thread_tbl Thread table
* @param mask CPU mask
* @param thr_params ODP thread parameters
*
* @return Number of threads created
*/
int odph_odpthreads_create(odph_odpthread_t *thread_tbl,
const odp_cpumask_t *mask,
const odph_odpthread_params_t *thr_params);
/**
* Waits odpthreads (as linux threads or processes) to exit.
*
* Returns when all odpthreads have terminated.
*
* @param thread_tbl Thread table
* @return The number of joined threads or -1 on error.
* (error occurs if any of the start_routine return non-zero or if
* the thread join/process wait itself failed -e.g. as the result of a kill)
*
*/
int odph_odpthreads_join(odph_odpthread_t *thread_tbl);
/**
* Set CPU affinity of the current odp thread
*
* CPU affinity determines the CPU core on which the thread is
* eligible to run.
*
* @param cpu The affinity CPU core
*
* @return 0 on success, -1 on failure
*/
int odph_odpthread_setaffinity(const int cpu);
/**
* Get CPU affinity of the current odp thread
*
* CPU affinity determines the CPU core on which the thread is
* eligible to run.
*
* @return positive cpu ID on success, -1 on failure
*/
int odph_odpthread_getaffinity(void);
/**
* Merge getopt options
*
* Given two sets of getopt options (each containing possibly both short
* options -a string- and long options -a option array-) this function
* return a single set (i.e. a string for short and an array for long)
* being the concatenation of the two given sets.
* Due to the fact that the size of these arrays is unknown at compilation
* time, this function actually mallocs the the resulting arrays.
* The fourth and fith parameters are actually pointers where these malloc'ed
* areas are returned.
* This means that the caller of this function has to free the two returned
* areas!
*
* @param shortopts1 first set of short options (a string)
* @param shortopts2 second set of short options (a string)
* @param longopts1 first set of long options (a getopt option array)
* @param longopts2 second set of long options (a getopt option array)
* @param shortopts a pointer where the address of the short options list
* (a string) is returned. It contains the concatenation of
* the two given short option strings.
* @param longopts a pointer where the address of the long options list
* (a getopt option array) is returned.
* It contains the concatenation of the two given long
* option arrays.
* if any of shortopts1, shortopts2, longopts1, longopts2 is NULL, the
* corresponding list as assumed to be empty.
* if any of shortopts, longopts is NULL, the corresponding malloc is not
* performed.
*
* @return On success: 0 : both shortopts and longopts are returned (assuming
* the given pointer where not null), possibly
* pointing to an empty string or an empty option array.
* On success, the caller is due to free these areas.
* On failure: -1: Nothing is malloc'ed.
*/
int odph_merge_getopt_options(const char *shortopts1,
const char *shortopts2,
const struct option *longopts1,
const struct option *longopts2,
char **shortopts,
struct option **longopts);
/**
* Parse linux helper options
*
* Parse the command line options. Pick up options meant for the helper itself.
* If the caller is also having a set of option to parse, it should include
* their description here (shortopts desribes the short options and longopts
* describes the long options, as for getopt_long()).
* This function will issue errors on unknown arguments, so callers failing
* to pass their own command line options description here will see their
* options rejected.
* (the caller wants to set opterr to zero when parsing its own stuff
* with getopts to avoid reacting on helper's options).
*
* @param argc argument count
* @param argv argument values
* @param caller_shortopts caller's set of short options (string). or NULL.
* @param caller_longopts caller's set of long options (getopt option array).
* or NULL.
*
* @return On success: 0
* On failure: -1 failure occurs if a value passed for a helper
* option is invalid, or on meeting unknown options.
*/
int odph_parse_options(int argc, char *argv[],
const char *caller_shortopts,
const struct option *caller_longopts);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif
|
