session_driver.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-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 <sys/types.h>
  21 #include <sys/stat.h>
  22 #include <fcntl.h>
  23 #include <unistd.h>
  24 #include <sys/time.h>
  25 #include <zip.h>
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28
  29 /* Message logging helpers with driver-specific prefix string. */
  30 #define DRIVER_LOG_DOMAIN "virtual-session: "
  31 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  32 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  33 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  34 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  35 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  36 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  37
  38 /* size of payloads sent across the session bus */
  39 /** @cond PRIVATE */
  40 #define CHUNKSIZE (512 * 1024)
  41 /** @endcond */
  42
  43 struct session_vdev {
  44         char *sessionfile;
  45         char *capturefile;
  46         struct zip *archive;
  47         struct zip_file *capfile;
  48         int bytes_read;
  49         uint64_t samplerate;
  50         int unitsize;
  51         int num_probes;
  52 };
  53
  54 static GSList *dev_insts = NULL;
  55 static const int hwcaps[] = {
  56         SR_HWCAP_CAPTUREFILE,
  57         SR_HWCAP_CAPTURE_UNITSIZE,
  58         0,
  59 };
  60
  61 static int receive_data(int fd, int revents, void *cb_data)
  62 {
  63         struct sr_dev_inst *sdi;
  64         struct session_vdev *vdev;
  65         struct sr_datafeed_packet packet;
  66         struct sr_datafeed_logic logic;
  67         GSList *l;
  68         void *buf;
  69         int ret, got_data;
  70
  71         (void)fd;
  72         (void)revents;
  73
  74         sr_dbg("Feed chunk.");
  75
  76         got_data = FALSE;
  77         for (l = dev_insts; l; l = l->next) {
  78                 sdi = l->data;
  79                 vdev = sdi->priv;
  80                 if (!vdev)
  81                         /* already done with this instance */
  82                         continue;
  83
  84                 if (!(buf = g_try_malloc(CHUNKSIZE))) {
  85                         sr_err("%s: buf malloc failed", __func__);
  86                         return FALSE;
  87                 }
  88
  89                 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
  90                 if (ret > 0) {
  91                         got_data = TRUE;
  92                         packet.type = SR_DF_LOGIC;
  93                         packet.payload = &logic;
  94                         logic.length = ret;
  95                         logic.unitsize = vdev->unitsize;
  96                         logic.data = buf;
  97                         vdev->bytes_read += ret;
  98                         sr_session_send(cb_data, &packet);
  99                 } else {
 100                         /* done with this capture file */
 101                         zip_fclose(vdev->capfile);
 102                         g_free(vdev->capturefile);
 103                         g_free(vdev);
 104                         sdi->priv = NULL;
 105                 }
 106         }
 107
 108         if (!got_data) {
 109                 packet.type = SR_DF_END;
 110                 sr_session_send(cb_data, &packet);
 111                 sr_session_source_remove(-1);
 112         }
 113
 114         return TRUE;
 115 }
 116
 117 /* driver callbacks */
 118 static int hw_cleanup(void);
 119
 120 static int hw_init(void)
 121 {
 122         return SR_OK;
 123 }
 124
 125 static int hw_cleanup(void)
 126 {
 127         GSList *l;
 128
 129         for (l = dev_insts; l; l = l->next)
 130                 sr_dev_inst_free(l->data);
 131         g_slist_free(dev_insts);
 132         dev_insts = NULL;
 133
 134         return SR_OK;
 135 }
 136
 137 static int hw_dev_open(struct sr_dev_inst *sdi)
 138 {
 139         if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
 140                 sr_err("%s: sdi->priv malloc failed", __func__);
 141                 return SR_ERR_MALLOC;
 142         }
 143
 144         dev_insts = g_slist_append(dev_insts, sdi);
 145
 146         return SR_OK;
 147 }
 148
 149 static int hw_info_get(int info_id, const void **data,
 150        const struct sr_dev_inst *sdi)
 151 {
 152         struct session_vdev *vdev;
 153
 154         switch (info_id) {
 155         case SR_DI_HWCAPS:
 156                 *data = hwcaps;
 157                 break;
 158         case SR_DI_CUR_SAMPLERATE:
 159                 if (sdi) {
 160                         vdev = sdi->priv;
 161                         *data = &vdev->samplerate;
 162                 } else
 163                         return SR_ERR;
 164                 break;
 165         default:
 166                 return SR_ERR_ARG;
 167         }
 168
 169         return SR_OK;
 170 }
 171
 172 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 173                 const void *value)
 174 {
 175         struct session_vdev *vdev;
 176         const uint64_t *tmp_u64;
 177
 178         vdev = sdi->priv;
 179
 180         switch (hwcap) {
 181         case SR_HWCAP_SAMPLERATE:
 182                 tmp_u64 = value;
 183                 vdev->samplerate = *tmp_u64;
 184                 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
 185                 break;
 186         case SR_HWCAP_SESSIONFILE:
 187                 vdev->sessionfile = g_strdup(value);
 188                 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
 189                 break;
 190         case SR_HWCAP_CAPTUREFILE:
 191                 vdev->capturefile = g_strdup(value);
 192                 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
 193                 break;
 194         case SR_HWCAP_CAPTURE_UNITSIZE:
 195                 tmp_u64 = value;
 196                 vdev->unitsize = *tmp_u64;
 197                 break;
 198         case SR_HWCAP_CAPTURE_NUM_PROBES:
 199                 tmp_u64 = value;
 200                 vdev->num_probes = *tmp_u64;
 201                 break;
 202         default:
 203                 sr_err("Unknown capability: %d.", hwcap);
 204                 return SR_ERR;
 205         }
 206
 207         return SR_OK;
 208 }
 209
 210 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 211                 void *cb_data)
 212 {
 213         struct zip_stat zs;
 214         struct session_vdev *vdev;
 215         struct sr_datafeed_header *header;
 216         struct sr_datafeed_packet *packet;
 217         struct sr_datafeed_meta_logic meta;
 218         int ret;
 219
 220         vdev = sdi->priv;
 221
 222         sr_info("Opening archive %s file %s", vdev->sessionfile,
 223                 vdev->capturefile);
 224
 225         if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
 226                 sr_err("Failed to open session file '%s': "
 227                        "zip error %d\n", vdev->sessionfile, ret);
 228                 return SR_ERR;
 229         }
 230
 231         if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
 232                 sr_err("Failed to check capture file '%s' in "
 233                        "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 234                 return SR_ERR;
 235         }
 236
 237         if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
 238                 sr_err("Failed to open capture file '%s' in "
 239                        "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 240                 return SR_ERR;
 241         }
 242
 243         /* freewheeling source */
 244         sr_session_source_add(-1, 0, 0, receive_data, cb_data);
 245
 246         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
 247                 sr_err("%s: packet malloc failed", __func__);
 248                 return SR_ERR_MALLOC;
 249         }
 250
 251         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
 252                 sr_err("%s: header malloc failed", __func__);
 253                 return SR_ERR_MALLOC;
 254         }
 255
 256         /* Send header packet to the session bus. */
 257         packet->type = SR_DF_HEADER;
 258         packet->payload = (unsigned char *)header;
 259         header->feed_version = 1;
 260         gettimeofday(&header->starttime, NULL);
 261         sr_session_send(cb_data, packet);
 262
 263         /* Send metadata about the SR_DF_LOGIC packets to come. */
 264         packet->type = SR_DF_META_LOGIC;
 265         packet->payload = &meta;
 266         meta.samplerate = vdev->samplerate;
 267         meta.num_probes = vdev->num_probes;
 268         sr_session_send(cb_data, packet);
 269
 270         g_free(header);
 271         g_free(packet);
 272
 273         return SR_OK;
 274 }
 275
 276 /** @private */
 277 SR_PRIV struct sr_dev_driver session_driver = {
 278         .name = "virtual-session",
 279         .longname = "Session-emulating driver",
 280         .api_version = 1,
 281         .init = hw_init,
 282         .cleanup = hw_cleanup,
 283         .dev_open = hw_dev_open,
 284         .dev_close = NULL,
 285         .info_get = hw_info_get,
 286         .dev_config_set = hw_dev_config_set,
 287         .dev_acquisition_start = hw_dev_acquisition_start,
 288         .dev_acquisition_stop = NULL,
 289 };