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