src/session_driver.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 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 <config.h>
  21 #include <sys/types.h>
  22 #include <sys/stat.h>
  23 #include <fcntl.h>
  24 #include <unistd.h>
  25 #include <sys/time.h>
  26 #include <zip.h>
  27 #include <libsigrok/libsigrok.h>
  28 #include "libsigrok-internal.h"
  29
  30 #define LOG_PREFIX "virtual-session"
  31
  32 /* size of payloads sent across the session bus */
  33 /** @cond PRIVATE */
  34 #define CHUNKSIZE (512 * 1024)
  35 /** @endcond */
  36
  37 SR_PRIV struct sr_dev_driver session_driver_info;
  38
  39 struct session_vdev {
  40         char *sessionfile;
  41         char *capturefile;
  42         struct zip *archive;
  43         struct zip_file *capfile;
  44         int bytes_read;
  45         uint64_t samplerate;
  46         int unitsize;
  47         int num_channels;
  48         int num_analog_channels;
  49         int cur_analog_channel;
  50         GArray *analog_channels;
  51         int cur_chunk;
  52         gboolean finished;
  53 };
  54
  55 static const uint32_t devopts[] = {
  56         SR_CONF_CAPTUREFILE | SR_CONF_SET,
  57         SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
  58         SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_SET,
  59         SR_CONF_NUM_ANALOG_CHANNELS | SR_CONF_SET,
  60         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
  61         SR_CONF_SESSIONFILE | SR_CONF_SET,
  62 };
  63
  64 static gboolean stream_session_data(struct sr_dev_inst *sdi)
  65 {
  66         struct session_vdev *vdev;
  67         struct sr_datafeed_packet packet;
  68         struct sr_datafeed_logic logic;
  69         struct sr_datafeed_analog_old analog;
  70         struct zip_stat zs;
  71         int ret, got_data;
  72         char capturefile[16];
  73         void *buf;
  74
  75         got_data = FALSE;
  76         vdev = sdi->priv;
  77
  78         if (!vdev->capfile) {
  79                 /* No capture file opened yet, or finished with the last
  80                  * chunked one. */
  81                 if (vdev->capturefile && (vdev->cur_chunk == 0)) {
  82                         /* capturefile is always the unchunked base name. */
  83                         if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
  84                                 /* No chunks, just a single capture file. */
  85                                 vdev->cur_chunk = 0;
  86                                 if (!(vdev->capfile = zip_fopen(vdev->archive,
  87                                                 vdev->capturefile, 0)))
  88                                         return FALSE;
  89                                 sr_dbg("Opened %s.", vdev->capturefile);
  90                         } else {
  91                                 /* Try as first chunk filename. */
  92                                 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
  93                                 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
  94                                         vdev->cur_chunk = 1;
  95                                         if (!(vdev->capfile = zip_fopen(vdev->archive,
  96                                                         capturefile, 0)))
  97                                                 return FALSE;
  98                                         sr_dbg("Opened %s.", capturefile);
  99                                 } else {
 100                                         sr_err("No capture file '%s' in " "session file '%s'.",
 101                                                         vdev->capturefile, vdev->sessionfile);
 102                                         return FALSE;
 103                                 }
 104                         }
 105                 } else {
 106                         /* Capture data is chunked, advance to the next chunk. */
 107                         vdev->cur_chunk++;
 108                         snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
 109                                         vdev->cur_chunk);
 110                         if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
 111                                 if (!(vdev->capfile = zip_fopen(vdev->archive,
 112                                                 capturefile, 0)))
 113                                         return FALSE;
 114                                 sr_dbg("Opened %s.", capturefile);
 115                         } else if (vdev->cur_analog_channel < vdev->num_analog_channels) {
 116                                 vdev->capturefile = g_strdup_printf("analog-1-%d",
 117                                                 vdev->num_channels + vdev->cur_analog_channel + 1);
 118                                 vdev->cur_analog_channel++;
 119                                 vdev->cur_chunk = 0;
 120                                 return TRUE;
 121                         } else {
 122                                 /* We got all the chunks, finish up. */
 123                                 return FALSE;
 124                         }
 125                 }
 126         }
 127
 128         buf = g_malloc(CHUNKSIZE);
 129
 130         ret = zip_fread(vdev->capfile, buf,
 131                         CHUNKSIZE / vdev->unitsize * vdev->unitsize);
 132         if (ret > 0) {
 133                 got_data = TRUE;
 134                 if (vdev->cur_analog_channel != 0) {
 135                         packet.type = SR_DF_ANALOG_OLD;
 136                         packet.payload = &analog;
 137                         analog.channels = g_slist_prepend(NULL,
 138                                         g_array_index(vdev->analog_channels,
 139                                                 struct sr_channel *, vdev->cur_analog_channel - 1));
 140                         analog.num_samples = ret / sizeof(float);
 141                         analog.mq = SR_MQ_VOLTAGE;
 142                         analog.unit = SR_UNIT_VOLT;
 143                         analog.mqflags = SR_MQFLAG_DC;
 144                         analog.data = (float *) buf;
 145                 } else {
 146                         if (ret % vdev->unitsize != 0)
 147                                 sr_warn("Read size %d not a multiple of the"
 148                                         " unit size %d.", ret, vdev->unitsize);
 149                         packet.type = SR_DF_LOGIC;
 150                         packet.payload = &logic;
 151                         logic.length = ret;
 152                         logic.unitsize = vdev->unitsize;
 153                         logic.data = buf;
 154                 }
 155                 vdev->bytes_read += ret;
 156                 sr_session_send(sdi, &packet);
 157         } else {
 158                 /* done with this capture file */
 159                 zip_fclose(vdev->capfile);
 160                 vdev->capfile = NULL;
 161                 if (vdev->cur_chunk != 0) {
 162                         /* There might be more chunks, so don't fall through
 163                          * to the SR_DF_END here. */
 164                         got_data = TRUE;
 165                 }
 166         }
 167         g_free(buf);
 168
 169         return got_data;
 170 }
 171
 172 static int receive_data(int fd, int revents, void *cb_data)
 173 {
 174         struct sr_dev_inst *sdi;
 175         struct session_vdev *vdev;
 176         struct sr_datafeed_packet packet;
 177
 178         (void)fd;
 179         (void)revents;
 180
 181         sdi = cb_data;
 182         vdev = sdi->priv;
 183
 184         if (!vdev->finished && !stream_session_data(sdi))
 185                 vdev->finished = TRUE;
 186         if (!vdev->finished)
 187                 return G_SOURCE_CONTINUE;
 188
 189         if (vdev->capfile) {
 190                 zip_fclose(vdev->capfile);
 191                 vdev->capfile = NULL;
 192         }
 193         if (vdev->archive) {
 194                 zip_discard(vdev->archive);
 195                 vdev->archive = NULL;
 196         }
 197         packet.type = SR_DF_END;
 198         packet.payload = NULL;
 199         sr_session_send(sdi, &packet);
 200
 201         return G_SOURCE_REMOVE;
 202 }
 203
 204 /* driver callbacks */
 205
 206 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 207 {
 208         return std_init(sr_ctx, di, LOG_PREFIX);
 209 }
 210
 211 static int dev_clear(const struct sr_dev_driver *di)
 212 {
 213         struct drv_context *drvc;
 214         GSList *l;
 215
 216         drvc = di->context;
 217         for (l = drvc->instances; l; l = l->next)
 218                 sr_dev_inst_free(l->data);
 219         g_slist_free(drvc->instances);
 220         drvc->instances = NULL;
 221
 222         return SR_OK;
 223 }
 224
 225 static int dev_open(struct sr_dev_inst *sdi)
 226 {
 227         struct sr_dev_driver *di;
 228         struct drv_context *drvc;
 229         struct session_vdev *vdev;
 230
 231         di = sdi->driver;
 232         drvc = di->context;
 233         vdev = g_malloc0(sizeof(struct session_vdev));
 234         sdi->priv = vdev;
 235         drvc->instances = g_slist_append(drvc->instances, sdi);
 236
 237         return SR_OK;
 238 }
 239
 240 static int dev_close(struct sr_dev_inst *sdi)
 241 {
 242         const struct session_vdev *const vdev = sdi->priv;
 243         g_free(vdev->sessionfile);
 244         g_free(vdev->capturefile);
 245
 246         g_free(sdi->priv);
 247         sdi->priv = NULL;
 248
 249         return SR_OK;
 250 }
 251
 252 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 253                 const struct sr_channel_group *cg)
 254 {
 255         struct session_vdev *vdev;
 256
 257         (void)cg;
 258
 259         if (!sdi)
 260                 return SR_ERR;
 261
 262         vdev = sdi->priv;
 263
 264         switch (key) {
 265         case SR_CONF_SAMPLERATE:
 266                 *data = g_variant_new_uint64(vdev->samplerate);
 267                 break;
 268         case SR_CONF_CAPTURE_UNITSIZE:
 269                 *data = g_variant_new_uint64(vdev->unitsize);
 270                 break;
 271         default:
 272                 return SR_ERR_NA;
 273         }
 274
 275         return SR_OK;
 276 }
 277
 278 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 279                 const struct sr_channel_group *cg)
 280 {
 281         struct session_vdev *vdev;
 282
 283         (void)cg;
 284
 285         vdev = sdi->priv;
 286
 287         switch (key) {
 288         case SR_CONF_SAMPLERATE:
 289                 vdev->samplerate = g_variant_get_uint64(data);
 290                 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
 291                 break;
 292         case SR_CONF_SESSIONFILE:
 293                 g_free(vdev->sessionfile);
 294                 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
 295                 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
 296                 break;
 297         case SR_CONF_CAPTUREFILE:
 298                 g_free(vdev->capturefile);
 299                 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
 300                 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
 301                 break;
 302         case SR_CONF_CAPTURE_UNITSIZE:
 303                 vdev->unitsize = g_variant_get_uint64(data);
 304                 break;
 305         case SR_CONF_NUM_LOGIC_CHANNELS:
 306                 vdev->num_channels = g_variant_get_int32(data);
 307                 break;
 308         case SR_CONF_NUM_ANALOG_CHANNELS:
 309                 vdev->num_analog_channels = g_variant_get_int32(data);
 310                 break;
 311         default:
 312                 return SR_ERR_NA;
 313         }
 314
 315         return SR_OK;
 316 }
 317
 318 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 319                 const struct sr_channel_group *cg)
 320 {
 321         (void)sdi;
 322         (void)cg;
 323
 324         switch (key) {
 325         case SR_CONF_DEVICE_OPTIONS:
 326                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 327                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 328                 break;
 329         default:
 330                 return SR_ERR_NA;
 331         }
 332
 333         return SR_OK;
 334 }
 335
 336 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 337 {
 338         struct session_vdev *vdev;
 339         int ret;
 340         GSList *l;
 341         struct sr_channel *ch;
 342
 343         (void)cb_data;
 344
 345         vdev = sdi->priv;
 346         vdev->bytes_read = 0;
 347         vdev->cur_analog_channel = 0;
 348         vdev->analog_channels = g_array_sized_new(FALSE, FALSE,
 349                         sizeof(struct sr_channel *), vdev->num_analog_channels);
 350         for (l = sdi->channels; l; l = l->next) {
 351                 ch = l->data;
 352                 if (ch->type == SR_CHANNEL_ANALOG)
 353                         g_array_append_val(vdev->analog_channels, ch);
 354         }
 355         vdev->cur_chunk = 0;
 356         vdev->finished = FALSE;
 357
 358         sr_info("Opening archive %s file %s", vdev->sessionfile,
 359                 vdev->capturefile);
 360
 361         if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
 362                 sr_err("Failed to open session file '%s': "
 363                        "zip error %d.", vdev->sessionfile, ret);
 364                 return SR_ERR;
 365         }
 366
 367         /* Send header packet to the session bus. */
 368         std_session_send_df_header(sdi, LOG_PREFIX);
 369
 370         /* freewheeling source */
 371         sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
 372
 373         return SR_OK;
 374 }
 375
 376 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 377 {
 378         struct session_vdev *vdev;
 379
 380         (void)cb_data;
 381         vdev = sdi->priv;
 382
 383         vdev->finished = TRUE;
 384
 385         return SR_OK;
 386 }
 387
 388 /** @private */
 389 SR_PRIV struct sr_dev_driver session_driver = {
 390         .name = "virtual-session",
 391         .longname = "Session-emulating driver",
 392         .api_version = 1,
 393         .init = init,
 394         .cleanup = dev_clear,
 395         .scan = NULL,
 396         .dev_list = NULL,
 397         .dev_clear = dev_clear,
 398         .config_get = config_get,
 399         .config_set = config_set,
 400         .config_list = config_list,
 401         .dev_open = dev_open,
 402         .dev_close = dev_close,
 403         .dev_acquisition_start = dev_acquisition_start,
 404         .dev_acquisition_stop = dev_acquisition_stop,
 405         .context = NULL,
 406 };