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 = g_try_malloc0(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_err("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_err("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                 /* TODO: Add comment. */
 212                 g_free(fds);
 213
 214                 /* Construct g_poll()'s array. */
 215                 if (!(fds = g_try_malloc(sizeof(GPollFD) * num_sources))) {
 216                         sr_err("session: %s: fds malloc failed", __func__);
 217                         return SR_ERR_MALLOC;
 218                 }
 219                 for (i = 0; i < num_sources; i++) {
 220 #ifdef _WIN32
 221                         g_io_channel_win32_make_pollfd(&channels[0],
 222                                         sources[i].events, &my_gpollfd);
 223 #else
 224                         my_gpollfd.fd = sources[i].fd;
 225                         my_gpollfd.events = sources[i].events;
 226                         fds[i] = my_gpollfd;
 227 #endif
 228                 }
 229
 230                 ret = g_poll(fds, num_sources, source_timeout);
 231
 232                 for (i = 0; i < num_sources; i++) {
 233                         if (fds[i].revents > 0 || (ret == 0
 234                                 && source_timeout == sources[i].timeout)) {
 235                                 /*
 236                                  * Invoke the source's callback on an event,
 237                                  * or if the poll timeout out and this source
 238                                  * asked for that timeout.
 239                                  */
 240                                 if (!sources[i].cb(fds[i].fd, fds[i].revents,
 241                                                   sources[i].user_data))
 242                                         sr_session_source_remove(sources[i].fd);
 243                         }
 244                 }
 245         }
 246         g_free(fds);
 247
 248         return SR_OK;
 249 }
 250
 251 /**
 252  * Start a session.
 253  *
 254  * There can only be one session at a time. TODO
 255  *
 256  * @return SR_OK upon success, SR_ERR upon errors.
 257  */
 258 SR_API int sr_session_start(void)
 259 {
 260         struct sr_device *device;
 261         GSList *l;
 262         int ret;
 263
 264         if (!session) {
 265                 sr_err("session: %s: session was NULL; a session must be "
 266                        "created first, before starting it.", __func__);
 267                 return SR_ERR; /* TODO: SR_ERR_BUG? */
 268         }
 269
 270         if (!session->devices) {
 271                 /* TODO: Actually the case? */
 272                 sr_err("session: %s: session->devices was NULL; a session "
 273                        "cannot be started without devices.", __func__);
 274                 return SR_ERR; /* TODO: SR_ERR_BUG? */
 275         }
 276
 277         /* TODO: Check plugin_index validity? */
 278
 279         sr_info("session: starting");
 280
 281         for (l = session->devices; l; l = l->next) {
 282                 device = l->data;
 283                 /* TODO: Check for device != NULL. */
 284                 if ((ret = device->plugin->start_acquisition(
 285                                 device->plugin_index, device)) != SR_OK) {
 286                         sr_err("session: %s: could not start an acquisition "
 287                                "(%d)", __func__, ret);
 288                         break;
 289                 }
 290         }
 291
 292         /* TODO: What if there are multiple devices? Which return code? */
 293
 294         return ret;
 295 }
 296
 297 /**
 298  * Run the session.
 299  *
 300  * TODO: Various error checks etc.
 301  *
 302  * @return SR_OK upon success, SR_ERR_BUG upon errors.
 303  */
 304 SR_API int sr_session_run(void)
 305 {
 306         if (!session) {
 307                 sr_err("session: %s: session was NULL; a session must be "
 308                        "created first, before running it.", __func__);
 309                 return SR_ERR_BUG;
 310         }
 311
 312         if (!session->devices) {
 313                 /* TODO: Actually the case? */
 314                 sr_err("session: %s: session->devices was NULL; a session "
 315                        "cannot be run without devices.", __func__);
 316                 return SR_ERR_BUG;
 317         }
 318
 319         sr_info("session: running");
 320         session->running = TRUE;
 321
 322         /* Do we have real sources? */
 323         if (num_sources == 1 && sources[0].fd == -1) {
 324                 /* Dummy source, freewheel over it. */
 325                 while (session->running)
 326                         sources[0].cb(-1, 0, sources[0].user_data);
 327         } else {
 328                 /* Real sources, use g_poll() main loop. */
 329                 sr_session_run_poll();
 330         }
 331
 332         return SR_OK;
 333 }
 334
 335 /**
 336  * Halt the current session.
 337  *
 338  * TODO.
 339  *
 340  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 341  */
 342 SR_API int sr_session_halt(void)
 343 {
 344         if (!session) {
 345                 sr_err("session: %s: session was NULL", __func__);
 346                 return SR_ERR_BUG;
 347         }
 348
 349         sr_info("session: halting");
 350         session->running = FALSE;
 351
 352         return SR_OK;
 353 }
 354
 355 /**
 356  * Stop the current session.
 357  *
 358  * TODO: Difference to halt?
 359  *
 360  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
 361  */
 362 SR_API int sr_session_stop(void)
 363 {
 364         struct sr_device *device;
 365         GSList *l;
 366
 367         if (!session) {
 368                 sr_err("session: %s: session was NULL", __func__);
 369                 return SR_ERR_BUG;
 370         }
 371
 372         sr_info("session: stopping");
 373         session->running = FALSE;
 374
 375         for (l = session->devices; l; l = l->next) {
 376                 device = l->data;
 377                 /* Check for device != NULL. */
 378                 if (device->plugin) {
 379                         if (device->plugin->stop_acquisition)
 380                                 device->plugin->stop_acquisition(device->plugin_index, device);
 381                         if (device->plugin->cleanup)
 382                                 device->plugin->cleanup();
 383                 }
 384         }
 385
 386         return SR_OK;
 387 }
 388
 389 /**
 390  * @brief debug helper
 391  *
 392  * @param packet TODO.
 393  *
 394  */
 395 static void datafeed_dump(struct sr_datafeed_packet *packet)
 396 {
 397         struct sr_datafeed_logic *logic;
 398
 399         switch (packet->type) {
 400         case SR_DF_HEADER:
 401                 sr_dbg("bus: received SR_DF_HEADER");
 402                 break;
 403         case SR_DF_TRIGGER:
 404                 sr_dbg("bus: received SR_DF_TRIGGER");
 405                 break;
 406         case SR_DF_LOGIC:
 407                 logic = packet->payload;
 408                 /* TODO: Check for logic != NULL. */
 409                 sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length);
 410                 break;
 411         case SR_DF_END:
 412                 sr_dbg("bus: received SR_DF_END");
 413                 break;
 414         default:
 415                 sr_dbg("bus: received unknown packet type %d", packet->type);
 416                 break;
 417         }
 418
 419 }
 420
 421 /**
 422  * TODO.
 423  *
 424  * @param device TODO.
 425  * @param packet TODO.
 426  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
 427  */
 428 SR_API int sr_session_bus(struct sr_device *device,
 429                           struct sr_datafeed_packet *packet)
 430 {
 431         GSList *l;
 432         sr_datafeed_callback cb;
 433
 434         if (!device) {
 435                 sr_err("session: %s: device was NULL", __func__);
 436                 return SR_ERR_ARG;
 437         }
 438
 439         if (!device->plugin) {
 440                 sr_err("session: %s: device->plugin was NULL", __func__);
 441                 return SR_ERR_ARG;
 442         }
 443
 444         if (!packet) {
 445                 sr_err("session: %s: packet was NULL", __func__);
 446                 return SR_ERR_ARG;
 447         }
 448
 449         /*
 450          * TODO: Send packet through PD pipe, and send the output of that to
 451          * the callbacks as well.
 452          */
 453         for (l = session->datafeed_callbacks; l; l = l->next) {
 454                 if (sr_log_loglevel_get() >= SR_LOG_DBG)
 455                         datafeed_dump(packet);
 456                 cb = l->data;
 457                 /* TODO: Check for cb != NULL. */
 458                 cb(device, packet);
 459         }
 460
 461         return SR_OK;
 462 }
 463
 464 /**
 465  * TODO.
 466  *
 467  * TODO: More error checks etc.
 468  *
 469  * @param fd TODO.
 470  * @param events TODO.
 471  * @param timeout TODO.
 472  * @param callback TODO.
 473  * @param user_data TODO.
 474  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 475  *         SR_ERR_MALLOC upon memory allocation errors.
 476  */
 477 SR_API int sr_session_source_add(int fd, int events, int timeout,
 478                 sr_receive_data_callback callback, void *user_data)
 479 {
 480         struct source *new_sources, *s;
 481
 482         if (!callback) {
 483                 sr_err("session: %s: callback was NULL", __func__);
 484                 return SR_ERR_ARG;
 485         }
 486
 487         /* Note: user_data can be NULL, that's not a bug. */
 488
 489         new_sources = g_try_malloc0(sizeof(struct source) * (num_sources + 1));
 490         if (!new_sources) {
 491                 sr_err("session: %s: new_sources malloc failed", __func__);
 492                 return SR_ERR_MALLOC;
 493         }
 494
 495         if (sources) {
 496                 memcpy(new_sources, sources,
 497                        sizeof(struct source) * num_sources);
 498                 g_free(sources);
 499         }
 500
 501         s = &new_sources[num_sources++];
 502         s->fd = fd;
 503         s->events = events;
 504         s->timeout = timeout;
 505         s->cb = callback;
 506         s->user_data = user_data;
 507         sources = new_sources;
 508
 509         if (timeout != source_timeout && timeout > 0
 510             && (source_timeout == -1 || timeout < source_timeout))
 511                 source_timeout = timeout;
 512
 513         return SR_OK;
 514 }
 515
 516 /**
 517  * Remove the source belonging to the specified file descriptor.
 518  *
 519  * TODO: More error checks.
 520  *
 521  * @param fd TODO.
 522  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
 523  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
 524  *         internal errors.
 525  */
 526 SR_API int sr_session_source_remove(int fd)
 527 {
 528         struct source *new_sources;
 529         int old, new;
 530
 531         if (!sources) {
 532                 sr_err("session: %s: sources was NULL", __func__);
 533                 return SR_ERR_BUG; /* TODO: Other? */
 534         }
 535
 536         /* TODO: Check if 'fd' valid. */
 537
 538         new_sources = g_try_malloc0(sizeof(struct source) * num_sources);
 539         if (!new_sources) {
 540                 sr_err("session: %s: new_sources malloc failed", __func__);
 541                 return SR_ERR_MALLOC;
 542         }
 543
 544         for (old = 0, new = 0; old < num_sources; old++) {
 545                 if (sources[old].fd != fd)
 546                         memcpy(&new_sources[new++], &sources[old],
 547                                sizeof(struct source));
 548         }
 549
 550         if (old != new) {
 551                 g_free(sources);
 552                 sources = new_sources;
 553                 num_sources--;
 554         } else {
 555                 /* Target fd was not found. */
 556                 g_free(new_sources);
 557         }
 558
 559         return SR_OK;
 560 }