session.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 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 "sigrok.h"
  26 #include "sigrok-internal.h"
  27
  28 /* demo.c. TODO: Should not be global! */
  29 extern SR_PRIV GIOChannel channels[2];
  30
  31 struct source {
  32         int fd;
  33         int events;
  34         int timeout;
  35         sr_receive_data_callback cb;
  36         void *user_data;
  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 static int num_sources = 0;
  43
  44 static struct source *sources = NULL;
  45 static int source_timeout = -1;
  46
  47 /**
  48  * Create a new session.
  49  *
  50  * TODO.
  51  *
  52  * TODO: Should return int?
  53  * TODO: Should it use the file-global "session" variable or take an argument?
  54  *       The same question applies to all the other session functions.
  55  *
  56  * @return A pointer to the newly allocated session, or NULL upon errors.
  57  */
  58 SR_API struct sr_session *sr_session_new(void)
  59 {
  60         if (!(session = calloc(1, sizeof(struct sr_session)))) {
  61                 sr_err("session: %s: session malloc failed", __func__);
  62                 return NULL; /* TODO: SR_ERR_MALLOC? */
  63         }
  64
  65         return session;
  66 }
  67
  68 /**
  69  * Destroy the current session.
  70  *
  71  * This frees up all memory used by the session.
  72  *
  73  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  74  */
  75 SR_API int sr_session_destroy(void)
  76 {
  77         if (!session) {
  78                 sr_warn("session: %s: session was NULL", __func__);
  79                 return SR_ERR_BUG;
  80         }
  81
  82         g_slist_free(session->devices);
  83         session->devices = NULL;
  84
  85         /* TODO: Error checks needed? */
  86
  87         /* TODO: Loop over protocol decoders and free them. */
  88
  89         g_free(session);
  90         session = NULL;
  91
  92         return SR_OK;
  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_device_clear(void)
 104 {
 105         if (!session) {
 106                 sr_warn("session: %s: session was NULL", __func__);
 107                 return SR_ERR_BUG;
 108         }
 109
 110         g_slist_free(session->devices);
 111         session->devices = NULL;
 112
 113         return SR_OK;
 114 }
 115
 116 /**
 117  * Add a device to the current session.
 118  *
 119  * @param device The device to add to the current session. Must not be NULL.
 120  *               Also, device->plugin and device->plugin->opendev must not
 121  *               be NULL.
 122  *
 123  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
 124  */
 125 SR_API int sr_session_device_add(struct sr_device *device)
 126 {
 127         int ret;
 128
 129         if (!device) {
 130                 sr_err("session: %s: device was NULL", __func__);
 131                 return SR_ERR_ARG;
 132         }
 133
 134         if (!device->plugin) {
 135                 sr_err("session: %s: device->plugin was NULL", __func__);
 136                 return SR_ERR_ARG;
 137         }
 138
 139         if (!device->plugin->opendev) {
 140                 sr_err("session: %s: device->plugin->opendev was NULL",
 141                        __func__);
 142                 return SR_ERR_ARG;
 143         }
 144
 145         if (!session) {
 146                 sr_err("session: %s: session was NULL", __func__);
 147                 return SR_ERR; /* TODO: SR_ERR_BUG? */
 148         }
 149
 150         if ((ret = device->plugin->opendev(device->plugin_index)) != SR_OK) {
 151                 sr_err("session: %s: opendev failed (%d)", __func__, ret);
 152                 return ret;
 153         }
 154
 155         session->devices = g_slist_append(session->devices, device);
 156
 157         return SR_OK;
 158 }
 159
 160 /**
 161  * Clear all datafeed callbacks in the current session.
 162  *
 163  * TODO.
 164  *
 165  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 166  */
 167 SR_API int sr_session_datafeed_callback_clear(void)
 168 {
 169         if (!session) {
 170                 sr_err("session: %s: session was NULL", __func__);
 171                 return SR_ERR_BUG;
 172         }
 173
 174         g_slist_free(session->datafeed_callbacks);
 175         session->datafeed_callbacks = NULL;
 176
 177         return SR_OK;
 178 }
 179
 180 /**
 181  * Add a datafeed callback to the current session.
 182  *
 183  * @param callback TODO.
 184  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 185  */
 186 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback callback)
 187 {
 188         if (!session) {
 189                 sr_err("session: %s: session was NULL", __func__);
 190                 return SR_ERR_BUG;
 191         }
 192
 193         /* TODO: Is 'callback' allowed to be NULL? */
 194
 195         session->datafeed_callbacks =
 196             g_slist_append(session->datafeed_callbacks, callback);
 197
 198         return SR_OK;
 199 }
 200
 201 /**
 202  * TODO.
 203  */
 204 static int sr_session_run_poll(void)
 205 {
 206         GPollFD *fds, my_gpollfd;
 207         int ret, i;
 208
 209         fds = NULL;
 210         while (session->running) {
 211                 if (fds)
 212                         free(fds);
 213
 214                 /* Construct g_poll()'s array. */
 215                 /* TODO: Check malloc return value. */
 216                 fds = malloc(sizeof(GPollFD) * num_sources);
 217                 if (!fds) {
 218                         sr_err("session: %s: fds malloc failed", __func__);
 219                         return SR_ERR_MALLOC;
 220                 }
 221                 for (i = 0; i < num_sources; i++) {
 222 #ifdef _WIN32
 223                         g_io_channel_win32_make_pollfd(&channels[0],
 224                                         sources[i].events, &my_gpollfd);
 225 #else
 226                         my_gpollfd.fd = sources[i].fd;
 227                         my_gpollfd.events = sources[i].events;
 228                         fds[i] = my_gpollfd;
 229 #endif
 230                 }
 231
 232                 ret = g_poll(fds, num_sources, source_timeout);
 233
 234                 for (i = 0; i < num_sources; i++) {
 235                         if (fds[i].revents > 0 || (ret == 0
 236                                 && source_timeout == sources[i].timeout)) {
 237                                 /*
 238                                  * Invoke the source's callback on an event,
 239                                  * or if the poll timeout out and this source
 240                                  * asked for that timeout.
 241                                  */
 242                                 if (!sources[i].cb(fds[i].fd, fds[i].revents,
 243                                                   sources[i].user_data))
 244                                         sr_session_source_remove(sources[i].fd);
 245                         }
 246                 }
 247         }
 248         free(fds);
 249
 250         return SR_OK;
 251 }
 252
 253 /**
 254  * Start a session.
 255  *
 256  * There can only be one session at a time. TODO
 257  *
 258  * @return SR_OK upon success, SR_ERR upon errors.
 259  */
 260 SR_API int sr_session_start(void)
 261 {
 262         struct sr_device *device;
 263         GSList *l;
 264         int ret;
 265
 266         if (!session) {
 267                 sr_err("session: %s: session was NULL; a session must be "
 268                        "created first, before starting it.", __func__);
 269                 return SR_ERR; /* TODO: SR_ERR_BUG? */
 270         }
 271
 272         if (!session->devices) {
 273                 /* TODO: Actually the case? */
 274                 sr_err("session: %s: session->devices was NULL; a session "
 275                        "cannot be started without devices.", __func__);
 276                 return SR_ERR; /* TODO: SR_ERR_BUG? */
 277         }
 278
 279         /* TODO: Check plugin_index validity? */
 280
 281         sr_info("session: starting");
 282
 283         for (l = session->devices; l; l = l->next) {
 284                 device = l->data;
 285                 /* TODO: Check for device != NULL. */
 286                 if ((ret = device->plugin->start_acquisition(
 287                                 device->plugin_index, device)) != SR_OK) {
 288                         sr_err("session: %s: could not start an acquisition "
 289                                "(%d)", __func__, ret);
 290                         break;
 291                 }
 292         }
 293
 294         /* TODO: What if there are multiple devices? Which return code? */
 295
 296         return ret;
 297 }
 298
 299 /**
 300  * Run the session.
 301  *
 302  * TODO: Various error checks etc.
 303  *
 304  * @return SR_OK upon success, SR_ERR_BUG upon errors.
 305  */
 306 SR_API int sr_session_run(void)
 307 {
 308         if (!session) {
 309                 sr_err("session: %s: session was NULL; a session must be "
 310                        "created first, before running it.", __func__);
 311                 return SR_ERR_BUG;
 312         }
 313
 314         if (!session->devices) {
 315                 /* TODO: Actually the case? */
 316                 sr_err("session: %s: session->devices was NULL; a session "
 317                        "cannot be run without devices.", __func__);
 318                 return SR_ERR_BUG;
 319         }
 320
 321         sr_info("session: running");
 322         session->running = TRUE;
 323
 324         /* Do we have real sources? */
 325         if (num_sources == 1 && sources[0].fd == -1) {
 326                 /* Dummy source, freewheel over it. */
 327                 while (session->running)
 328                         sources[0].cb(-1, 0, sources[0].user_data);
 329         } else {
 330                 /* Real sources, use g_poll() main loop. */
 331                 sr_session_run_poll();
 332         }
 333
 334         return SR_OK;
 335 }
 336
 337 /**
 338  * Halt the current session.
 339  *
 340  * TODO.
 341  *
 342  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 343  */
 344 SR_API int sr_session_halt(void)
 345 {
 346         if (!session) {
 347                 sr_err("session: %s: session was NULL", __func__);
 348                 return SR_ERR_BUG;
 349         }
 350
 351         sr_info("session: halting");
 352         session->running = FALSE;
 353
 354         return SR_OK;
 355 }
 356
 357 /**
 358  * Stop the current session.
 359  *
 360  * TODO: Difference to halt?
 361  *
 362  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 363  */
 364 SR_API int sr_session_stop(void)
 365 {
 366         struct sr_device *device;
 367         GSList *l;
 368
 369         if (!session) {
 370                 sr_err("session: %s: session was NULL", __func__);
 371                 return SR_ERR_BUG;
 372         }
 373
 374         sr_info("session: stopping");
 375         session->running = FALSE;
 376
 377         for (l = session->devices; l; l = l->next) {
 378                 device = l->data;
 379                 /* Check for device != NULL. */
 380                 if (device->plugin) {
 381                         if (device->plugin->stop_acquisition)
 382                                 device->plugin->stop_acquisition(device->plugin_index, device);
 383                         if (device->plugin->cleanup)
 384                                 device->plugin->cleanup();
 385                 }
 386         }
 387
 388         return SR_OK;
 389 }
 390
 391 /**
 392  * TODO.
 393  *
 394  * TODO: Various error checks.
 395  *
 396  * @param packet TODO.
 397  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
 398  */
 399 static int datafeed_dump(struct sr_datafeed_packet *packet)
 400 {
 401         struct sr_datafeed_logic *logic;
 402
 403         if (!packet) {
 404                 sr_err("session: %s: packet was NULL", __func__);
 405                 return SR_ERR_ARG;
 406         }
 407
 408         /* TODO: Validity checks for packet contents. */
 409
 410         switch (packet->type) {
 411         case SR_DF_HEADER:
 412                 sr_dbg("bus: received SR_DF_HEADER");
 413                 break;
 414         case SR_DF_TRIGGER:
 415                 sr_dbg("bus: received SR_DF_TRIGGER");
 416                 break;
 417         case SR_DF_LOGIC:
 418                 logic = packet->payload;
 419                 /* TODO: Check for logic != NULL. */
 420                 sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length);
 421                 break;
 422         case SR_DF_END:
 423                 sr_dbg("bus: received SR_DF_END");
 424                 break;
 425         default:
 426                 /* TODO: Abort? */
 427                 sr_err("bus: received unknown packet type %d", packet->type);
 428                 break;
 429         }
 430
 431         return SR_OK;
 432 }
 433
 434 /**
 435  * TODO.
 436  *
 437  * @param device TODO.
 438  * @param packet TODO.
 439  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
 440  */
 441 SR_API int sr_session_bus(struct sr_device *device,
 442                           struct sr_datafeed_packet *packet)
 443 {
 444         GSList *l;
 445         sr_datafeed_callback cb;
 446
 447         if (!device) {
 448                 sr_err("session: %s: device was NULL", __func__);
 449                 return SR_ERR_ARG;
 450         }
 451
 452         if (!device->plugin) {
 453                 sr_err("session: %s: device->plugin was NULL", __func__);
 454                 return SR_ERR_ARG;
 455         }
 456
 457         if (!packet) {
 458                 sr_err("session: %s: packet was NULL", __func__);
 459                 return SR_ERR_ARG;
 460         }
 461
 462         /*
 463          * TODO: Send packet through PD pipe, and send the output of that to
 464          * the callbacks as well.
 465          */
 466         for (l = session->datafeed_callbacks; l; l = l->next) {
 467                 cb = l->data;
 468                 /* TODO: Check for cb != NULL. */
 469                 datafeed_dump(packet);
 470                 cb(device, packet);
 471         }
 472
 473         return SR_OK;
 474 }
 475
 476 /**
 477  * TODO.
 478  *
 479  * TODO: Switch to g_try_malloc0() / g_free().
 480  * TODO: More error checks etc.
 481  *
 482  * @param fd TODO.
 483  * @param events TODO.
 484  * @param timeout TODO.
 485  * @param callback TODO.
 486  * @param user_data TODO.
 487  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 488  *         SR_ERR_MALLOC upon memory allocation errors.
 489  */
 490 SR_API int sr_session_source_add(int fd, int events, int timeout,
 491                 sr_receive_data_callback callback, void *user_data)
 492 {
 493         struct source *new_sources, *s;
 494
 495         if (!callback) {
 496                 sr_err("session: %s: callback was NULL", __func__);
 497                 return SR_ERR_ARG;
 498         }
 499
 500         /* Note: user_data can be NULL, that's not a bug. */
 501
 502         new_sources = calloc(1, sizeof(struct source) * (num_sources + 1));
 503         if (!new_sources) {
 504                 sr_err("session: %s: new_sources malloc failed", __func__);
 505                 return SR_ERR_MALLOC;
 506         }
 507
 508         if (sources) {
 509                 memcpy(new_sources, sources,
 510                        sizeof(struct source) * num_sources);
 511                 free(sources);
 512         }
 513
 514         s = &new_sources[num_sources++];
 515         s->fd = fd;
 516         s->events = events;
 517         s->timeout = timeout;
 518         s->cb = callback;
 519         s->user_data = user_data;
 520         sources = new_sources;
 521
 522         if (timeout != source_timeout && timeout > 0
 523             && (source_timeout == -1 || timeout < source_timeout))
 524                 source_timeout = timeout;
 525
 526         return SR_OK;
 527 }
 528
 529 /**
 530  * Remove the source belonging to the specified file descriptor.
 531  *
 532  * TODO: More error checks.
 533  * TODO: Switch to g_try_malloc0() / g_free().
 534  *
 535  * @param fd TODO.
 536  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 537  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 538  *         internal errors.
 539  */
 540 SR_API int sr_session_source_remove(int fd)
 541 {
 542         struct source *new_sources;
 543         int old, new;
 544
 545         if (!sources) {
 546                 sr_err("session: %s: sources was NULL", __func__);
 547                 return SR_ERR_BUG; /* TODO: Other? */
 548         }
 549
 550         /* TODO: Check if 'fd' valid. */
 551
 552         new_sources = calloc(1, sizeof(struct source) * num_sources);
 553         if (!new_sources) {
 554                 sr_err("session: %s: new_sources malloc failed", __func__);
 555                 return SR_ERR_MALLOC;
 556         }
 557
 558         for (old = 0, new = 0; old < num_sources; old++) {
 559                 if (sources[old].fd != fd)
 560                         memcpy(&new_sources[new++], &sources[old],
 561                                sizeof(struct source));
 562         }
 563
 564         if (old != new) {
 565                 free(sources);
 566                 sources = new_sources;
 567                 num_sources--;
 568         } else {
 569                 /* Target fd was not found. */
 570                 free(new_sources);
 571         }
 572
 573         return SR_OK;
 574 }