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_inst *sdi)
  90 {
  91         if (sdi->driver && sdi->driver->dev_close)
  92                 sdi->driver->dev_close(sdi);
  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 instance to add to the current session. Must not
 120  *            be NULL. Also, sdi->driver and sdi->driver->dev_open must
 121  *            not be NULL.
 122  *
 123  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
 124  */
 125 SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
 126 {
 127         int ret;
 128
 129         if (!sdi) {
 130                 sr_err("session: %s: sdi was NULL", __func__);
 131                 return SR_ERR_ARG;
 132         }
 133
 134         if (!session) {
 135                 sr_err("session: %s: session was NULL", __func__);
 136                 return SR_ERR_BUG;
 137         }
 138
 139         /* If sdi->driver is NULL, this is a virtual device. */
 140         if (!sdi->driver) {
 141                 sr_dbg("session: %s: sdi->driver was NULL, this seems to be "
 142                        "a virtual device; continuing", __func__);
 143                 /* Just add the device, don't run dev_open(). */
 144                 session->devs = g_slist_append(session->devs, (gpointer)sdi);
 145                 return SR_OK;
 146         }
 147
 148         /* sdi->driver is non-NULL (i.e. we have a real device). */
 149         if (!sdi->driver->dev_open) {
 150                 sr_err("session: %s: sdi->driver->dev_open was NULL", __func__);
 151                 return SR_ERR_BUG;
 152         }
 153
 154         if ((ret = sdi->driver->dev_open((struct sr_dev_inst *)sdi)) != 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, (gpointer)sdi);
 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_inst *sdi;
 247         GSList *l;
 248         int ret;
 249
 250         if (!session) {
 251                 sr_err("session: %s: session was NULL; a session must be "
 252                        "created before starting it.", __func__);
 253                 return SR_ERR_BUG;
 254         }
 255
 256         if (!session->devs) {
 257                 sr_err("session: %s: session->devs was NULL; a session "
 258                        "cannot be started without devices.", __func__);
 259                 return SR_ERR_BUG;
 260         }
 261
 262         sr_info("session: starting");
 263
 264         for (l = session->devs; l; l = l->next) {
 265                 sdi = l->data;
 266                 if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
 267                         sr_err("session: %s: could not start an acquisition "
 268                                "(%d)", __func__, ret);
 269                         break;
 270                 }
 271         }
 272
 273         /* TODO: What if there are multiple devices? Which return code? */
 274
 275         return ret;
 276 }
 277
 278 /**
 279  * Run the session.
 280  *
 281  * TODO: Various error checks etc.
 282  *
 283  * @return SR_OK upon success, SR_ERR_BUG upon errors.
 284  */
 285 SR_API int sr_session_run(void)
 286 {
 287         if (!session) {
 288                 sr_err("session: %s: session was NULL; a session must be "
 289                        "created first, before running it.", __func__);
 290                 return SR_ERR_BUG;
 291         }
 292
 293         if (!session->devs) {
 294                 /* TODO: Actually the case? */
 295                 sr_err("session: %s: session->devs was NULL; a session "
 296                        "cannot be run without devices.", __func__);
 297                 return SR_ERR_BUG;
 298         }
 299
 300         sr_info("session: running");
 301         session->running = TRUE;
 302
 303         /* Do we have real sources? */
 304         if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
 305                 /* Dummy source, freewheel over it. */
 306                 while (session->running)
 307                         session->sources[0].cb(-1, 0, session->sources[0].cb_data);
 308         } else {
 309                 /* Real sources, use g_poll() main loop. */
 310                 sr_session_run_poll();
 311         }
 312
 313         return SR_OK;
 314 }
 315
 316 /**
 317  * Halt the current session.
 318  *
 319  * This function is deprecated and should not be used in new code, use
 320  * sr_session_stop() instead. The behaviour of this function is identical to
 321  * sr_session_stop().
 322  *
 323  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 324  */
 325 SR_API int sr_session_halt(void)
 326 {
 327         return sr_session_stop();
 328 }
 329
 330 /**
 331  * Stop the current session.
 332  *
 333  * The current session is stopped immediately, with all acquisition sessions
 334  * being stopped and hardware drivers cleaned up.
 335  *
 336  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 337  */
 338 SR_API int sr_session_stop(void)
 339 {
 340         struct sr_dev_inst *sdi;
 341         GSList *l;
 342
 343         if (!session) {
 344                 sr_err("session: %s: session was NULL", __func__);
 345                 return SR_ERR_BUG;
 346         }
 347
 348         sr_info("session: stopping");
 349         session->running = FALSE;
 350
 351         for (l = session->devs; l; l = l->next) {
 352                 sdi = l->data;
 353                 if (sdi->driver) {
 354                         if (sdi->driver->dev_acquisition_stop)
 355                                 sdi->driver->dev_acquisition_stop(sdi, sdi);
 356                 }
 357         }
 358
 359         return SR_OK;
 360 }
 361
 362 /**
 363  * Debug helper.
 364  *
 365  * @param packet The packet to show debugging information for.
 366  */
 367 static void datafeed_dump(struct sr_datafeed_packet *packet)
 368 {
 369         struct sr_datafeed_logic *logic;
 370         struct sr_datafeed_analog *analog;
 371
 372         switch (packet->type) {
 373         case SR_DF_HEADER:
 374                 sr_dbg("bus: received SR_DF_HEADER");
 375                 break;
 376         case SR_DF_TRIGGER:
 377                 sr_dbg("bus: received SR_DF_TRIGGER");
 378                 break;
 379         case SR_DF_META_LOGIC:
 380                 sr_dbg("bus: received SR_DF_META_LOGIC");
 381                 break;
 382         case SR_DF_LOGIC:
 383                 logic = packet->payload;
 384                 /* TODO: Check for logic != NULL. */
 385                 sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length);
 386                 break;
 387         case SR_DF_META_ANALOG:
 388                 sr_dbg("bus: received SR_DF_META_LOGIC");
 389                 break;
 390         case SR_DF_ANALOG:
 391                 analog = packet->payload;
 392                 /* TODO: Check for analog != NULL. */
 393                 sr_dbg("bus: received SR_DF_ANALOG %d samples", analog->num_samples);
 394                 break;
 395         case SR_DF_END:
 396                 sr_dbg("bus: received SR_DF_END");
 397                 break;
 398         case SR_DF_FRAME_BEGIN:
 399                 sr_dbg("bus: received SR_DF_FRAME_BEGIN");
 400                 break;
 401         case SR_DF_FRAME_END:
 402                 sr_dbg("bus: received SR_DF_FRAME_END");
 403                 break;
 404         default:
 405                 sr_dbg("bus: received unknown packet type %d", packet->type);
 406                 break;
 407         }
 408 }
 409
 410 /**
 411  * Send a packet to whatever is listening on the datafeed bus.
 412  *
 413  * Hardware drivers use this to send a data packet to the frontend.
 414  *
 415  * @param dev TODO.
 416  * @param packet The datafeed packet to send to the session bus.
 417  *
 418  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
 419  */
 420 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 421                             struct sr_datafeed_packet *packet)
 422 {
 423         GSList *l;
 424         sr_datafeed_callback_t cb;
 425
 426         if (!sdi) {
 427                 sr_err("session: %s: sdi was NULL", __func__);
 428                 return SR_ERR_ARG;
 429         }
 430
 431         if (!packet) {
 432                 sr_err("session: %s: packet was NULL", __func__);
 433                 return SR_ERR_ARG;
 434         }
 435
 436         for (l = session->datafeed_callbacks; l; l = l->next) {
 437                 if (sr_log_loglevel_get() >= SR_LOG_DBG)
 438                         datafeed_dump(packet);
 439                 cb = l->data;
 440                 cb(sdi, packet);
 441         }
 442
 443         return SR_OK;
 444 }
 445
 446 static int _sr_session_source_add(GPollFD *pollfd, int timeout,
 447         sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
 448 {
 449         struct source *new_sources, *s;
 450         GPollFD *new_pollfds;
 451
 452         if (!cb) {
 453                 sr_err("session: %s: cb was NULL", __func__);
 454                 return SR_ERR_ARG;
 455         }
 456
 457         /* Note: cb_data can be NULL, that's not a bug. */
 458
 459         new_pollfds = g_try_realloc(session->pollfds,
 460                         sizeof(GPollFD) * (session->num_sources + 1));
 461         if (!new_pollfds) {
 462                 sr_err("session: %s: new_pollfds malloc failed", __func__);
 463                 return SR_ERR_MALLOC;
 464         }
 465
 466         new_sources = g_try_realloc(session->sources, sizeof(struct source) *
 467                         (session->num_sources + 1));
 468         if (!new_sources) {
 469                 sr_err("session: %s: new_sources malloc failed", __func__);
 470                 return SR_ERR_MALLOC;
 471         }
 472
 473         new_pollfds[session->num_sources] = *pollfd;
 474         s = &new_sources[session->num_sources++];
 475         s->timeout = timeout;
 476         s->cb = cb;
 477         s->cb_data = cb_data;
 478         s->poll_object = poll_object;
 479         session->pollfds = new_pollfds;
 480         session->sources = new_sources;
 481
 482         if (timeout != session->source_timeout && timeout > 0
 483             && (session->source_timeout == -1 || timeout < session->source_timeout))
 484                 session->source_timeout = timeout;
 485
 486         return SR_OK;
 487 }
 488
 489 /**
 490  * Add a event source for a file descriptor.
 491  *
 492  * @param fd The file descriptor.
 493  * @param events Events to check for.
 494  * @param timeout Max time to wait before the callback is called, ignored if 0.
 495  * @param cb Callback function to add. Must not be NULL.
 496  * @param cb_data Data for the callback function. Can be NULL.
 497  *
 498  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 499  *         SR_ERR_MALLOC upon memory allocation errors.
 500  */
 501 SR_API int sr_session_source_add(int fd, int events, int timeout,
 502                 sr_receive_data_callback_t cb, void *cb_data)
 503 {
 504         GPollFD p;
 505
 506         p.fd = fd;
 507         p.events = events;
 508
 509         return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd);
 510 }
 511
 512 /**
 513  * Add an event source for a GPollFD.
 514  *
 515  * TODO: More error checks etc.
 516  *
 517  * @param pollfd The GPollFD.
 518  * @param timeout Max time to wait before the callback is called, ignored if 0.
 519  * @param cb Callback function to add. Must not be NULL.
 520  * @param cb_data Data for the callback function. Can be NULL.
 521  *
 522  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 523  *         SR_ERR_MALLOC upon memory allocation errors.
 524  */
 525 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
 526                 sr_receive_data_callback_t cb, void *cb_data)
 527 {
 528         return _sr_session_source_add(pollfd, timeout, cb,
 529                                       cb_data, (gintptr)pollfd);
 530 }
 531
 532 /**
 533  * Add an event source for a GIOChannel.
 534  *
 535  * TODO: More error checks etc.
 536  *
 537  * @param channel The GIOChannel.
 538  * @param events Events to poll on.
 539  * @param timeout Max time to wait before the callback is called, ignored if 0.
 540  * @param cb Callback function to add. Must not be NULL.
 541  * @param cb_data Data for the callback function. Can be NULL.
 542  *
 543  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 544  *         SR_ERR_MALLOC upon memory allocation errors.
 545  */
 546 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
 547                 int timeout, sr_receive_data_callback_t cb, void *cb_data)
 548 {
 549         GPollFD p;
 550
 551 #ifdef _WIN32
 552         g_io_channel_win32_make_pollfd(channel,
 553                         events, &p);
 554 #else
 555         p.fd = g_io_channel_unix_get_fd(channel);
 556         p.events = events;
 557 #endif
 558
 559         return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
 560 }
 561
 562
 563 static int _sr_session_source_remove(gintptr poll_object)
 564 {
 565         struct source *new_sources;
 566         GPollFD *new_pollfds;
 567         unsigned int old;
 568
 569         if (!session->sources || !session->num_sources) {
 570                 sr_err("session: %s: sources was NULL", __func__);
 571                 return SR_ERR_BUG;
 572         }
 573
 574         for (old = 0; old < session->num_sources; old++) {
 575                 if (session->sources[old].poll_object == poll_object)
 576                         break;
 577         }
 578
 579         /* fd not found, nothing to do */
 580         if (old == session->num_sources)
 581                 return SR_OK;
 582
 583         session->num_sources -= 1;
 584
 585         if (old != session->num_sources) {
 586                 memmove(&session->pollfds[old], &session->pollfds[old+1],
 587                         (session->num_sources - old) * sizeof(GPollFD));
 588                 memmove(&session->sources[old], &session->sources[old+1],
 589                         (session->num_sources - old) * sizeof(struct source));
 590         }
 591
 592         new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources);
 593         if (!new_pollfds && session->num_sources > 0) {
 594                 sr_err("session: %s: new_pollfds malloc failed", __func__);
 595                 return SR_ERR_MALLOC;
 596         }
 597
 598         new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources);
 599         if (!new_sources && session->num_sources > 0) {
 600                 sr_err("session: %s: new_sources malloc failed", __func__);
 601                 return SR_ERR_MALLOC;
 602         }
 603
 604         session->pollfds = new_pollfds;
 605         session->sources = new_sources;
 606
 607         return SR_OK;
 608 }
 609
 610 /*
 611  * Remove the source belonging to the specified file descriptor.
 612  *
 613  * TODO: More error checks.
 614  *
 615  * @param fd The file descriptor for which the source should be removed.
 616  *
 617  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 618  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 619  *         internal errors.
 620  */
 621 SR_API int sr_session_source_remove(int fd)
 622 {
 623         return _sr_session_source_remove((gintptr)fd);
 624 }
 625
 626 /**
 627  * Remove the source belonging to the specified poll descriptor.
 628  *
 629  * TODO: More error checks.
 630  *
 631  * @param pollfd The poll descriptor for which the source should be removed.
 632  *
 633  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 634  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 635  *         internal errors.
 636  */
 637 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
 638 {
 639         return _sr_session_source_remove((gintptr)pollfd);
 640 }
 641
 642 /*
 643  * Remove the source belonging to the specified channel.
 644  *
 645  * TODO: More error checks.
 646  *
 647  * @param channel The channel for which the source should be removed.
 648  *
 649  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 650  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 651  *         internal errors.
 652  */
 653 SR_API int sr_session_source_remove_channel(GIOChannel *channel)
 654 {
 655         return _sr_session_source_remove((gintptr)channel);
 656 }