aboutsummaryrefslogtreecommitdiffstats
path: root/libparc/parc/algol/parc_EventQueue.c
blob: 5d656a12b1d94edca33a872fd9729f82fa4e3918 (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
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
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * 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.
 */

/**
 */
#include <config.h>
#include <errno.h>

#include <LongBow/runtime.h>

#include "internal_parc_Event.h"
#include <parc/algol/parc_EventScheduler.h>
#include <parc/algol/parc_EventQueue.h>
#include <parc/algol/parc_FileOutputStream.h>
#include <parc/logging/parc_Log.h>
#include <parc/logging/parc_LogReporterFile.h>

static int _parc_event_queue_debug_enabled = 0;

#define parcEventQueue_LogDebug(parcEventQueue, ...) \
    if (_parc_event_queue_debug_enabled) \
        parcLog_Debug(parcEventScheduler_GetLogger(parcEventQueue->eventScheduler), __VA_ARGS__)

/**
 * Current implementation based on top of libevent2
 */

#include <event2/buffer.h>
#include <event2/bufferevent.h>

/**
 * @typedef PARCEventQueue
 * @brief A structure containing private event state
 */
struct PARCEventQueue {
    // Event scheduler we have been queued with
    PARCEventScheduler *eventScheduler;

    struct bufferevent *buffereventBuffer;
    // Interpose on bufferevent callbacks
    PARCEventQueue_Callback *readCallback;
    void *readUserData;
    PARCEventQueue_Callback *writeCallback;
    void *writeUserData;
    PARCEventQueue_EventCallback *eventCallback;
    void *eventUserData;
};

struct PARCEventQueuePair {
    PARCEventQueue *up;
    PARCEventQueue *down;
};

static void
_parc_queue_read_callback(struct bufferevent *bev, void *ptr)
{
    PARCEventQueue *parcEventQueue = (PARCEventQueue *) ptr;
    parcEventQueue_LogDebug(parcEventQueue,
                            "_parc_queue_read_callback(bev=%p,ptr->buffereventBuffer=%p,parcEventQueue=%p)\n",
                            bev, parcEventQueue->buffereventBuffer, parcEventQueue);
    assertNotNull(parcEventQueue->readCallback, "parcEvent read callback called when NULL");

    parcEventQueue->readCallback(parcEventQueue, PARCEventType_Read, parcEventQueue->readUserData);
}

static void
_parc_queue_write_callback(struct bufferevent *bev, void *ptr)
{
    PARCEventQueue *parcEventQueue = (PARCEventQueue *) ptr;
    parcEventQueue_LogDebug(parcEventQueue,
                            "_parc_queue_write_callback(bev=%p,ptr->buffereventBuffer=%p,parcEventQueue=%p)\n",
                            bev, parcEventQueue->buffereventBuffer, parcEventQueue);
    assertNotNull(parcEventQueue->writeCallback, "parcEvent write callback called when NULL");

    parcEventQueue->writeCallback(parcEventQueue, PARCEventType_Write, parcEventQueue->writeUserData);
}

static void
_parc_queue_event_callback(struct bufferevent *bev, short events, void *ptr)
{
    PARCEventQueue *parcEventQueue = (PARCEventQueue *) ptr;
    int errno_forwarded = errno;
    parcEventQueue_LogDebug(parcEventQueue,
                            "_parc_queue_event_callback(bev=%p,events=%x,errno=%d,ptr->buffereventBuffer=%p,parcEventQueue=%p)\n",
                            bev, events, errno, parcEventQueue->buffereventBuffer, parcEventQueue);
    assertNotNull(parcEventQueue->eventCallback, "parcEvent event callback called when NULL");

    errno = errno_forwarded;
    parcEventQueue->eventCallback(parcEventQueue, internal_bufferevent_type_to_PARCEventQueueEventType(events), parcEventQueue->eventUserData);
}

void
parcEventQueue_SetCallbacks(PARCEventQueue *parcEventQueue,
                            PARCEventQueue_Callback *readCallback,
                            PARCEventQueue_Callback *writeCallback,
                            PARCEventQueue_EventCallback *eventCallback,
                            void *user_data)
{
    parcEventQueue_LogDebug(parcEventQueue,
                            "parcEventQueue_SetCallbacks(event=%p(buffer=%p),readcb=%p,writecb=%p,eventcb=%p,user_data=%p)\n",
                            parcEventQueue, parcEventQueue->buffereventBuffer,
                            readCallback, writeCallback, eventCallback,
                            user_data);

    parcEventQueue->readCallback = readCallback;
    parcEventQueue->readUserData = user_data;
    parcEventQueue->writeCallback = writeCallback;
    parcEventQueue->writeUserData = user_data;
    parcEventQueue->eventCallback = eventCallback;
    parcEventQueue->eventUserData = user_data;
    bufferevent_setcb(parcEventQueue->buffereventBuffer,
                      (readCallback) ? _parc_queue_read_callback : NULL,
                      (writeCallback) ? _parc_queue_write_callback : NULL,
                      (eventCallback) ? _parc_queue_event_callback : NULL,
                      parcEventQueue);
}

PARCEventQueue *
parcEventQueue_Create(PARCEventScheduler *eventScheduler, int fd, PARCEventQueueOption flags)
{
    assertNotNull(eventScheduler, "parcEventQueue_Create passed a NULL scheduler instance.");
    PARCEventQueue *parcEventQueue = parcMemory_AllocateAndClear(sizeof(PARCEventQueue));
    assertNotNull(parcEventQueue, "parcMemory_AllocateAndClear(%zu) returned NULL", sizeof(PARCEventQueue));
    parcEventQueue->eventScheduler = eventScheduler;

    //
    // PARCEventQueue_CloseOnFree
    //     we close the underlying file descriptor/bufferevent/whatever
    //     when this bufferevent is freed.
    //
    // PARCEventQueue_DeferCallbacks
    //     callbacks are run deferred in the event loop.
    //
    parcEventQueue->buffereventBuffer = bufferevent_socket_new(parcEventScheduler_GetEvBase(eventScheduler), fd,
                                                               internal_PARCEventQueueOption_to_bufferevent_options(flags));
    assertNotNull(parcEventQueue->buffereventBuffer,
                  "Got null from bufferevent_socket_new for socket %d", fd);

    parcEventQueue_LogDebug(parcEventQueue,
                            "parcEventQueue_Create(eventScheduler=%p,libevent_base=%p) = %p\n",
                            eventScheduler,
                            parcEventScheduler_GetEvBase(eventScheduler),
                            parcEventQueue);

    return parcEventQueue;
}

void
parcEventQueue_Destroy(PARCEventQueue **parcEventQueue)
{
    parcEventQueue_LogDebug((*parcEventQueue), "parcEventQueue_Destroy(ptr=%p)\n", *parcEventQueue);
    assertNotNull((*parcEventQueue)->buffereventBuffer, "parcEventQueue_Destroy passed a null buffer!");

    bufferevent_free((*parcEventQueue)->buffereventBuffer);
    parcMemory_Deallocate((void *) parcEventQueue);
}

int
parcEventQueue_SetFileDescriptor(PARCEventQueue *parcEventQueue, int fd)
{
    return bufferevent_setfd(parcEventQueue->buffereventBuffer, fd);
}

int
parcEventQueue_GetFileDescriptor(PARCEventQueue *parcEventQueue)
{
    return bufferevent_getfd(parcEventQueue->buffereventBuffer);
}

PARCEventType
parcEventQueue_GetEnabled(PARCEventQueue *event)
{
    return internal_libevent_type_to_PARCEventType(bufferevent_get_enabled(event->buffereventBuffer));
}

void
parcEventQueue_Enable(PARCEventQueue *parcEventQueue, PARCEventType types)
{
    bufferevent_enable(parcEventQueue->buffereventBuffer, internal_PARCEventType_to_libevent_type(types));
}

void
parcEventQueue_Disable(PARCEventQueue *parcEventQueue, PARCEventType types)
{
    bufferevent_disable(parcEventQueue->buffereventBuffer, internal_PARCEventType_to_libevent_type(types));
}

int
parcEventQueue_ConnectSocket(PARCEventQueue *instance, struct sockaddr *address, int addrlen)
{
    return bufferevent_socket_connect(instance->buffereventBuffer, address, addrlen);
}

int
parcEventQueue_Flush(PARCEventQueue *parcEventQueue, PARCEventType types)
{
    return bufferevent_flush(parcEventQueue->buffereventBuffer, internal_PARCEventType_to_libevent_type(types), BEV_NORMAL);
}

int
parcEventQueue_Finished(PARCEventQueue *parcEventQueue, PARCEventType types)
{
    return bufferevent_flush(parcEventQueue->buffereventBuffer, internal_PARCEventType_to_libevent_type(types), BEV_FINISHED);
}

void
parcEventQueue_SetWatermark(PARCEventQueue *parcEventQueue, PARCEventType types, size_t low, size_t high)
{
    parcEventQueue_LogDebug(parcEventQueue, "parcEventQueue->buffereventBuffer=%p\n", parcEventQueue->buffereventBuffer);
    bufferevent_setwatermark(parcEventQueue->buffereventBuffer, internal_PARCEventType_to_libevent_type(types), low, high);
}

int
parcEventQueue_Printf(PARCEventQueue *parcEventQueue, const char *fmt, ...)
{
    struct evbuffer *buffer = bufferevent_get_output(parcEventQueue->buffereventBuffer);
    assertNotNull(buffer, "bufferevent_get_output returned NULL");

    va_list ap;

    va_start(ap, fmt);
    int result = evbuffer_add_vprintf(buffer, fmt, ap);
    va_end(ap);
    return result;
}

int
parcEventQueue_Read(PARCEventQueue *parcEventQueue, void *data, size_t dataLength)
{
    return bufferevent_read(parcEventQueue->buffereventBuffer, data, dataLength);
}

int
parcEventQueue_Write(PARCEventQueue *parcEventQueue, void *data, size_t dataLength)
{
    return bufferevent_write(parcEventQueue->buffereventBuffer, data, dataLength);
}

int
parcEventQueue_SetPriority(PARCEventQueue *eventQueue, PARCEventPriority priority)
{
    bufferevent_priority_set(eventQueue->buffereventBuffer, internal_PARCEventPriority_to_libevent_priority(priority));
    return 0;
}

PARCEventQueuePair *
parcEventQueue_CreateConnectedPair(PARCEventScheduler *eventScheduler)
{
    assertNotNull(eventScheduler, "parcEventQueue_CreateConnectedPair must be passed a valid Event Scheduler");
    PARCEventQueuePair *parcEventQueuePair = parcMemory_AllocateAndClear(sizeof(PARCEventQueuePair));
    assertNotNull(parcEventQueuePair, "parcMemory_AllocateAndClear(%zu) returned NULL", sizeof(PARCEventQueuePair));

    parcEventQueuePair->up = parcMemory_AllocateAndClear(sizeof(PARCEventQueue));
    parcEventQueuePair->up->eventScheduler = eventScheduler;
    parcEventQueue_LogDebug(parcEventQueuePair->up,
                            "up instance parcEventQueue_Create(eventScheduler=%p,libevent_parcEventQueue=%p) = %p\n",
                            eventScheduler,
                            parcEventScheduler_GetEvBase(eventScheduler),
                            parcEventQueuePair->up);
    assertNotNull(parcEventQueuePair->up, "parcMemory_AllocateAndClear(%zu) returned NULL", sizeof(PARCEventQueue));

    parcEventQueuePair->down = parcMemory_AllocateAndClear(sizeof(PARCEventQueue));
    parcEventQueuePair->down->eventScheduler = eventScheduler;
    parcEventQueue_LogDebug(parcEventQueuePair->down,
                            "down instance parcEventQueue_Create(eventScheduler=%p,libevent_parcEventQueue=%p) = %p\n",
                            eventScheduler,
                            parcEventScheduler_GetEvBase(eventScheduler),
                            parcEventQueuePair->down);
    assertNotNull(parcEventQueuePair->down, "parcMemory_AllocateAndClear(%zu) returned NULL", sizeof(PARCEventQueue));

    struct bufferevent *evpair[2];
    int result = bufferevent_pair_new(parcEventScheduler_GetEvBase(eventScheduler), 0, evpair);
    if (result != 0) {
        parcMemory_Deallocate((void **) &(parcEventQueuePair->up));
        parcMemory_Deallocate((void **) &(parcEventQueuePair->down));
        parcMemory_Deallocate((void **) &parcEventQueuePair);
        return NULL;
    }

    parcEventQueuePair->up->buffereventBuffer = evpair[0];
    parcEventQueuePair->down->buffereventBuffer = evpair[1];

    (void) parcEventQueue_SetPriority(parcEventQueuePair->up, PARCEventPriority_Normal);
    (void) parcEventQueue_SetPriority(parcEventQueuePair->down, PARCEventPriority_Normal);

    return parcEventQueuePair;
}

void
parcEventQueue_DestroyConnectedPair(PARCEventQueuePair **queuePair)
{
    parcEventQueue_LogDebug((*queuePair)->up,
                            "parcEventQueue_DestroyPair(up ptr=%p)\n",
                            (*queuePair)->up);
    parcEventQueue_LogDebug((*queuePair)->down,
                            "parcEventQueue_DestroyPair(down ptr=%p)\n",
                            (*queuePair)->down);

    bufferevent_free((*queuePair)->up->buffereventBuffer);
    bufferevent_free((*queuePair)->down->buffereventBuffer);

    parcMemory_Deallocate((void **) &((*queuePair)->up));
    parcMemory_Deallocate((void **) &((*queuePair)->down));
    parcMemory_Deallocate((void **) queuePair);
}

PARCEventQueue *
parcEventQueue_GetConnectedUpQueue(PARCEventQueuePair *queuePair)
{
    return queuePair->up;
}

PARCEventQueue *
parcEventQueue_GetConnectedDownQueue(PARCEventQueuePair *queuePair)
{
    return queuePair->down;
}

struct evbuffer *
internal_parcEventQueue_GetEvInputBuffer(PARCEventQueue *queue)
{
    return bufferevent_get_input(queue->buffereventBuffer);
}

struct evbuffer *
internal_parcEventQueue_GetEvOutputBuffer(PARCEventQueue *queue)
{
    return bufferevent_get_output(queue->buffereventBuffer);
}

void
parcEventQueue_EnableDebug(void)
{
    _parc_event_queue_debug_enabled = 1;
}

void
parcEventQueue_DisableDebug(void)
{
    _parc_event_queue_debug_enabled = 0;
}