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