sr: extra checks for properly handling driverless devices
[sigrok:sigrok.git] / libsigrok / session.c
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 struct source {
29         int timeout;
30         sr_receive_data_callback_t cb;
31         void *cb_data;
32
33         /* This is used to keep track of the object (fd, pollfd or channel) which is
34          * being polled and will be used to match the source when removing it again.
35          */
36         gintptr poll_object;
37 };
38
39 /* There can only be one session at a time. */
40 /* 'session' is not static, it's used elsewhere (via 'extern'). */
41 struct sr_session *session;
42
43 /**
44  * Create a new session.
45  *
46  * TODO: Should it use the file-global "session" variable or take an argument?
47  *       The same question applies to all the other session functions.
48  *
49  * @return A pointer to the newly allocated session, or NULL upon errors.
50  */
51 SR_API struct sr_session *sr_session_new(void)
52 {
53         if (!(session = g_try_malloc0(sizeof(struct sr_session)))) {
54                 sr_err("session: %s: session malloc failed", __func__);
55                 return NULL; /* TODO: SR_ERR_MALLOC? */
56         }
57
58         session->source_timeout = -1;
59
60         return session;
61 }
62
63 /**
64  * Destroy the current session.
65  *
66  * This frees up all memory used by the session.
67  *
68  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
69  */
70 SR_API int sr_session_destroy(void)
71 {
72         if (!session) {
73                 sr_err("session: %s: session was NULL", __func__);
74                 return SR_ERR_BUG;
75         }
76
77         sr_session_dev_remove_all();
78
79         /* TODO: Error checks needed? */
80
81         /* TODO: Loop over protocol decoders and free them. */
82
83         g_free(session);
84         session = NULL;
85
86         return SR_OK;
87 }
88
89 static void sr_dev_close(struct sr_dev *dev)
90 {
91         if (dev && dev->driver && dev->driver->dev_close)
92                 dev->driver->dev_close(dev->driver_index);
93 }
94
95 /**
96  * Remove all the devices from the current session. TODO?
97  *
98  * The session itself (i.e., the struct sr_session) is not free'd and still
99  * exists after this function returns.
100  *
101  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
102  */
103 SR_API int sr_session_dev_remove_all(void)
104 {
105         if (!session) {
106                 sr_err("session: %s: session was NULL", __func__);
107                 return SR_ERR_BUG;
108         }
109
110         g_slist_free_full(session->devs, (GDestroyNotify)sr_dev_close);
111         session->devs = NULL;
112
113         return SR_OK;
114 }
115
116 /**
117  * Add a device to the current session.
118  *
119  * @param dev The device to add to the current session. Must not be NULL.
120  *            Also, dev->driver and dev->driver->dev_open must not be NULL.
121  *
122  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
123  */
124 SR_API int sr_session_dev_add(struct sr_dev *dev)
125 {
126         int ret;
127
128         if (!dev) {
129                 sr_err("session: %s: dev was NULL", __func__);
130                 return SR_ERR_ARG;
131         }
132
133         if (!session) {
134                 sr_err("session: %s: session was NULL", __func__);
135                 return SR_ERR_BUG;
136         }
137
138         /* If dev->driver is NULL, this is a virtual device. */
139         if (!dev->driver) {
140                 sr_dbg("session: %s: dev->driver was NULL, this seems to be "
141                        "a virtual device; continuing", __func__);
142                 /* Just add the device, don't run dev_open(). */
143                 session->devs = g_slist_append(session->devs, dev);
144                 return SR_OK;
145         }
146
147         /* dev->driver is non-NULL (i.e. we have a real device). */
148         if (!dev->driver->dev_open) {
149                 sr_err("session: %s: dev->driver->dev_open was NULL",
150                        __func__);
151                 return SR_ERR_BUG;
152         }
153
154         if ((ret = dev->driver->dev_open(dev->driver_index)) != SR_OK) {
155                 sr_err("session: %s: dev_open failed (%d)", __func__, ret);
156                 return ret;
157         }
158
159         session->devs = g_slist_append(session->devs, dev);
160
161         return SR_OK;
162 }
163
164 /**
165  * Remove all datafeed callbacks in the current session.
166  *
167  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
168  */
169 SR_API int sr_session_datafeed_callback_remove_all(void)
170 {
171         if (!session) {
172                 sr_err("session: %s: session was NULL", __func__);
173                 return SR_ERR_BUG;
174         }
175
176         g_slist_free(session->datafeed_callbacks);
177         session->datafeed_callbacks = NULL;
178
179         return SR_OK;
180 }
181
182 /**
183  * Add a datafeed callback to the current session.
184  *
185  * @param cb Function to call when a chunk of data is received.
186  *           Must not be NULL.
187  *
188  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
189  */
190 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb)
191 {
192         if (!session) {
193                 sr_err("session: %s: session was NULL", __func__);
194                 return SR_ERR_BUG;
195         }
196
197         if (!cb) {
198                 sr_err("session: %s: cb was NULL", __func__);
199                 return SR_ERR_ARG;
200         }
201
202         session->datafeed_callbacks =
203             g_slist_append(session->datafeed_callbacks, cb);
204
205         return SR_OK;
206 }
207
208 /**
209  * TODO.
210  */
211 static int sr_session_run_poll(void)
212 {
213         unsigned int i;
214         int ret;
215
216         while (session->running) {
217                 ret = g_poll(session->pollfds, session->num_sources, session->source_timeout);
218
219                 for (i = 0; i < session->num_sources; i++) {
220                         if (session->pollfds[i].revents > 0 || (ret == 0
221                                 && session->source_timeout == session->sources[i].timeout)) {
222                                 /*
223                                  * Invoke the source's callback on an event,
224                                  * or if the poll timeout out and this source
225                                  * asked for that timeout.
226                                  */
227                                 if (!session->sources[i].cb(session->pollfds[i].fd, session->pollfds[i].revents,
228                                                   session->sources[i].cb_data))
229                                         sr_session_source_remove(session->sources[i].poll_object);
230                         }
231                 }
232         }
233
234         return SR_OK;
235 }
236
237 /**
238  * Start a session.
239  *
240  * There can only be one session at a time.
241  *
242  * @return SR_OK upon success, SR_ERR upon errors.
243  */
244 SR_API int sr_session_start(void)
245 {
246         struct sr_dev *dev;
247         GSList *l;
248         int ret;
249
250         if (!session) {
251                 sr_err("session: %s: session was NULL; a session must be "
252                        "created first, before starting it.", __func__);
253                 return SR_ERR_BUG;
254         }
255
256         if (!session->devs) {
257                 /* TODO: Actually the case? */
258                 sr_err("session: %s: session->devs was NULL; a session "
259                        "cannot be started without devices.", __func__);
260                 return SR_ERR_BUG;
261         }
262
263         /* TODO: Check driver_index validity? */
264
265         sr_info("session: starting");
266
267         for (l = session->devs; l; l = l->next) {
268                 dev = l->data;
269                 /* TODO: Check for dev != NULL. */
270                 if ((ret = dev->driver->dev_acquisition_start(
271                                 dev->driver_index, dev)) != SR_OK) {
272                         sr_err("session: %s: could not start an acquisition "
273                                "(%d)", __func__, ret);
274                         break;
275                 }
276         }
277
278         /* TODO: What if there are multiple devices? Which return code? */
279
280         return ret;
281 }
282
283 /**
284  * Run the session.
285  *
286  * TODO: Various error checks etc.
287  *
288  * @return SR_OK upon success, SR_ERR_BUG upon errors.
289  */
290 SR_API int sr_session_run(void)
291 {
292         if (!session) {
293                 sr_err("session: %s: session was NULL; a session must be "
294                        "created first, before running it.", __func__);
295                 return SR_ERR_BUG;
296         }
297
298         if (!session->devs) {
299                 /* TODO: Actually the case? */
300                 sr_err("session: %s: session->devs was NULL; a session "
301                        "cannot be run without devices.", __func__);
302                 return SR_ERR_BUG;
303         }
304
305         sr_info("session: running");
306         session->running = TRUE;
307
308         /* Do we have real sources? */
309         if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
310                 /* Dummy source, freewheel over it. */
311                 while (session->running)
312                         session->sources[0].cb(-1, 0, session->sources[0].cb_data);
313         } else {
314                 /* Real sources, use g_poll() main loop. */
315                 sr_session_run_poll();
316         }
317
318         return SR_OK;
319 }
320
321 /**
322  * Halt the current session.
323  *
324  * This function is deprecated and should not be used in new code, use
325  * sr_session_stop() instead. The behaviour of this function is identical to
326  * sr_session_stop().
327  *
328  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
329  */
330 SR_API int sr_session_halt(void)
331 {
332         return sr_session_stop();
333 }
334
335 /**
336  * Stop the current session.
337  *
338  * The current session is stopped immediately, with all acquisition sessions
339  * being stopped and hardware drivers cleaned up.
340  *
341  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
342  */
343 SR_API int sr_session_stop(void)
344 {
345         struct sr_dev *dev;
346         GSList *l;
347
348         if (!session) {
349                 sr_err("session: %s: session was NULL", __func__);
350                 return SR_ERR_BUG;
351         }
352
353         sr_info("session: stopping");
354         session->running = FALSE;
355
356         for (l = session->devs; l; l = l->next) {
357                 dev = l->data;
358                 /* Check for dev != NULL. */
359                 if (dev->driver) {
360                         if (dev->driver->dev_acquisition_stop)
361                                 dev->driver->dev_acquisition_stop(dev->driver_index, dev);
362                 }
363         }
364
365         return SR_OK;
366 }
367
368 /**
369  * Debug helper.
370  *
371  * @param packet The packet to show debugging information for.
372  */
373 static void datafeed_dump(struct sr_datafeed_packet *packet)
374 {
375         struct sr_datafeed_logic *logic;
376         struct sr_datafeed_analog *analog;
377
378         switch (packet->type) {
379         case SR_DF_HEADER:
380                 sr_dbg("bus: received SR_DF_HEADER");
381                 break;
382         case SR_DF_TRIGGER:
383                 sr_dbg("bus: received SR_DF_TRIGGER");
384                 break;
385         case SR_DF_META_LOGIC:
386                 sr_dbg("bus: received SR_DF_META_LOGIC");
387                 break;
388         case SR_DF_LOGIC:
389                 logic = packet->payload;
390                 /* TODO: Check for logic != NULL. */
391                 sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length);
392                 break;
393         case SR_DF_META_ANALOG:
394                 sr_dbg("bus: received SR_DF_META_LOGIC");
395                 break;
396         case SR_DF_ANALOG:
397                 analog = packet->payload;
398                 /* TODO: Check for analog != NULL. */
399                 sr_dbg("bus: received SR_DF_ANALOG %d samples", analog->num_samples);
400                 break;
401         case SR_DF_END:
402                 sr_dbg("bus: received SR_DF_END");
403                 break;
404         case SR_DF_FRAME_BEGIN:
405                 sr_dbg("bus: received SR_DF_FRAME_BEGIN");
406                 break;
407         case SR_DF_FRAME_END:
408                 sr_dbg("bus: received SR_DF_FRAME_END");
409                 break;
410         default:
411                 sr_dbg("bus: received unknown packet type %d", packet->type);
412                 break;
413         }
414 }
415
416 /**
417  * Send a packet to whatever is listening on the datafeed bus.
418  *
419  * Hardware drivers use this to send a data packet to the frontend.
420  *
421  * @param dev TODO.
422  * @param packet The datafeed packet to send to the session bus.
423  *
424  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
425  */
426 SR_PRIV int sr_session_send(struct sr_dev *dev,
427                             struct sr_datafeed_packet *packet)
428 {
429         GSList *l;
430         sr_datafeed_callback_t cb;
431
432         if (!dev) {
433                 sr_err("session: %s: dev was NULL", __func__);
434                 return SR_ERR_ARG;
435         }
436
437         if (!packet) {
438                 sr_err("session: %s: packet was NULL", __func__);
439                 return SR_ERR_ARG;
440         }
441
442         for (l = session->datafeed_callbacks; l; l = l->next) {
443                 if (sr_log_loglevel_get() >= SR_LOG_DBG)
444                         datafeed_dump(packet);
445                 cb = l->data;
446                 /* TODO: Check for cb != NULL. */
447                 cb(dev, packet);
448         }
449
450         return SR_OK;
451 }
452
453 static int _sr_session_source_add(GPollFD *pollfd, int timeout,
454         sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
455 {
456         struct source *new_sources, *s;
457         GPollFD *new_pollfds;
458
459         if (!cb) {
460                 sr_err("session: %s: cb was NULL", __func__);
461                 return SR_ERR_ARG;
462         }
463
464         /* Note: cb_data can be NULL, that's not a bug. */
465
466         new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * (session->num_sources + 1));
467         if (!new_pollfds) {
468                 sr_err("session: %s: new_pollfds malloc failed", __func__);
469                 return SR_ERR_MALLOC;
470         }
471
472         new_sources = g_try_realloc(session->sources, sizeof(struct source) *
473         (session->num_sources + 1));
474         if (!new_sources) {
475                 sr_err("session: %s: new_sources malloc failed", __func__);
476                 return SR_ERR_MALLOC;
477         }
478
479         new_pollfds[session->num_sources] = *pollfd;
480         s = &new_sources[session->num_sources++];
481         s->timeout = timeout;
482         s->cb = cb;
483         s->cb_data = cb_data;
484         s->poll_object = poll_object;
485         session->pollfds = new_pollfds;
486         session->sources = new_sources;
487
488         if (timeout != session->source_timeout && timeout > 0
489             && (session->source_timeout == -1 || timeout < session->source_timeout))
490                 session->source_timeout = timeout;
491
492         return SR_OK;
493 }
494
495 /**
496  * Add a event source for a file descriptor.
497  *
498  * @param fd The file descriptor.
499  * @param events Events to check for.
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  *
504  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
505  *         SR_ERR_MALLOC upon memory allocation errors.
506  */
507 SR_API int sr_session_source_add(int fd, int events, int timeout,
508                 sr_receive_data_callback_t cb, void *cb_data)
509 {
510         GPollFD p;
511
512         p.fd = fd;
513         p.events = events;
514
515         return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd);
516 }
517
518 /**
519  * Add an event source for a GPollFD.
520  *
521  * TODO: More error checks etc.
522  *
523  * @param pollfd The GPollFD.
524  * @param timeout Max time to wait before the callback is called, ignored if 0.
525  * @param cb Callback function to add. Must not be NULL.
526  * @param cb_data Data for the callback function. Can be NULL.
527  *
528  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
529  *         SR_ERR_MALLOC upon memory allocation errors.
530  */
531 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
532                 sr_receive_data_callback_t cb, void *cb_data)
533 {
534         return _sr_session_source_add(pollfd, timeout, cb,
535                                       cb_data, (gintptr)pollfd);
536 }
537
538 /**
539  * Add an event source for a GIOChannel.
540  *
541  * TODO: More error checks etc.
542  *
543  * @param channel The GIOChannel.
544  * @param events Events to poll on.
545  * @param timeout Max time to wait before the callback is called, ignored if 0.
546  * @param cb Callback function to add. Must not be NULL.
547  * @param cb_data Data for the callback function. Can be NULL.
548  *
549  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
550  *         SR_ERR_MALLOC upon memory allocation errors.
551  */
552 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
553                 int timeout, sr_receive_data_callback_t cb, void *cb_data)
554 {
555         GPollFD p;
556
557 #ifdef _WIN32
558         g_io_channel_win32_make_pollfd(channel,
559                         events, &p);
560 #else
561         p.fd = g_io_channel_unix_get_fd(channel);
562         p.events = events;
563 #endif
564
565         return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
566 }
567
568
569 static int _sr_session_source_remove(gintptr poll_object)
570 {
571         struct source *new_sources;
572         GPollFD *new_pollfds;
573         unsigned int old;
574
575         if (!session->sources || !session->num_sources) {
576                 sr_err("session: %s: sources was NULL", __func__);
577                 return SR_ERR_BUG;
578         }
579
580         for (old = 0; old < session->num_sources; old++) {
581                 if (session->sources[old].poll_object == poll_object)
582                         break;
583         }
584
585         /* fd not found, nothing to do */
586         if (old == session->num_sources)
587                 return SR_OK;
588
589         session->num_sources -= 1;
590
591         if (old != session->num_sources) {
592                 memmove(&session->pollfds[old], &session->pollfds[old+1],
593                         (session->num_sources - old) * sizeof(GPollFD));
594                 memmove(&session->sources[old], &session->sources[old+1],
595                         (session->num_sources - old) * sizeof(struct source));
596         }
597
598         new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources);
599         if (!new_pollfds && session->num_sources > 0) {
600                 sr_err("session: %s: new_pollfds malloc failed", __func__);
601                 return SR_ERR_MALLOC;
602         }
603
604         new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources);
605         if (!new_sources && session->num_sources > 0) {
606                 sr_err("session: %s: new_sources malloc failed", __func__);
607                 return SR_ERR_MALLOC;
608         }
609
610         session->pollfds = new_pollfds;
611         session->sources = new_sources;
612
613         return SR_OK;
614 }
615
616 /*
617  * Remove the source belonging to the specified file descriptor.
618  *
619  * TODO: More error checks.
620  *
621  * @param fd The file descriptor for which the source should be removed.
622  *
623  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
624  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
625  *         internal errors.
626  */
627 SR_API int sr_session_source_remove(int fd)
628 {
629         return _sr_session_source_remove((gintptr)fd);
630 }
631
632 /**
633  * Remove the source belonging to the specified poll descriptor.
634  *
635  * TODO: More error checks.
636  *
637  * @param pollfd The poll descriptor for which the source should be removed.
638  *
639  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
640  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
641  *         internal errors.
642  */
643 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
644 {
645         return _sr_session_source_remove((gintptr)pollfd);
646 }
647
648 /*
649  * Remove the source belonging to the specified channel.
650  *
651  * TODO: More error checks.
652  *
653  * @param channel The channel for which the source should be removed.
654  *
655  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
656  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
657  *         internal errors.
658  */
659 SR_API int sr_session_source_remove_channel(GIOChannel *channel)
660 {
661         return _sr_session_source_remove((gintptr)channel);
662 }