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 <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 subsystem-specific prefix string. */
  30 #define LOG_PREFIX "virtual-session: "
  31 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  32 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  33 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  34 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  35 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  36 #define sr_err(s, args...) sr_err(LOG_PREFIX 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     uint64_t total_samples;
  51         int unitsize;
  52         int num_probes;
  53 };
  54
  55 static GSList *dev_insts = NULL;
  56 static const int hwcaps[] = {
  57         SR_CONF_CAPTUREFILE,
  58         SR_CONF_CAPTURE_UNITSIZE,
  59         0,
  60 };
  61
  62 static int receive_data(int fd, int revents, const struct sr_dev_inst *cb_sdi)
  63 {
  64         struct sr_dev_inst *sdi;
  65         struct session_vdev *vdev;
  66         struct sr_datafeed_packet packet;
  67         struct sr_datafeed_logic logic;
  68         GSList *l;
  69         void *buf;
  70         int ret, got_data;
  71
  72         (void)fd;
  73         (void)revents;
  74
  75         sr_dbg("Feed chunk.");
  76
  77         got_data = FALSE;
  78         for (l = dev_insts; l; l = l->next) {
  79                 sdi = l->data;
  80                 vdev = sdi->priv;
  81                 if (!vdev)
  82                         /* already done with this instance */
  83                         continue;
  84
  85                 if (!(buf = g_try_malloc(CHUNKSIZE))) {
  86                         sr_err("%s: buf malloc failed", __func__);
  87                         return FALSE;
  88                 }
  89
  90                 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
  91                 if (ret > 0) {
  92                         got_data = TRUE;
  93                         packet.type = SR_DF_LOGIC;
  94                         packet.payload = &logic;
  95                         logic.length = ret;
  96                         logic.unitsize = vdev->unitsize;
  97                         logic.data = buf;
  98                         vdev->bytes_read += ret;
  99                         sr_session_send(cb_sdi, &packet);
 100                 } else {
 101                         /* done with this capture file */
 102                         zip_fclose(vdev->capfile);
 103                         g_free(vdev->capturefile);
 104                         g_free(vdev);
 105                         sdi->priv = NULL;
 106                 }
 107         }
 108
 109         if (!got_data) {
 110                 packet.type = SR_DF_END;
 111                 sr_session_send(cb_sdi, &packet);
 112                 sr_session_source_remove(-1);
 113         }
 114
 115         return TRUE;
 116 }
 117
 118 /* driver callbacks */
 119 static int hw_cleanup(void);
 120
 121 static int hw_init(struct sr_context *sr_ctx)
 122 {
 123         (void)sr_ctx;
 124
 125         return SR_OK;
 126 }
 127
 128 static int hw_cleanup(void)
 129 {
 130         GSList *l;
 131
 132         for (l = dev_insts; l; l = l->next)
 133                 sr_dev_inst_free(l->data);
 134         g_slist_free(dev_insts);
 135         dev_insts = NULL;
 136
 137         return SR_OK;
 138 }
 139
 140 static int hw_dev_open(struct sr_dev_inst *sdi)
 141 {
 142         if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
 143                 sr_err("%s: sdi->priv malloc failed", __func__);
 144                 return SR_ERR_MALLOC;
 145         }
 146
 147         dev_insts = g_slist_append(dev_insts, sdi);
 148
 149         return SR_OK;
 150 }
 151
 152 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
 153 {
 154         struct session_vdev *vdev;
 155
 156         switch (id) {
 157         case SR_CONF_SAMPLERATE:
 158                 if (sdi) {
 159                         vdev = sdi->priv;
 160                         *data = g_variant_new_uint64(vdev->samplerate);
 161                 } else
 162                         return SR_ERR;
 163                 break;
 164     case SR_CONF_LIMIT_SAMPLES:
 165         if (sdi) {
 166             vdev = sdi->priv;
 167             *data = g_variant_new_uint64(vdev->total_samples);
 168         } else
 169             return SR_ERR;
 170         break;
 171         default:
 172                 return SR_ERR_ARG;
 173         }
 174
 175         return SR_OK;
 176 }
 177
 178 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 179 {
 180         struct session_vdev *vdev;
 181
 182         vdev = sdi->priv;
 183
 184         switch (id) {
 185         case SR_CONF_SAMPLERATE:
 186                 vdev->samplerate = g_variant_get_uint64(data);
 187                 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
 188                 break;
 189         case SR_CONF_SESSIONFILE:
 190                 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
 191                 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
 192                 break;
 193         case SR_CONF_CAPTUREFILE:
 194                 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
 195                 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
 196                 break;
 197         case SR_CONF_CAPTURE_UNITSIZE:
 198                 vdev->unitsize = g_variant_get_uint64(data);
 199                 break;
 200     case SR_CONF_LIMIT_SAMPLES:
 201         vdev->total_samples = g_variant_get_uint64(data);
 202         break;
 203         case SR_CONF_CAPTURE_NUM_PROBES:
 204                 vdev->num_probes = g_variant_get_uint64(data);
 205                 break;
 206         default:
 207                 sr_err("Unknown capability: %d.", id);
 208                 return SR_ERR;
 209         }
 210
 211         return SR_OK;
 212 }
 213
 214 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 215 {
 216
 217         (void)sdi;
 218
 219         switch (key) {
 220         case SR_CONF_DEVICE_OPTIONS:
 221 //              *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 222 //                              hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 223                 *data = g_variant_new_from_data(G_VARIANT_TYPE("ai"),
 224                                 hwcaps, ARRAY_SIZE(hwcaps)*sizeof(int32_t), TRUE, NULL, NULL);
 225                 break;
 226         default:
 227                 return SR_ERR_ARG;
 228         }
 229
 230         return SR_OK;
 231 }
 232
 233 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 234                 void *cb_data)
 235 {
 236         struct zip_stat zs;
 237         struct session_vdev *vdev;
 238         int ret;
 239
 240         vdev = sdi->priv;
 241
 242         sr_info("Opening archive %s file %s", vdev->sessionfile,
 243                 vdev->capturefile);
 244
 245         if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
 246                 sr_err("Failed to open session file '%s': "
 247                        "zip error %d\n", vdev->sessionfile, ret);
 248                 return SR_ERR;
 249         }
 250
 251         if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
 252                 sr_err("Failed to check capture file '%s' in "
 253                        "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 254                 return SR_ERR;
 255         }
 256
 257         if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
 258                 sr_err("Failed to open capture file '%s' in "
 259                        "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 260                 return SR_ERR;
 261         }
 262
 263         /* Send header packet to the session bus. */
 264     std_session_send_df_header(sdi, LOG_PREFIX);
 265
 266         /* freewheeling source */
 267     sr_session_source_add(-1, 0, 0, receive_data, sdi);
 268
 269         return SR_OK;
 270 }
 271
 272 /** @private */
 273 SR_PRIV struct sr_dev_driver session_driver = {
 274         .name = "virtual-session",
 275         .longname = "Session-emulating driver",
 276         .api_version = 1,
 277         .init = hw_init,
 278         .cleanup = hw_cleanup,
 279         .config_get = config_get,
 280         .config_set = config_set,
 281         .config_list = config_list,
 282         .dev_open = hw_dev_open,
 283         .dev_close = NULL,
 284         .dev_acquisition_start = hw_dev_acquisition_start,
 285         .dev_acquisition_stop = NULL,
 286 };