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