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