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