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