aboutsummaryrefslogtreecommitdiffstats
path: root/lib/libtle_udp/tle_event.h
blob: 1a5c436fd027bedcdddfdad44f161be25ca3f1a8 (plain)
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
/*
 * Copyright (c) 2016  Intel Corporation.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _SEV_IMPL_H_
#define _SEV_IMPL_H_

#include <rte_common.h>
#include <rte_spinlock.h>
#include <rte_atomic.h>
#include <sys/queue.h>

#ifdef __cplusplus
extern "C" {
#endif

struct tle_evq;

/**
 * Possible states of the event.
 */
enum tle_ev_state {
	TLE_SEV_IDLE,
	TLE_SEV_DOWN,
	TLE_SEV_UP,
	TLE_SEV_NUM
};

struct tle_event {
	TAILQ_ENTRY(tle_event) ql;
	struct tle_evq *head;
	const void *data;
	enum tle_ev_state state;
} __rte_cache_aligned;

struct tle_evq {
	rte_spinlock_t lock;
	uint32_t nb_events;
	uint32_t nb_armed;
	uint32_t nb_free;
	TAILQ_HEAD(, tle_event) armed;
	TAILQ_HEAD(, tle_event) free;
	struct tle_event events[0];
};

/**
 * event queue creation parameters.
 */
struct tle_evq_param {
	int32_t socket_id;    /**< socket ID to allocate memory from. */
	uint32_t max_events;  /**< max number of events in queue. */
};

/**
 * create event queue.
 * @param prm
 *   Parameters used to create and initialise the queue.
 * @return
 *   Pointer to new event queue structure,
 *   or NULL on error, with error code set in rte_errno.
 *   Possible rte_errno errors include:
 *   - EINVAL - invalid parameter passed to function
 *   - ENOMEM - out of memory
 */
struct tle_evq *tle_evq_create(const struct tle_evq_param *prm);

/**
 * Destroy given event queue.
 *
 * @param evq
 *   event queue to destroy
 */
void tle_evq_destroy(struct tle_evq *evq);

/**
 * allocate a new event within given event queue.
 * @param evq
 *    event queue to allocate a new stream within.
 * @param data
 *   User data to be associated with that event.
 * @return
 *   Pointer to event structure that can be used in future tle_event API calls,
 *   or NULL on error, with error code set in rte_errno.
 *   Possible rte_errno errors include:
 *   - EINVAL - invalid parameter passed to function
 *   - ENOMEM - max limit of allocated events reached for that context
 */
struct tle_event *tle_event_alloc(struct tle_evq *evq, const void *data);

/**
 * free an allocated event.
 * @param ev
 *   Pointer to the event to free.
 */
void tle_event_free(struct tle_event *ev);


/**
 * move event from DOWN to UP state.
 * @param ev
 *   Pointer to the event.
 */
static inline void
tle_event_raise(struct tle_event *ev)
{
	struct tle_evq *q;

	if (ev->state != TLE_SEV_DOWN)
		return;

	q = ev->head;
	rte_compiler_barrier();

	rte_spinlock_lock(&q->lock);
	if (ev->state == TLE_SEV_DOWN) {
		ev->state = TLE_SEV_UP;
		TAILQ_INSERT_TAIL(&q->armed, ev, ql);
		q->nb_armed++;
	}
	rte_spinlock_unlock(&q->lock);
}

/**
 * move event from UP to DOWN state.
 * @param ev
 *   Pointer to the event.
 */
static inline void
tle_event_down(struct tle_event *ev)
{
	struct tle_evq *q;

	if (ev->state != TLE_SEV_UP)
		return;

	q = ev->head;
	rte_compiler_barrier();

	rte_spinlock_lock(&q->lock);
	if (ev->state == TLE_SEV_UP) {
		ev->state = TLE_SEV_DOWN;
		TAILQ_REMOVE(&q->armed, ev, ql);
		q->nb_armed--;
	}
	rte_spinlock_unlock(&q->lock);
}

/**
 * move from IDLE to DOWN/UP state.
 * @param ev
 *   Pointer to the event.
 * @param st
 *   new state for the event.
 */
static inline void
tle_event_active(struct tle_event *ev, enum tle_ev_state st)
{
	struct tle_evq *q;

	if (st == ev->state)
		return;

	q = ev->head;
	rte_compiler_barrier();

	rte_spinlock_lock(&q->lock);
	if (st > ev->state) {
		if (st == TLE_SEV_UP) {
			TAILQ_INSERT_TAIL(&q->armed, ev, ql);
			q->nb_armed++;
		}
		ev->state = st;
	}
	rte_spinlock_unlock(&q->lock);
}

/**
 * move event IDLE state.
 * @param ev
 *   Pointer to the event.
 */
static inline void
tle_event_idle(struct tle_event *ev)
{
	struct tle_evq *q;

	if (ev->state == TLE_SEV_IDLE)
		return;

	q = ev->head;
	rte_compiler_barrier();

	rte_spinlock_lock(&q->lock);
	if (ev->state == TLE_SEV_UP) {
		TAILQ_REMOVE(&q->armed, ev, ql);
		q->nb_armed--;
	}
	ev->state = TLE_SEV_IDLE;
	rte_spinlock_unlock(&q->lock);
}


/*
 * return up to *num* user data pointers associated with
 * the events that were in the UP state.
 * Each retrieved event is automatically moved into the DOWN state.
 * @param evq
 *   event queue to retrieve events from.
 * @param evd
 *   An array of user data pointers associated with the events retrieved.
 *   It must be large enough to store up to *num* pointers in it.
 * @param num
 *   Number of elements in the *evd* array.
 * @return
 *   number of of entries filled inside *evd* array.
 */
static inline int32_t
tle_evq_get(struct tle_evq *evq, const void *evd[], uint32_t num)
{
	uint32_t i, n;
	struct tle_event *ev;

	if (evq->nb_armed == 0)
		return 0;

	rte_compiler_barrier();

	rte_spinlock_lock(&evq->lock);
	n = RTE_MIN(num, evq->nb_armed);
	for (i = 0; i != n; i++) {
		ev = TAILQ_FIRST(&evq->armed);
		ev->state = TLE_SEV_DOWN;
		TAILQ_REMOVE(&evq->armed, ev, ql);
		evd[i] = ev->data;
	}
	evq->nb_armed -= n;
	rte_spinlock_unlock(&evq->lock);
	return n;
}


#ifdef __cplusplus
}
#endif

#endif /* _SEV_IMPL_H_ */