]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> | |
5 | * | |
6 | * This program is free software: you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation, either version 3 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
20 | #include <stdio.h> | |
21 | #include <stdlib.h> | |
22 | #include <unistd.h> | |
23 | #include <string.h> | |
24 | #include <glib.h> | |
25 | #include "libsigrok.h" | |
26 | #include "libsigrok-internal.h" | |
27 | ||
28 | /** @cond PRIVATE */ | |
29 | #define LOG_PREFIX "session" | |
30 | /** @endcond */ | |
31 | ||
32 | /** | |
33 | * @file | |
34 | * | |
35 | * Creating, using, or destroying libsigrok sessions. | |
36 | */ | |
37 | ||
38 | /** | |
39 | * @defgroup grp_session Session handling | |
40 | * | |
41 | * Creating, using, or destroying libsigrok sessions. | |
42 | * | |
43 | * @{ | |
44 | */ | |
45 | ||
46 | struct source { | |
47 | int timeout; | |
48 | sr_receive_data_callback cb; | |
49 | void *cb_data; | |
50 | ||
51 | /* This is used to keep track of the object (fd, pollfd or channel) which is | |
52 | * being polled and will be used to match the source when removing it again. | |
53 | */ | |
54 | gintptr poll_object; | |
55 | }; | |
56 | ||
57 | struct datafeed_callback { | |
58 | sr_datafeed_callback cb; | |
59 | void *cb_data; | |
60 | }; | |
61 | ||
62 | /* There can only be one session at a time. */ | |
63 | /* 'session' is not static, it's used elsewhere (via 'extern'). */ | |
64 | struct sr_session *session; | |
65 | ||
66 | /** | |
67 | * Create a new session. | |
68 | * | |
69 | * @todo Should it use the file-global "session" variable or take an argument? | |
70 | * The same question applies to all the other session functions. | |
71 | * | |
72 | * @retval NULL Error. | |
73 | * @retval other A pointer to the newly allocated session. | |
74 | * | |
75 | * @since 0.1.0 | |
76 | */ | |
77 | SR_API struct sr_session *sr_session_new(void) | |
78 | { | |
79 | if (!(session = g_try_malloc0(sizeof(struct sr_session)))) { | |
80 | sr_err("Session malloc failed."); | |
81 | return NULL; | |
82 | } | |
83 | ||
84 | session->source_timeout = -1; | |
85 | session->running = FALSE; | |
86 | session->abort_session = FALSE; | |
87 | g_mutex_init(&session->stop_mutex); | |
88 | ||
89 | return session; | |
90 | } | |
91 | ||
92 | /** | |
93 | * Destroy the current session. | |
94 | * This frees up all memory used by the session. | |
95 | * | |
96 | * @retval SR_OK Success. | |
97 | * @retval SR_ERR_BUG No session exists. | |
98 | * | |
99 | * @since 0.1.0 | |
100 | */ | |
101 | SR_API int sr_session_destroy(void) | |
102 | { | |
103 | if (!session) { | |
104 | sr_err("%s: session was NULL", __func__); | |
105 | return SR_ERR_BUG; | |
106 | } | |
107 | ||
108 | sr_session_dev_remove_all(); | |
109 | g_mutex_clear(&session->stop_mutex); | |
110 | if (session->trigger) | |
111 | sr_trigger_free(session->trigger); | |
112 | ||
113 | g_free(session); | |
114 | session = NULL; | |
115 | ||
116 | return SR_OK; | |
117 | } | |
118 | ||
119 | /** | |
120 | * Remove all the devices from the current session. | |
121 | * | |
122 | * The session itself (i.e., the struct sr_session) is not free'd and still | |
123 | * exists after this function returns. | |
124 | * | |
125 | * @retval SR_OK Success. | |
126 | * @retval SR_ERR_BUG No session exists. | |
127 | * | |
128 | * @since 0.1.0 | |
129 | */ | |
130 | SR_API int sr_session_dev_remove_all(void) | |
131 | { | |
132 | if (!session) { | |
133 | sr_err("%s: session was NULL", __func__); | |
134 | return SR_ERR_BUG; | |
135 | } | |
136 | ||
137 | g_slist_free(session->devs); | |
138 | session->devs = NULL; | |
139 | ||
140 | return SR_OK; | |
141 | } | |
142 | ||
143 | /** | |
144 | * Add a device instance to the current session. | |
145 | * | |
146 | * @param sdi The device instance to add to the current session. Must not | |
147 | * be NULL. Also, sdi->driver and sdi->driver->dev_open must | |
148 | * not be NULL. | |
149 | * | |
150 | * @retval SR_OK Success. | |
151 | * @retval SR_ERR_ARG Invalid argument. | |
152 | * @retval SR_ERR_BUG No session exists. | |
153 | * | |
154 | * @since 0.2.0 | |
155 | */ | |
156 | SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi) | |
157 | { | |
158 | int ret; | |
159 | ||
160 | if (!sdi) { | |
161 | sr_err("%s: sdi was NULL", __func__); | |
162 | return SR_ERR_ARG; | |
163 | } | |
164 | ||
165 | if (!session) { | |
166 | sr_err("%s: session was NULL", __func__); | |
167 | return SR_ERR_BUG; | |
168 | } | |
169 | ||
170 | /* If sdi->driver is NULL, this is a virtual device. */ | |
171 | if (!sdi->driver) { | |
172 | sr_dbg("%s: sdi->driver was NULL, this seems to be " | |
173 | "a virtual device; continuing", __func__); | |
174 | /* Just add the device, don't run dev_open(). */ | |
175 | session->devs = g_slist_append(session->devs, (gpointer)sdi); | |
176 | return SR_OK; | |
177 | } | |
178 | ||
179 | /* sdi->driver is non-NULL (i.e. we have a real device). */ | |
180 | if (!sdi->driver->dev_open) { | |
181 | sr_err("%s: sdi->driver->dev_open was NULL", __func__); | |
182 | return SR_ERR_BUG; | |
183 | } | |
184 | ||
185 | session->devs = g_slist_append(session->devs, (gpointer)sdi); | |
186 | ||
187 | if (session->running) { | |
188 | /* Adding a device to a running session. Commit settings | |
189 | * and start acquisition on that device now. */ | |
190 | if ((ret = sr_config_commit(sdi)) != SR_OK) { | |
191 | sr_err("Failed to commit device settings before " | |
192 | "starting acquisition in running session (%s)", | |
193 | sr_strerror(ret)); | |
194 | return ret; | |
195 | } | |
196 | if ((ret = sdi->driver->dev_acquisition_start(sdi, | |
197 | (void *)sdi)) != SR_OK) { | |
198 | sr_err("Failed to start acquisition of device in " | |
199 | "running session (%s)", sr_strerror(ret)); | |
200 | return ret; | |
201 | } | |
202 | } | |
203 | ||
204 | return SR_OK; | |
205 | } | |
206 | ||
207 | /** | |
208 | * List all device instances attached to the current session. | |
209 | * | |
210 | * @param devlist A pointer where the device instance list will be | |
211 | * stored on return. If no devices are in the session, | |
212 | * this will be NULL. Each element in the list points | |
213 | * to a struct sr_dev_inst *. | |
214 | * The list must be freed by the caller, but not the | |
215 | * elements pointed to. | |
216 | * | |
217 | * @retval SR_OK Success. | |
218 | * @retval SR_ERR Invalid argument. | |
219 | * | |
220 | * @since 0.3.0 | |
221 | */ | |
222 | SR_API int sr_session_dev_list(GSList **devlist) | |
223 | { | |
224 | ||
225 | *devlist = NULL; | |
226 | ||
227 | if (!session) | |
228 | return SR_ERR; | |
229 | ||
230 | *devlist = g_slist_copy(session->devs); | |
231 | ||
232 | return SR_OK; | |
233 | } | |
234 | ||
235 | /** | |
236 | * Remove all datafeed callbacks in the current session. | |
237 | * | |
238 | * @retval SR_OK Success. | |
239 | * @retval SR_ERR_BUG No session exists. | |
240 | * | |
241 | * @since 0.1.0 | |
242 | */ | |
243 | SR_API int sr_session_datafeed_callback_remove_all(void) | |
244 | { | |
245 | if (!session) { | |
246 | sr_err("%s: session was NULL", __func__); | |
247 | return SR_ERR_BUG; | |
248 | } | |
249 | ||
250 | g_slist_free_full(session->datafeed_callbacks, g_free); | |
251 | session->datafeed_callbacks = NULL; | |
252 | ||
253 | return SR_OK; | |
254 | } | |
255 | ||
256 | /** | |
257 | * Add a datafeed callback to the current session. | |
258 | * | |
259 | * @param cb Function to call when a chunk of data is received. | |
260 | * Must not be NULL. | |
261 | * @param cb_data Opaque pointer passed in by the caller. | |
262 | * | |
263 | * @retval SR_OK Success. | |
264 | * @retval SR_ERR_BUG No session exists. | |
265 | * | |
266 | * @since 0.3.0 | |
267 | */ | |
268 | SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback cb, void *cb_data) | |
269 | { | |
270 | struct datafeed_callback *cb_struct; | |
271 | ||
272 | if (!session) { | |
273 | sr_err("%s: session was NULL", __func__); | |
274 | return SR_ERR_BUG; | |
275 | } | |
276 | ||
277 | if (!cb) { | |
278 | sr_err("%s: cb was NULL", __func__); | |
279 | return SR_ERR_ARG; | |
280 | } | |
281 | ||
282 | if (!(cb_struct = g_try_malloc0(sizeof(struct datafeed_callback)))) | |
283 | return SR_ERR_MALLOC; | |
284 | ||
285 | cb_struct->cb = cb; | |
286 | cb_struct->cb_data = cb_data; | |
287 | ||
288 | session->datafeed_callbacks = | |
289 | g_slist_append(session->datafeed_callbacks, cb_struct); | |
290 | ||
291 | return SR_OK; | |
292 | } | |
293 | ||
294 | SR_API struct sr_trigger *sr_session_trigger_get(void) | |
295 | { | |
296 | return session->trigger; | |
297 | } | |
298 | ||
299 | SR_API int sr_session_trigger_set(struct sr_trigger *trig) | |
300 | { | |
301 | session->trigger = trig; | |
302 | ||
303 | return SR_OK; | |
304 | } | |
305 | ||
306 | /** | |
307 | * Call every device in the session's callback. | |
308 | * | |
309 | * For sessions not driven by select loops such as sr_session_run(), | |
310 | * but driven by another scheduler, this can be used to poll the devices | |
311 | * from within that scheduler. | |
312 | * | |
313 | * @param block If TRUE, this call will wait for any of the session's | |
314 | * sources to fire an event on the file descriptors, or | |
315 | * any of their timeouts to activate. In other words, this | |
316 | * can be used as a select loop. | |
317 | * If FALSE, all sources have their callback run, regardless | |
318 | * of file descriptor or timeout status. | |
319 | * | |
320 | * @retval SR_OK Success. | |
321 | * @retval SR_ERR Error occured. | |
322 | */ | |
323 | static int sr_session_iteration(gboolean block) | |
324 | { | |
325 | unsigned int i; | |
326 | int ret; | |
327 | ||
328 | ret = g_poll(session->pollfds, session->num_sources, | |
329 | block ? session->source_timeout : 0); | |
330 | for (i = 0; i < session->num_sources; i++) { | |
331 | if (session->pollfds[i].revents > 0 || (ret == 0 | |
332 | && session->source_timeout == session->sources[i].timeout)) { | |
333 | /* | |
334 | * Invoke the source's callback on an event, | |
335 | * or if the poll timed out and this source | |
336 | * asked for that timeout. | |
337 | */ | |
338 | if (!session->sources[i].cb(session->pollfds[i].fd, | |
339 | session->pollfds[i].revents, | |
340 | session->sources[i].cb_data)) | |
341 | sr_session_source_remove(session->sources[i].poll_object); | |
342 | } | |
343 | /* | |
344 | * We want to take as little time as possible to stop | |
345 | * the session if we have been told to do so. Therefore, | |
346 | * we check the flag after processing every source, not | |
347 | * just once per main event loop. | |
348 | */ | |
349 | g_mutex_lock(&session->stop_mutex); | |
350 | if (session->abort_session) { | |
351 | sr_session_stop_sync(); | |
352 | /* But once is enough. */ | |
353 | session->abort_session = FALSE; | |
354 | } | |
355 | g_mutex_unlock(&session->stop_mutex); | |
356 | } | |
357 | ||
358 | return SR_OK; | |
359 | } | |
360 | ||
361 | ||
362 | static int verify_trigger(struct sr_trigger *trigger) | |
363 | { | |
364 | struct sr_trigger_stage *stage; | |
365 | struct sr_trigger_match *match; | |
366 | GSList *l, *m; | |
367 | ||
368 | if (!trigger->stages) { | |
369 | sr_err("No trigger stages defined."); | |
370 | return SR_ERR; | |
371 | } | |
372 | ||
373 | sr_spew("Checking trigger:"); | |
374 | for (l = trigger->stages; l; l = l->next) { | |
375 | stage = l->data; | |
376 | if (!stage->matches) { | |
377 | sr_err("Stage %d has no matches defined.", stage->stage); | |
378 | return SR_ERR; | |
379 | } | |
380 | for (m = stage->matches; m; m = m->next) { | |
381 | match = m->data; | |
382 | if (!match->channel) { | |
383 | sr_err("Stage %d match has no channel.", stage->stage); | |
384 | return SR_ERR; | |
385 | } | |
386 | if (!match->match) { | |
387 | sr_err("Stage %d match is not defined.", stage->stage); | |
388 | return SR_ERR; | |
389 | } | |
390 | sr_spew("Stage %d match on channel %s, match %d", stage->stage, | |
391 | match->channel->name, match->match); | |
392 | } | |
393 | } | |
394 | ||
395 | return SR_OK; | |
396 | } | |
397 | /** | |
398 | * Start a session. | |
399 | * | |
400 | * There can only be one session at a time. | |
401 | * | |
402 | * @retval SR_OK Success. | |
403 | * @retval SR_ERR Error occured. | |
404 | * | |
405 | * @since 0.1.0 | |
406 | */ | |
407 | SR_API int sr_session_start(void) | |
408 | { | |
409 | struct sr_dev_inst *sdi; | |
410 | GSList *l; | |
411 | int ret; | |
412 | ||
413 | if (!session) { | |
414 | sr_err("%s: session was NULL; a session must be " | |
415 | "created before starting it.", __func__); | |
416 | return SR_ERR_BUG; | |
417 | } | |
418 | ||
419 | if (!session->devs) { | |
420 | sr_err("%s: session->devs was NULL; a session " | |
421 | "cannot be started without devices.", __func__); | |
422 | return SR_ERR_BUG; | |
423 | } | |
424 | ||
425 | if (session->trigger && verify_trigger(session->trigger) != SR_OK) | |
426 | return SR_ERR; | |
427 | ||
428 | sr_info("Starting."); | |
429 | ||
430 | ret = SR_OK; | |
431 | for (l = session->devs; l; l = l->next) { | |
432 | sdi = l->data; | |
433 | if ((ret = sr_config_commit(sdi)) != SR_OK) { | |
434 | sr_err("Failed to commit device settings before " | |
435 | "starting acquisition (%s)", sr_strerror(ret)); | |
436 | break; | |
437 | } | |
438 | if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) { | |
439 | sr_err("%s: could not start an acquisition " | |
440 | "(%s)", __func__, sr_strerror(ret)); | |
441 | break; | |
442 | } | |
443 | } | |
444 | ||
445 | /* TODO: What if there are multiple devices? Which return code? */ | |
446 | ||
447 | return ret; | |
448 | } | |
449 | ||
450 | /** | |
451 | * Run the session. | |
452 | * | |
453 | * @retval SR_OK Success. | |
454 | * @retval SR_ERR_BUG Error occured. | |
455 | * | |
456 | * @since 0.1.0 | |
457 | */ | |
458 | SR_API int sr_session_run(void) | |
459 | { | |
460 | if (!session) { | |
461 | sr_err("%s: session was NULL; a session must be " | |
462 | "created first, before running it.", __func__); | |
463 | return SR_ERR_BUG; | |
464 | } | |
465 | ||
466 | if (!session->devs) { | |
467 | /* TODO: Actually the case? */ | |
468 | sr_err("%s: session->devs was NULL; a session " | |
469 | "cannot be run without devices.", __func__); | |
470 | return SR_ERR_BUG; | |
471 | } | |
472 | session->running = TRUE; | |
473 | ||
474 | sr_info("Running."); | |
475 | ||
476 | /* Do we have real sources? */ | |
477 | if (session->num_sources == 1 && session->pollfds[0].fd == -1) { | |
478 | /* Dummy source, freewheel over it. */ | |
479 | while (session->num_sources) | |
480 | session->sources[0].cb(-1, 0, session->sources[0].cb_data); | |
481 | } else { | |
482 | /* Real sources, use g_poll() main loop. */ | |
483 | while (session->num_sources) | |
484 | sr_session_iteration(TRUE); | |
485 | } | |
486 | ||
487 | return SR_OK; | |
488 | } | |
489 | ||
490 | /** | |
491 | * Stop the current session. | |
492 | * | |
493 | * The current session is stopped immediately, with all acquisition sessions | |
494 | * being stopped and hardware drivers cleaned up. | |
495 | * | |
496 | * This must be called from within the session thread, to prevent freeing | |
497 | * resources that the session thread will try to use. | |
498 | * | |
499 | * @retval SR_OK Success. | |
500 | * @retval SR_ERR_BUG No session exists. | |
501 | * | |
502 | * @private | |
503 | */ | |
504 | SR_PRIV int sr_session_stop_sync(void) | |
505 | { | |
506 | struct sr_dev_inst *sdi; | |
507 | GSList *l; | |
508 | ||
509 | if (!session) { | |
510 | sr_err("%s: session was NULL", __func__); | |
511 | return SR_ERR_BUG; | |
512 | } | |
513 | ||
514 | sr_info("Stopping."); | |
515 | ||
516 | for (l = session->devs; l; l = l->next) { | |
517 | sdi = l->data; | |
518 | if (sdi->driver) { | |
519 | if (sdi->driver->dev_acquisition_stop) | |
520 | sdi->driver->dev_acquisition_stop(sdi, sdi); | |
521 | } | |
522 | } | |
523 | session->running = FALSE; | |
524 | ||
525 | return SR_OK; | |
526 | } | |
527 | ||
528 | /** | |
529 | * Stop the current session. | |
530 | * | |
531 | * The current session is stopped immediately, with all acquisition sessions | |
532 | * being stopped and hardware drivers cleaned up. | |
533 | * | |
534 | * If the session is run in a separate thread, this function will not block | |
535 | * until the session is finished executing. It is the caller's responsibility | |
536 | * to wait for the session thread to return before assuming that the session is | |
537 | * completely decommissioned. | |
538 | * | |
539 | * @retval SR_OK Success. | |
540 | * @retval SR_ERR_BUG No session exists. | |
541 | * | |
542 | * @since 0.1.0 | |
543 | */ | |
544 | SR_API int sr_session_stop(void) | |
545 | { | |
546 | if (!session) { | |
547 | sr_err("%s: session was NULL", __func__); | |
548 | return SR_ERR_BUG; | |
549 | } | |
550 | ||
551 | g_mutex_lock(&session->stop_mutex); | |
552 | session->abort_session = TRUE; | |
553 | g_mutex_unlock(&session->stop_mutex); | |
554 | ||
555 | return SR_OK; | |
556 | } | |
557 | ||
558 | /** | |
559 | * Debug helper. | |
560 | * | |
561 | * @param packet The packet to show debugging information for. | |
562 | */ | |
563 | static void datafeed_dump(const struct sr_datafeed_packet *packet) | |
564 | { | |
565 | const struct sr_datafeed_logic *logic; | |
566 | const struct sr_datafeed_analog *analog; | |
567 | ||
568 | switch (packet->type) { | |
569 | case SR_DF_HEADER: | |
570 | sr_dbg("bus: Received SR_DF_HEADER packet."); | |
571 | break; | |
572 | case SR_DF_TRIGGER: | |
573 | sr_dbg("bus: Received SR_DF_TRIGGER packet."); | |
574 | break; | |
575 | case SR_DF_META: | |
576 | sr_dbg("bus: Received SR_DF_META packet."); | |
577 | break; | |
578 | case SR_DF_LOGIC: | |
579 | logic = packet->payload; | |
580 | sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, " | |
581 | "unitsize = %d).", logic->length, logic->unitsize); | |
582 | break; | |
583 | case SR_DF_ANALOG: | |
584 | analog = packet->payload; | |
585 | sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).", | |
586 | analog->num_samples); | |
587 | break; | |
588 | case SR_DF_END: | |
589 | sr_dbg("bus: Received SR_DF_END packet."); | |
590 | break; | |
591 | case SR_DF_FRAME_BEGIN: | |
592 | sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet."); | |
593 | break; | |
594 | case SR_DF_FRAME_END: | |
595 | sr_dbg("bus: Received SR_DF_FRAME_END packet."); | |
596 | break; | |
597 | default: | |
598 | sr_dbg("bus: Received unknown packet type: %d.", packet->type); | |
599 | break; | |
600 | } | |
601 | } | |
602 | ||
603 | /** | |
604 | * Send a packet to whatever is listening on the datafeed bus. | |
605 | * | |
606 | * Hardware drivers use this to send a data packet to the frontend. | |
607 | * | |
608 | * @param sdi TODO. | |
609 | * @param packet The datafeed packet to send to the session bus. | |
610 | * | |
611 | * @retval SR_OK Success. | |
612 | * @retval SR_ERR_ARG Invalid argument. | |
613 | * | |
614 | * @private | |
615 | */ | |
616 | SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, | |
617 | const struct sr_datafeed_packet *packet) | |
618 | { | |
619 | GSList *l; | |
620 | struct datafeed_callback *cb_struct; | |
621 | ||
622 | if (!sdi) { | |
623 | sr_err("%s: sdi was NULL", __func__); | |
624 | return SR_ERR_ARG; | |
625 | } | |
626 | ||
627 | if (!packet) { | |
628 | sr_err("%s: packet was NULL", __func__); | |
629 | return SR_ERR_ARG; | |
630 | } | |
631 | ||
632 | for (l = session->datafeed_callbacks; l; l = l->next) { | |
633 | if (sr_log_loglevel_get() >= SR_LOG_DBG) | |
634 | datafeed_dump(packet); | |
635 | cb_struct = l->data; | |
636 | cb_struct->cb(sdi, packet, cb_struct->cb_data); | |
637 | } | |
638 | ||
639 | return SR_OK; | |
640 | } | |
641 | ||
642 | /** | |
643 | * Add an event source for a file descriptor. | |
644 | * | |
645 | * @param pollfd The GPollFD. | |
646 | * @param[in] timeout Max time to wait before the callback is called, | |
647 | * ignored if 0. | |
648 | * @param cb Callback function to add. Must not be NULL. | |
649 | * @param cb_data Data for the callback function. Can be NULL. | |
650 | * @param poll_object TODO. | |
651 | * | |
652 | * @retval SR_OK Success. | |
653 | * @retval SR_ERR_ARG Invalid argument. | |
654 | * @retval SR_ERR_MALLOC Memory allocation error. | |
655 | */ | |
656 | static int _sr_session_source_add(GPollFD *pollfd, int timeout, | |
657 | sr_receive_data_callback cb, void *cb_data, gintptr poll_object) | |
658 | { | |
659 | struct source *new_sources, *s; | |
660 | GPollFD *new_pollfds; | |
661 | ||
662 | if (!cb) { | |
663 | sr_err("%s: cb was NULL", __func__); | |
664 | return SR_ERR_ARG; | |
665 | } | |
666 | ||
667 | /* Note: cb_data can be NULL, that's not a bug. */ | |
668 | ||
669 | new_pollfds = g_try_realloc(session->pollfds, | |
670 | sizeof(GPollFD) * (session->num_sources + 1)); | |
671 | if (!new_pollfds) { | |
672 | sr_err("%s: new_pollfds malloc failed", __func__); | |
673 | return SR_ERR_MALLOC; | |
674 | } | |
675 | ||
676 | new_sources = g_try_realloc(session->sources, sizeof(struct source) * | |
677 | (session->num_sources + 1)); | |
678 | if (!new_sources) { | |
679 | sr_err("%s: new_sources malloc failed", __func__); | |
680 | return SR_ERR_MALLOC; | |
681 | } | |
682 | ||
683 | new_pollfds[session->num_sources] = *pollfd; | |
684 | s = &new_sources[session->num_sources++]; | |
685 | s->timeout = timeout; | |
686 | s->cb = cb; | |
687 | s->cb_data = cb_data; | |
688 | s->poll_object = poll_object; | |
689 | session->pollfds = new_pollfds; | |
690 | session->sources = new_sources; | |
691 | ||
692 | if (timeout != session->source_timeout && timeout > 0 | |
693 | && (session->source_timeout == -1 || timeout < session->source_timeout)) | |
694 | session->source_timeout = timeout; | |
695 | ||
696 | return SR_OK; | |
697 | } | |
698 | ||
699 | /** | |
700 | * Add an event source for a file descriptor. | |
701 | * | |
702 | * @param fd The file descriptor. | |
703 | * @param events Events to check for. | |
704 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
705 | * @param cb Callback function to add. Must not be NULL. | |
706 | * @param cb_data Data for the callback function. Can be NULL. | |
707 | * | |
708 | * @retval SR_OK Success. | |
709 | * @retval SR_ERR_ARG Invalid argument. | |
710 | * @retval SR_ERR_MALLOC Memory allocation error. | |
711 | * | |
712 | * @since 0.3.0 | |
713 | */ | |
714 | SR_API int sr_session_source_add(int fd, int events, int timeout, | |
715 | sr_receive_data_callback cb, void *cb_data) | |
716 | { | |
717 | GPollFD p; | |
718 | ||
719 | p.fd = fd; | |
720 | p.events = events; | |
721 | ||
722 | return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd); | |
723 | } | |
724 | ||
725 | /** | |
726 | * Add an event source for a GPollFD. | |
727 | * | |
728 | * @param pollfd The GPollFD. | |
729 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
730 | * @param cb Callback function to add. Must not be NULL. | |
731 | * @param cb_data Data for the callback function. Can be NULL. | |
732 | * | |
733 | * @retval SR_OK Success. | |
734 | * @retval SR_ERR_ARG Invalid argument. | |
735 | * @retval SR_ERR_MALLOC Memory allocation error. | |
736 | * | |
737 | * @since 0.3.0 | |
738 | */ | |
739 | SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, | |
740 | sr_receive_data_callback cb, void *cb_data) | |
741 | { | |
742 | return _sr_session_source_add(pollfd, timeout, cb, | |
743 | cb_data, (gintptr)pollfd); | |
744 | } | |
745 | ||
746 | /** | |
747 | * Add an event source for a GIOChannel. | |
748 | * | |
749 | * @param channel The GIOChannel. | |
750 | * @param events Events to poll on. | |
751 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
752 | * @param cb Callback function to add. Must not be NULL. | |
753 | * @param cb_data Data for the callback function. Can be NULL. | |
754 | * | |
755 | * @retval SR_OK Success. | |
756 | * @retval SR_ERR_ARG Invalid argument. | |
757 | * @retval SR_ERR_MALLOC Memory allocation error. | |
758 | * | |
759 | * @since 0.3.0 | |
760 | */ | |
761 | SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, | |
762 | int timeout, sr_receive_data_callback cb, void *cb_data) | |
763 | { | |
764 | GPollFD p; | |
765 | ||
766 | #ifdef _WIN32 | |
767 | g_io_channel_win32_make_pollfd(channel, events, &p); | |
768 | #else | |
769 | p.fd = g_io_channel_unix_get_fd(channel); | |
770 | p.events = events; | |
771 | #endif | |
772 | ||
773 | return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel); | |
774 | } | |
775 | ||
776 | /** | |
777 | * Remove the source belonging to the specified channel. | |
778 | * | |
779 | * @todo Add more error checks and logging. | |
780 | * | |
781 | * @param poll_object The channel for which the source should be removed. | |
782 | * | |
783 | * @retval SR_OK Success | |
784 | * @retval SR_ERR_ARG Invalid arguments | |
785 | * @retval SR_ERR_MALLOC Memory allocation error | |
786 | * @retval SR_ERR_BUG Internal error | |
787 | */ | |
788 | static int _sr_session_source_remove(gintptr poll_object) | |
789 | { | |
790 | struct source *new_sources; | |
791 | GPollFD *new_pollfds; | |
792 | unsigned int old; | |
793 | ||
794 | if (!session->sources || !session->num_sources) { | |
795 | sr_err("%s: sources was NULL", __func__); | |
796 | return SR_ERR_BUG; | |
797 | } | |
798 | ||
799 | for (old = 0; old < session->num_sources; old++) { | |
800 | if (session->sources[old].poll_object == poll_object) | |
801 | break; | |
802 | } | |
803 | ||
804 | /* fd not found, nothing to do */ | |
805 | if (old == session->num_sources) | |
806 | return SR_OK; | |
807 | ||
808 | session->num_sources -= 1; | |
809 | ||
810 | if (old != session->num_sources) { | |
811 | memmove(&session->pollfds[old], &session->pollfds[old+1], | |
812 | (session->num_sources - old) * sizeof(GPollFD)); | |
813 | memmove(&session->sources[old], &session->sources[old+1], | |
814 | (session->num_sources - old) * sizeof(struct source)); | |
815 | } | |
816 | ||
817 | new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources); | |
818 | if (!new_pollfds && session->num_sources > 0) { | |
819 | sr_err("%s: new_pollfds malloc failed", __func__); | |
820 | return SR_ERR_MALLOC; | |
821 | } | |
822 | ||
823 | new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources); | |
824 | if (!new_sources && session->num_sources > 0) { | |
825 | sr_err("%s: new_sources malloc failed", __func__); | |
826 | return SR_ERR_MALLOC; | |
827 | } | |
828 | ||
829 | session->pollfds = new_pollfds; | |
830 | session->sources = new_sources; | |
831 | ||
832 | return SR_OK; | |
833 | } | |
834 | ||
835 | /** | |
836 | * Remove the source belonging to the specified file descriptor. | |
837 | * | |
838 | * @param fd The file descriptor for which the source should be removed. | |
839 | * | |
840 | * @retval SR_OK Success | |
841 | * @retval SR_ERR_ARG Invalid argument | |
842 | * @retval SR_ERR_MALLOC Memory allocation error. | |
843 | * @retval SR_ERR_BUG Internal error. | |
844 | * | |
845 | * @since 0.3.0 | |
846 | */ | |
847 | SR_API int sr_session_source_remove(int fd) | |
848 | { | |
849 | return _sr_session_source_remove((gintptr)fd); | |
850 | } | |
851 | ||
852 | /** | |
853 | * Remove the source belonging to the specified poll descriptor. | |
854 | * | |
855 | * @param pollfd The poll descriptor for which the source should be removed. | |
856 | * | |
857 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
858 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
859 | * internal errors. | |
860 | * | |
861 | * @since 0.2.0 | |
862 | */ | |
863 | SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd) | |
864 | { | |
865 | return _sr_session_source_remove((gintptr)pollfd); | |
866 | } | |
867 | ||
868 | /** | |
869 | * Remove the source belonging to the specified channel. | |
870 | * | |
871 | * @param channel The channel for which the source should be removed. | |
872 | * | |
873 | * @retval SR_OK Success. | |
874 | * @retval SR_ERR_ARG Invalid argument. | |
875 | * @retval SR_ERR_MALLOC Memory allocation error. | |
876 | * @return SR_ERR_BUG Internal error. | |
877 | * | |
878 | * @since 0.2.0 | |
879 | */ | |
880 | SR_API int sr_session_source_remove_channel(GIOChannel *channel) | |
881 | { | |
882 | return _sr_session_source_remove((gintptr)channel); | |
883 | } | |
884 | ||
885 | /** @} */ |