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