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         int unitsize;
  51         int num_probes;
  52         int cur_chunk;
  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, void *cb_data)
  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         struct zip_stat zs;
  69         GSList *l;
  70         int ret, got_data;
  71         char capturefile[16];
  72         void *buf;
  73
  74         (void)fd;
  75         (void)revents;
  76
  77         got_data = FALSE;
  78         for (l = dev_insts; l; l = l->next) {
  79                 sdi = l->data;
  80                 if (!(vdev = sdi->priv))
  81                         /* Already done with this instance. */
  82                         continue;
  83
  84                 if (!vdev->capfile) {
  85                         /* No capture file opened yet, or finished with the last
  86                          * chunked one. */
  87                         if (vdev->cur_chunk == 0) {
  88                                 /* capturefile is always the unchunked base name. */
  89                                 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
  90                                         /* No chunks, just a single capture file. */
  91                                         vdev->cur_chunk = 0;
  92                                         if (!(vdev->capfile = zip_fopen(vdev->archive,
  93                                                         vdev->capturefile, 0)))
  94                                                 return FALSE;
  95                                                 sr_dbg("Opened %s.", vdev->capturefile);
  96                                 } else {
  97                                         /* Try as first chunk filename. */
  98                                         snprintf(capturefile, 15, "%s-1", vdev->capturefile);
  99                                         if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
 100                                                 vdev->cur_chunk = 1;
 101                                                 if (!(vdev->capfile = zip_fopen(vdev->archive,
 102                                                                 capturefile, 0)))
 103                                                         return FALSE;
 104                                                 sr_dbg("Opened %s.", capturefile);
 105                                         } else {
 106                                                 sr_err("No capture file '%s' in " "session file '%s'.",
 107                                                                 vdev->capturefile, vdev->sessionfile);
 108                                                 return FALSE;
 109                                         }
 110                                 }
 111                         } else {
 112                                 /* Capture data is chunked, advance to the next chunk. */
 113                                 vdev->cur_chunk++;
 114                                 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
 115                                                 vdev->cur_chunk);
 116                                 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
 117                                         if (!(vdev->capfile = zip_fopen(vdev->archive,
 118                                                         capturefile, 0)))
 119                                                 return FALSE;
 120                                         sr_dbg("Opened %s.", capturefile);
 121                                 } else {
 122                                         /* We got all the chunks, finish up. */
 123                                         g_free(vdev->capturefile);
 124                                         g_free(vdev);
 125                                         sdi->priv = NULL;
 126                                         continue;
 127                                 }
 128                         }
 129                 }
 130
 131                 if (!(buf = g_try_malloc(CHUNKSIZE))) {
 132                         sr_err("%s: buf malloc failed", __func__);
 133                         return FALSE;
 134                 }
 135
 136                 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
 137                 if (ret > 0) {
 138                         got_data = TRUE;
 139                         packet.type = SR_DF_LOGIC;
 140                         packet.payload = &logic;
 141                         logic.length = ret;
 142                         logic.unitsize = vdev->unitsize;
 143                         logic.data = buf;
 144                         vdev->bytes_read += ret;
 145                         sr_session_send(cb_data, &packet);
 146                 } else {
 147                         /* done with this capture file */
 148                         zip_fclose(vdev->capfile);
 149                         vdev->capfile = NULL;
 150                         if (vdev->cur_chunk == 0) {
 151                                 /* It was the only file. */
 152                                 g_free(vdev->capturefile);
 153                                 g_free(vdev);
 154                                 sdi->priv = NULL;
 155                         } else {
 156                                 /* There might be more chunks, so don't fall through
 157                                  * to the SR_DF_END here. */
 158                                 g_free(buf);
 159                                 return TRUE;
 160                         }
 161                 }
 162                 g_free(buf);
 163         }
 164
 165         if (!got_data) {
 166                 packet.type = SR_DF_END;
 167                 sr_session_send(cb_data, &packet);
 168                 sr_session_source_remove(-1);
 169         }
 170
 171         return TRUE;
 172 }
 173
 174 /* driver callbacks */
 175
 176 static int init(struct sr_context *sr_ctx)
 177 {
 178         (void)sr_ctx;
 179
 180         return SR_OK;
 181 }
 182
 183 static int cleanup(void)
 184 {
 185         GSList *l;
 186
 187         for (l = dev_insts; l; l = l->next)
 188                 sr_dev_inst_free(l->data);
 189         g_slist_free(dev_insts);
 190         dev_insts = NULL;
 191
 192         return SR_OK;
 193 }
 194
 195 static int dev_open(struct sr_dev_inst *sdi)
 196 {
 197         if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
 198                 sr_err("Device context malloc failed.");
 199                 return SR_ERR_MALLOC;
 200         }
 201
 202         dev_insts = g_slist_append(dev_insts, sdi);
 203
 204         return SR_OK;
 205 }
 206
 207 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
 208                 const struct sr_probe_group *probe_group)
 209 {
 210         struct session_vdev *vdev;
 211
 212         (void)probe_group;
 213
 214         switch (id) {
 215         case SR_CONF_SAMPLERATE:
 216                 if (sdi) {
 217                         vdev = sdi->priv;
 218                         *data = g_variant_new_uint64(vdev->samplerate);
 219                 } else
 220                         return SR_ERR;
 221                 break;
 222         default:
 223                 return SR_ERR_NA;
 224         }
 225
 226         return SR_OK;
 227 }
 228
 229 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
 230                 const struct sr_probe_group *probe_group)
 231 {
 232         struct session_vdev *vdev;
 233
 234         (void)probe_group;
 235
 236         vdev = sdi->priv;
 237
 238         switch (id) {
 239         case SR_CONF_SAMPLERATE:
 240                 vdev->samplerate = g_variant_get_uint64(data);
 241                 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
 242                 break;
 243         case SR_CONF_SESSIONFILE:
 244                 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
 245                 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
 246                 break;
 247         case SR_CONF_CAPTUREFILE:
 248                 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
 249                 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
 250                 break;
 251         case SR_CONF_CAPTURE_UNITSIZE:
 252                 vdev->unitsize = g_variant_get_uint64(data);
 253                 break;
 254         case SR_CONF_CAPTURE_NUM_PROBES:
 255                 vdev->num_probes = g_variant_get_uint64(data);
 256                 break;
 257         default:
 258                 return SR_ERR_NA;
 259         }
 260
 261         return SR_OK;
 262 }
 263
 264 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 265                 const struct sr_probe_group *probe_group)
 266 {
 267         (void)sdi;
 268         (void)probe_group;
 269
 270         switch (key) {
 271         case SR_CONF_DEVICE_OPTIONS:
 272                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 273                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 274                 break;
 275         default:
 276                 return SR_ERR_NA;
 277         }
 278
 279         return SR_OK;
 280 }
 281
 282 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 283 {
 284         struct session_vdev *vdev;
 285         int ret;
 286
 287         vdev = sdi->priv;
 288
 289         sr_info("Opening archive %s file %s", vdev->sessionfile,
 290                 vdev->capturefile);
 291
 292         if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
 293                 sr_err("Failed to open session file '%s': "
 294                        "zip error %d\n", vdev->sessionfile, ret);
 295                 return SR_ERR;
 296         }
 297
 298         /* Send header packet to the session bus. */
 299         std_session_send_df_header(cb_data, LOG_PREFIX);
 300
 301         /* freewheeling source */
 302         sr_session_source_add(-1, 0, 0, receive_data, cb_data);
 303
 304         return SR_OK;
 305 }
 306
 307 /** @private */
 308 SR_PRIV struct sr_dev_driver session_driver = {
 309         .name = "virtual-session",
 310         .longname = "Session-emulating driver",
 311         .api_version = 1,
 312         .init = init,
 313         .cleanup = cleanup,
 314         .scan = NULL,
 315         .dev_list = NULL,
 316         .dev_clear = NULL,
 317         .config_get = config_get,
 318         .config_set = config_set,
 319         .config_list = config_list,
 320         .dev_open = dev_open,
 321         .dev_close = NULL,
 322         .dev_acquisition_start = dev_acquisition_start,
 323         .dev_acquisition_stop = NULL,
 324         .priv = NULL,
 325 };