]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the sigrok 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 | /* Message logging helpers with driver-specific prefix string. */ | |
29 | #define DRIVER_LOG_DOMAIN "session: " | |
30 | #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args) | |
31 | #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args) | |
32 | #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args) | |
33 | #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args) | |
34 | #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args) | |
35 | #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args) | |
36 | ||
37 | /** | |
38 | * @file | |
39 | * | |
40 | * Creating, using, or destroying libsigrok sessions. | |
41 | */ | |
42 | ||
43 | /** | |
44 | * @defgroup grp_session Session handling | |
45 | * | |
46 | * Creating, using, or destroying libsigrok sessions. | |
47 | * | |
48 | * @{ | |
49 | */ | |
50 | ||
51 | struct source { | |
52 | int timeout; | |
53 | sr_receive_data_callback_t cb; | |
54 | void *cb_data; | |
55 | ||
56 | /* This is used to keep track of the object (fd, pollfd or channel) which is | |
57 | * being polled and will be used to match the source when removing it again. | |
58 | */ | |
59 | gintptr poll_object; | |
60 | }; | |
61 | ||
62 | struct datafeed_callback { | |
63 | sr_datafeed_callback_t cb; | |
64 | void *cb_data; | |
65 | }; | |
66 | ||
67 | /* There can only be one session at a time. */ | |
68 | /* 'session' is not static, it's used elsewhere (via 'extern'). */ | |
69 | struct sr_session *session; | |
70 | ||
71 | /** | |
72 | * Create a new session. | |
73 | * | |
74 | * @todo Should it use the file-global "session" variable or take an argument? | |
75 | * The same question applies to all the other session functions. | |
76 | * | |
77 | * @return A pointer to the newly allocated session, or NULL upon errors. | |
78 | */ | |
79 | SR_API struct sr_session *sr_session_new(void) | |
80 | { | |
81 | if (!(session = g_try_malloc0(sizeof(struct sr_session)))) { | |
82 | sr_err("Session malloc failed."); | |
83 | return NULL; | |
84 | } | |
85 | ||
86 | session->source_timeout = -1; | |
87 | session->abort_session = FALSE; | |
88 | g_mutex_init(&session->stop_mutex); | |
89 | ||
90 | return session; | |
91 | } | |
92 | ||
93 | /** | |
94 | * Destroy the current session. | |
95 | * | |
96 | * This frees up all memory used by the session. | |
97 | * | |
98 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
99 | */ | |
100 | SR_API int sr_session_destroy(void) | |
101 | { | |
102 | if (!session) { | |
103 | sr_err("%s: session was NULL", __func__); | |
104 | return SR_ERR_BUG; | |
105 | } | |
106 | ||
107 | sr_session_dev_remove_all(); | |
108 | ||
109 | /* TODO: Error checks needed? */ | |
110 | ||
111 | g_mutex_clear(&session->stop_mutex); | |
112 | ||
113 | g_free(session); | |
114 | session = NULL; | |
115 | ||
116 | return SR_OK; | |
117 | } | |
118 | ||
119 | /** | |
120 | * Close a device instance. | |
121 | * | |
122 | * @param sdi The device instance to close. Must not be NULL. Also, | |
123 | * sdi->driver, sdi->driver->priv, and sdi->priv must not be NULL. | |
124 | */ | |
125 | static void sr_dev_close(struct sr_dev_inst *sdi) | |
126 | { | |
127 | int ret; | |
128 | ||
129 | if (!sdi) { | |
130 | sr_err("Invalid device instance, can't close device."); | |
131 | return; | |
132 | } | |
133 | ||
134 | /* In the drivers sdi->priv is a 'struct dev_context *devc'. */ | |
135 | if (!sdi->priv) { | |
136 | /* | |
137 | * Should be sr_err() in theory, but the 'demo' driver has | |
138 | * NULL for sdi->priv, so we use sr_dbg() until that's fixed. | |
139 | */ | |
140 | sr_dbg("Invalid device context, can't close device."); | |
141 | return; | |
142 | } | |
143 | ||
144 | if (!sdi->driver) { | |
145 | sr_err("Invalid driver, can't close device."); | |
146 | return; | |
147 | } | |
148 | ||
149 | if (!sdi->driver->priv) { | |
150 | sr_err("Driver not initialized, can't close device."); | |
151 | return; | |
152 | } | |
153 | ||
154 | sr_spew("Closing '%s' device instance %d.", sdi->driver->name, | |
155 | sdi->index); | |
156 | ||
157 | if ((ret = sdi->driver->dev_close(sdi)) < 0) | |
158 | sr_err("Failed to close device instance: %d.", ret); | |
159 | } | |
160 | ||
161 | /** | |
162 | * Remove all the devices from the current session. | |
163 | * | |
164 | * The session itself (i.e., the struct sr_session) is not free'd and still | |
165 | * exists after this function returns. | |
166 | * | |
167 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
168 | */ | |
169 | SR_API int sr_session_dev_remove_all(void) | |
170 | { | |
171 | if (!session) { | |
172 | sr_err("%s: session was NULL", __func__); | |
173 | return SR_ERR_BUG; | |
174 | } | |
175 | ||
176 | g_slist_free_full(session->devs, (GDestroyNotify)sr_dev_close); | |
177 | session->devs = NULL; | |
178 | ||
179 | return SR_OK; | |
180 | } | |
181 | ||
182 | /** | |
183 | * Add a device instance to the current session. | |
184 | * | |
185 | * @param sdi The device instance to add to the current session. Must not | |
186 | * be NULL. Also, sdi->driver and sdi->driver->dev_open must | |
187 | * not be NULL. | |
188 | * | |
189 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. | |
190 | */ | |
191 | SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi) | |
192 | { | |
193 | int ret; | |
194 | ||
195 | if (!sdi) { | |
196 | sr_err("%s: sdi was NULL", __func__); | |
197 | return SR_ERR_ARG; | |
198 | } | |
199 | ||
200 | if (!session) { | |
201 | sr_err("%s: session was NULL", __func__); | |
202 | return SR_ERR_BUG; | |
203 | } | |
204 | ||
205 | /* If sdi->driver is NULL, this is a virtual device. */ | |
206 | if (!sdi->driver) { | |
207 | sr_dbg("%s: sdi->driver was NULL, this seems to be " | |
208 | "a virtual device; continuing", __func__); | |
209 | /* Just add the device, don't run dev_open(). */ | |
210 | session->devs = g_slist_append(session->devs, (gpointer)sdi); | |
211 | return SR_OK; | |
212 | } | |
213 | ||
214 | /* sdi->driver is non-NULL (i.e. we have a real device). */ | |
215 | if (!sdi->driver->dev_open) { | |
216 | sr_err("%s: sdi->driver->dev_open was NULL", __func__); | |
217 | return SR_ERR_BUG; | |
218 | } | |
219 | ||
220 | if ((ret = sdi->driver->dev_open((struct sr_dev_inst *)sdi)) != SR_OK) { | |
221 | sr_err("%s: dev_open failed (%d)", __func__, ret); | |
222 | return ret; | |
223 | } | |
224 | ||
225 | session->devs = g_slist_append(session->devs, (gpointer)sdi); | |
226 | ||
227 | return SR_OK; | |
228 | } | |
229 | ||
230 | /** | |
231 | * Remove all datafeed callbacks in the current session. | |
232 | * | |
233 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
234 | */ | |
235 | SR_API int sr_session_datafeed_callback_remove_all(void) | |
236 | { | |
237 | if (!session) { | |
238 | sr_err("%s: session was NULL", __func__); | |
239 | return SR_ERR_BUG; | |
240 | } | |
241 | ||
242 | g_slist_free_full(session->datafeed_callbacks, g_free); | |
243 | session->datafeed_callbacks = NULL; | |
244 | ||
245 | return SR_OK; | |
246 | } | |
247 | ||
248 | /** | |
249 | * Add a datafeed callback to the current session. | |
250 | * | |
251 | * @param cb Function to call when a chunk of data is received. | |
252 | * Must not be NULL. | |
253 | * @param cb_data Opaque pointer passed in by the caller. | |
254 | * | |
255 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
256 | */ | |
257 | SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_data) | |
258 | { | |
259 | struct datafeed_callback *cb_struct; | |
260 | ||
261 | if (!session) { | |
262 | sr_err("%s: session was NULL", __func__); | |
263 | return SR_ERR_BUG; | |
264 | } | |
265 | ||
266 | if (!cb) { | |
267 | sr_err("%s: cb was NULL", __func__); | |
268 | return SR_ERR_ARG; | |
269 | } | |
270 | ||
271 | if (!(cb_struct = g_try_malloc0(sizeof(struct datafeed_callback)))) | |
272 | return SR_ERR_MALLOC; | |
273 | ||
274 | cb_struct->cb = cb; | |
275 | cb_struct->cb_data = cb_data; | |
276 | ||
277 | session->datafeed_callbacks = | |
278 | g_slist_append(session->datafeed_callbacks, cb_struct); | |
279 | ||
280 | return SR_OK; | |
281 | } | |
282 | ||
283 | static int sr_session_run_poll(void) | |
284 | { | |
285 | unsigned int i; | |
286 | int ret; | |
287 | ||
288 | while (session->num_sources > 0) { | |
289 | ret = g_poll(session->pollfds, session->num_sources, | |
290 | session->source_timeout); | |
291 | for (i = 0; i < session->num_sources; i++) { | |
292 | if (session->pollfds[i].revents > 0 || (ret == 0 | |
293 | && session->source_timeout == session->sources[i].timeout)) { | |
294 | /* | |
295 | * Invoke the source's callback on an event, | |
296 | * or if the poll timed out and this source | |
297 | * asked for that timeout. | |
298 | */ | |
299 | if (!session->sources[i].cb(session->pollfds[i].fd, | |
300 | session->pollfds[i].revents, | |
301 | session->sources[i].cb_data)) | |
302 | sr_session_source_remove(session->sources[i].poll_object); | |
303 | } | |
304 | /* | |
305 | * We want to take as little time as possible to stop | |
306 | * the session if we have been told to do so. Therefore, | |
307 | * we check the flag after processing every source, not | |
308 | * just once per main event loop. | |
309 | */ | |
310 | g_mutex_lock(&session->stop_mutex); | |
311 | if (session->abort_session) | |
312 | sr_session_stop_sync(); | |
313 | g_mutex_unlock(&session->stop_mutex); | |
314 | } | |
315 | } | |
316 | ||
317 | return SR_OK; | |
318 | } | |
319 | ||
320 | /** | |
321 | * Start a session. | |
322 | * | |
323 | * There can only be one session at a time. | |
324 | * | |
325 | * @return SR_OK upon success, SR_ERR upon errors. | |
326 | */ | |
327 | SR_API int sr_session_start(void) | |
328 | { | |
329 | struct sr_dev_inst *sdi; | |
330 | GSList *l; | |
331 | int ret; | |
332 | ||
333 | if (!session) { | |
334 | sr_err("%s: session was NULL; a session must be " | |
335 | "created before starting it.", __func__); | |
336 | return SR_ERR_BUG; | |
337 | } | |
338 | ||
339 | if (!session->devs) { | |
340 | sr_err("%s: session->devs was NULL; a session " | |
341 | "cannot be started without devices.", __func__); | |
342 | return SR_ERR_BUG; | |
343 | } | |
344 | ||
345 | sr_info("Starting."); | |
346 | ||
347 | ret = SR_OK; | |
348 | for (l = session->devs; l; l = l->next) { | |
349 | sdi = l->data; | |
350 | if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) { | |
351 | sr_err("%s: could not start an acquisition " | |
352 | "(%d)", __func__, ret); | |
353 | break; | |
354 | } | |
355 | } | |
356 | ||
357 | /* TODO: What if there are multiple devices? Which return code? */ | |
358 | ||
359 | return ret; | |
360 | } | |
361 | ||
362 | /** | |
363 | * Run the session. | |
364 | * | |
365 | * @return SR_OK upon success, SR_ERR_BUG upon errors. | |
366 | */ | |
367 | SR_API int sr_session_run(void) | |
368 | { | |
369 | if (!session) { | |
370 | sr_err("%s: session was NULL; a session must be " | |
371 | "created first, before running it.", __func__); | |
372 | return SR_ERR_BUG; | |
373 | } | |
374 | ||
375 | if (!session->devs) { | |
376 | /* TODO: Actually the case? */ | |
377 | sr_err("%s: session->devs was NULL; a session " | |
378 | "cannot be run without devices.", __func__); | |
379 | return SR_ERR_BUG; | |
380 | } | |
381 | ||
382 | sr_info("Running."); | |
383 | ||
384 | /* Do we have real sources? */ | |
385 | if (session->num_sources == 1 && session->pollfds[0].fd == -1) { | |
386 | /* Dummy source, freewheel over it. */ | |
387 | while (session->num_sources) | |
388 | session->sources[0].cb(-1, 0, session->sources[0].cb_data); | |
389 | } else { | |
390 | /* Real sources, use g_poll() main loop. */ | |
391 | sr_session_run_poll(); | |
392 | } | |
393 | ||
394 | return SR_OK; | |
395 | } | |
396 | ||
397 | /** | |
398 | * Stop the current session. | |
399 | * | |
400 | * The current session is stopped immediately, with all acquisition sessions | |
401 | * being stopped and hardware drivers cleaned up. | |
402 | * | |
403 | * This must be called from within the session thread, to prevent freeing | |
404 | * resources that the session thread will try to use. | |
405 | * | |
406 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
407 | */ | |
408 | SR_PRIV int sr_session_stop_sync(void) | |
409 | { | |
410 | struct sr_dev_inst *sdi; | |
411 | GSList *l; | |
412 | ||
413 | if (!session) { | |
414 | sr_err("%s: session was NULL", __func__); | |
415 | return SR_ERR_BUG; | |
416 | } | |
417 | ||
418 | sr_info("Stopping."); | |
419 | ||
420 | for (l = session->devs; l; l = l->next) { | |
421 | sdi = l->data; | |
422 | if (sdi->driver) { | |
423 | if (sdi->driver->dev_acquisition_stop) | |
424 | sdi->driver->dev_acquisition_stop(sdi, sdi); | |
425 | } | |
426 | } | |
427 | ||
428 | /* | |
429 | * Some sources may not be necessarily associated with a device. | |
430 | * Those sources may still be present even after stopping all devices. | |
431 | * We need to make sure all sources are removed, or we risk running the | |
432 | * session in an infinite loop. | |
433 | */ | |
434 | while (session->num_sources) | |
435 | sr_session_source_remove(session->sources[0].poll_object); | |
436 | ||
437 | return SR_OK; | |
438 | } | |
439 | ||
440 | /** | |
441 | * Stop the current session. | |
442 | * | |
443 | * The current session is stopped immediately, with all acquisition sessions | |
444 | * being stopped and hardware drivers cleaned up. | |
445 | * | |
446 | * If the session is run in a separate thread, this function will not block | |
447 | * until the session is finished executing. It is the caller's responsibility | |
448 | * to wait for the session thread to return before assuming that the session is | |
449 | * completely decommissioned. | |
450 | * | |
451 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
452 | */ | |
453 | SR_API int sr_session_stop(void) | |
454 | { | |
455 | if (!session) { | |
456 | sr_err("%s: session was NULL", __func__); | |
457 | return SR_ERR_BUG; | |
458 | } | |
459 | ||
460 | g_mutex_lock(&session->stop_mutex); | |
461 | session->abort_session = TRUE; | |
462 | g_mutex_unlock(&session->stop_mutex); | |
463 | ||
464 | return SR_OK; | |
465 | } | |
466 | ||
467 | /** | |
468 | * Debug helper. | |
469 | * | |
470 | * @param packet The packet to show debugging information for. | |
471 | */ | |
472 | static void datafeed_dump(const struct sr_datafeed_packet *packet) | |
473 | { | |
474 | const struct sr_datafeed_logic *logic; | |
475 | const struct sr_datafeed_analog *analog; | |
476 | ||
477 | switch (packet->type) { | |
478 | case SR_DF_HEADER: | |
479 | sr_dbg("bus: Received SR_DF_HEADER packet."); | |
480 | break; | |
481 | case SR_DF_TRIGGER: | |
482 | sr_dbg("bus: Received SR_DF_TRIGGER packet."); | |
483 | break; | |
484 | case SR_DF_META: | |
485 | sr_dbg("bus: Received SR_DF_META packet."); | |
486 | break; | |
487 | case SR_DF_LOGIC: | |
488 | logic = packet->payload; | |
489 | sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes).", | |
490 | logic->length); | |
491 | break; | |
492 | case SR_DF_ANALOG: | |
493 | analog = packet->payload; | |
494 | sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).", | |
495 | analog->num_samples); | |
496 | break; | |
497 | case SR_DF_END: | |
498 | sr_dbg("bus: Received SR_DF_END packet."); | |
499 | break; | |
500 | case SR_DF_FRAME_BEGIN: | |
501 | sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet."); | |
502 | break; | |
503 | case SR_DF_FRAME_END: | |
504 | sr_dbg("bus: Received SR_DF_FRAME_END packet."); | |
505 | break; | |
506 | default: | |
507 | sr_dbg("bus: Received unknown packet type: %d.", packet->type); | |
508 | break; | |
509 | } | |
510 | } | |
511 | ||
512 | /** | |
513 | * Send a packet to whatever is listening on the datafeed bus. | |
514 | * | |
515 | * Hardware drivers use this to send a data packet to the frontend. | |
516 | * | |
517 | * @param sdi TODO. | |
518 | * @param packet The datafeed packet to send to the session bus. | |
519 | * | |
520 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. | |
521 | * | |
522 | * @private | |
523 | */ | |
524 | SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, | |
525 | const struct sr_datafeed_packet *packet) | |
526 | { | |
527 | GSList *l; | |
528 | struct datafeed_callback *cb_struct; | |
529 | ||
530 | if (!sdi) { | |
531 | sr_err("%s: sdi was NULL", __func__); | |
532 | return SR_ERR_ARG; | |
533 | } | |
534 | ||
535 | if (!packet) { | |
536 | sr_err("%s: packet was NULL", __func__); | |
537 | return SR_ERR_ARG; | |
538 | } | |
539 | ||
540 | for (l = session->datafeed_callbacks; l; l = l->next) { | |
541 | if (sr_log_loglevel_get() >= SR_LOG_DBG) | |
542 | datafeed_dump(packet); | |
543 | cb_struct = l->data; | |
544 | cb_struct->cb(sdi, packet, cb_struct->cb_data); | |
545 | } | |
546 | ||
547 | return SR_OK; | |
548 | } | |
549 | ||
550 | /** | |
551 | * Add an event source for a file descriptor. | |
552 | * | |
553 | * @param pollfd The GPollFD. | |
554 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
555 | * @param cb Callback function to add. Must not be NULL. | |
556 | * @param cb_data Data for the callback function. Can be NULL. | |
557 | * @param poll_object TODO. | |
558 | * | |
559 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
560 | * SR_ERR_MALLOC upon memory allocation errors. | |
561 | */ | |
562 | static int _sr_session_source_add(GPollFD *pollfd, int timeout, | |
563 | sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object) | |
564 | { | |
565 | struct source *new_sources, *s; | |
566 | GPollFD *new_pollfds; | |
567 | ||
568 | if (!cb) { | |
569 | sr_err("%s: cb was NULL", __func__); | |
570 | return SR_ERR_ARG; | |
571 | } | |
572 | ||
573 | /* Note: cb_data can be NULL, that's not a bug. */ | |
574 | ||
575 | new_pollfds = g_try_realloc(session->pollfds, | |
576 | sizeof(GPollFD) * (session->num_sources + 1)); | |
577 | if (!new_pollfds) { | |
578 | sr_err("%s: new_pollfds malloc failed", __func__); | |
579 | return SR_ERR_MALLOC; | |
580 | } | |
581 | ||
582 | new_sources = g_try_realloc(session->sources, sizeof(struct source) * | |
583 | (session->num_sources + 1)); | |
584 | if (!new_sources) { | |
585 | sr_err("%s: new_sources malloc failed", __func__); | |
586 | return SR_ERR_MALLOC; | |
587 | } | |
588 | ||
589 | new_pollfds[session->num_sources] = *pollfd; | |
590 | s = &new_sources[session->num_sources++]; | |
591 | s->timeout = timeout; | |
592 | s->cb = cb; | |
593 | s->cb_data = cb_data; | |
594 | s->poll_object = poll_object; | |
595 | session->pollfds = new_pollfds; | |
596 | session->sources = new_sources; | |
597 | ||
598 | if (timeout != session->source_timeout && timeout > 0 | |
599 | && (session->source_timeout == -1 || timeout < session->source_timeout)) | |
600 | session->source_timeout = timeout; | |
601 | ||
602 | return SR_OK; | |
603 | } | |
604 | ||
605 | /** | |
606 | * Add an event source for a file descriptor. | |
607 | * | |
608 | * @param fd The file descriptor. | |
609 | * @param events Events to check for. | |
610 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
611 | * @param cb Callback function to add. Must not be NULL. | |
612 | * @param cb_data Data for the callback function. Can be NULL. | |
613 | * | |
614 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
615 | * SR_ERR_MALLOC upon memory allocation errors. | |
616 | */ | |
617 | SR_API int sr_session_source_add(int fd, int events, int timeout, | |
618 | sr_receive_data_callback_t cb, void *cb_data) | |
619 | { | |
620 | GPollFD p; | |
621 | ||
622 | p.fd = fd; | |
623 | p.events = events; | |
624 | ||
625 | return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd); | |
626 | } | |
627 | ||
628 | /** | |
629 | * Add an event source for a GPollFD. | |
630 | * | |
631 | * @param pollfd The GPollFD. | |
632 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
633 | * @param cb Callback function to add. Must not be NULL. | |
634 | * @param cb_data Data for the callback function. Can be NULL. | |
635 | * | |
636 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
637 | * SR_ERR_MALLOC upon memory allocation errors. | |
638 | */ | |
639 | SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, | |
640 | sr_receive_data_callback_t cb, void *cb_data) | |
641 | { | |
642 | return _sr_session_source_add(pollfd, timeout, cb, | |
643 | cb_data, (gintptr)pollfd); | |
644 | } | |
645 | ||
646 | /** | |
647 | * Add an event source for a GIOChannel. | |
648 | * | |
649 | * @param channel The GIOChannel. | |
650 | * @param events Events to poll on. | |
651 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
652 | * @param cb Callback function to add. Must not be NULL. | |
653 | * @param cb_data Data for the callback function. Can be NULL. | |
654 | * | |
655 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
656 | * SR_ERR_MALLOC upon memory allocation errors. | |
657 | */ | |
658 | SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, | |
659 | int timeout, sr_receive_data_callback_t cb, void *cb_data) | |
660 | { | |
661 | GPollFD p; | |
662 | ||
663 | #ifdef _WIN32 | |
664 | g_io_channel_win32_make_pollfd(channel, events, &p); | |
665 | #else | |
666 | p.fd = g_io_channel_unix_get_fd(channel); | |
667 | p.events = events; | |
668 | #endif | |
669 | ||
670 | return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel); | |
671 | } | |
672 | ||
673 | /** | |
674 | * Remove the source belonging to the specified channel. | |
675 | * | |
676 | * @todo Add more error checks and logging. | |
677 | * | |
678 | * @param channel The channel for which the source should be removed. | |
679 | * | |
680 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
681 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
682 | * internal errors. | |
683 | */ | |
684 | static int _sr_session_source_remove(gintptr poll_object) | |
685 | { | |
686 | struct source *new_sources; | |
687 | GPollFD *new_pollfds; | |
688 | unsigned int old; | |
689 | ||
690 | if (!session->sources || !session->num_sources) { | |
691 | sr_err("%s: sources was NULL", __func__); | |
692 | return SR_ERR_BUG; | |
693 | } | |
694 | ||
695 | for (old = 0; old < session->num_sources; old++) { | |
696 | if (session->sources[old].poll_object == poll_object) | |
697 | break; | |
698 | } | |
699 | ||
700 | /* fd not found, nothing to do */ | |
701 | if (old == session->num_sources) | |
702 | return SR_OK; | |
703 | ||
704 | session->num_sources -= 1; | |
705 | ||
706 | if (old != session->num_sources) { | |
707 | memmove(&session->pollfds[old], &session->pollfds[old+1], | |
708 | (session->num_sources - old) * sizeof(GPollFD)); | |
709 | memmove(&session->sources[old], &session->sources[old+1], | |
710 | (session->num_sources - old) * sizeof(struct source)); | |
711 | } | |
712 | ||
713 | new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources); | |
714 | if (!new_pollfds && session->num_sources > 0) { | |
715 | sr_err("%s: new_pollfds malloc failed", __func__); | |
716 | return SR_ERR_MALLOC; | |
717 | } | |
718 | ||
719 | new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources); | |
720 | if (!new_sources && session->num_sources > 0) { | |
721 | sr_err("%s: new_sources malloc failed", __func__); | |
722 | return SR_ERR_MALLOC; | |
723 | } | |
724 | ||
725 | session->pollfds = new_pollfds; | |
726 | session->sources = new_sources; | |
727 | ||
728 | return SR_OK; | |
729 | } | |
730 | ||
731 | /** | |
732 | * Remove the source belonging to the specified file descriptor. | |
733 | * | |
734 | * @param fd The file descriptor for which the source should be removed. | |
735 | * | |
736 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
737 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
738 | * internal errors. | |
739 | */ | |
740 | SR_API int sr_session_source_remove(int fd) | |
741 | { | |
742 | return _sr_session_source_remove((gintptr)fd); | |
743 | } | |
744 | ||
745 | /** | |
746 | * Remove the source belonging to the specified poll descriptor. | |
747 | * | |
748 | * @param pollfd The poll descriptor for which the source should be removed. | |
749 | * | |
750 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
751 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
752 | * internal errors. | |
753 | */ | |
754 | SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd) | |
755 | { | |
756 | return _sr_session_source_remove((gintptr)pollfd); | |
757 | } | |
758 | ||
759 | /** | |
760 | * Remove the source belonging to the specified channel. | |
761 | * | |
762 | * @param channel The channel for which the source should be removed. | |
763 | * | |
764 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
765 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
766 | * internal errors. | |
767 | */ | |
768 | SR_API int sr_session_source_remove_channel(GIOChannel *channel) | |
769 | { | |
770 | return _sr_session_source_remove((gintptr)channel); | |
771 | } | |
772 | ||
773 | /** @} */ |