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