src/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 <config.h>
  21 #include <sys/types.h>
  22 #include <sys/stat.h>
  23 #include <fcntl.h>
  24 #include <unistd.h>
  25 #include <sys/time.h>
  26 #include <zip.h>
  27 #include <libsigrok/libsigrok.h>
  28 #include "libsigrok-internal.h"
  29
  30 #define LOG_PREFIX "virtual-session"
  31
  32 /* size of payloads sent across the session bus */
  33 /** @cond PRIVATE */
  34 #define CHUNKSIZE (512 * 1024)
  35 /** @endcond */
  36
  37 SR_PRIV struct sr_dev_driver session_driver_info;
  38
  39 struct session_vdev {
  40         char *sessionfile;
  41         char *capturefile;
  42         struct zip *archive;
  43         struct zip_file *capfile;
  44         int bytes_read;
  45         uint64_t samplerate;
  46         int unitsize;
  47         int num_channels;
  48         int cur_chunk;
  49         gboolean finished;
  50 };
  51
  52 static const uint32_t devopts[] = {
  53         SR_CONF_CAPTUREFILE | SR_CONF_SET,
  54         SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
  55         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
  56 };
  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         int ret, got_data;
  66         char capturefile[16];
  67         void *buf;
  68
  69         (void)fd;
  70         (void)revents;
  71
  72         sdi = cb_data;
  73         got_data = FALSE;
  74         vdev = sdi->priv;
  75         if (!vdev->finished) {
  76                 if (!vdev->capfile) {
  77                         /* No capture file opened yet, or finished with the last
  78                          * chunked one. */
  79                         if (vdev->cur_chunk == 0) {
  80                                 /* capturefile is always the unchunked base name. */
  81                                 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
  82                                         /* No chunks, just a single capture file. */
  83                                         vdev->cur_chunk = 0;
  84                                         if (!(vdev->capfile = zip_fopen(vdev->archive,
  85                                                         vdev->capturefile, 0)))
  86                                                 return FALSE;
  87                                                 sr_dbg("Opened %s.", vdev->capturefile);
  88                                 } else {
  89                                         /* Try as first chunk filename. */
  90                                         snprintf(capturefile, 15, "%s-1", vdev->capturefile);
  91                                         if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
  92                                                 vdev->cur_chunk = 1;
  93                                                 if (!(vdev->capfile = zip_fopen(vdev->archive,
  94                                                                 capturefile, 0)))
  95                                                         return FALSE;
  96                                                 sr_dbg("Opened %s.", capturefile);
  97                                         } else {
  98                                                 sr_err("No capture file '%s' in " "session file '%s'.",
  99                                                                 vdev->capturefile, vdev->sessionfile);
 100                                                 return FALSE;
 101                                         }
 102                                 }
 103                         } else {
 104                                 /* Capture data is chunked, advance to the next chunk. */
 105                                 vdev->cur_chunk++;
 106                                 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
 107                                                 vdev->cur_chunk);
 108                                 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
 109                                         if (!(vdev->capfile = zip_fopen(vdev->archive,
 110                                                         capturefile, 0)))
 111                                                 return FALSE;
 112                                         sr_dbg("Opened %s.", capturefile);
 113                                 } else {
 114                                         /* We got all the chunks, finish up. */
 115                                         vdev->finished = TRUE;
 116                                         return TRUE;
 117                                 }
 118                         }
 119                 }
 120
 121                 buf = g_malloc(CHUNKSIZE);
 122
 123                 ret = zip_fread(vdev->capfile, buf,
 124                                 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
 125                 if (ret > 0) {
 126                         if (ret % vdev->unitsize != 0)
 127                                 sr_warn("Read size %d not a multiple of the"
 128                                         " unit size %d.", ret, vdev->unitsize);
 129                         got_data = TRUE;
 130                         packet.type = SR_DF_LOGIC;
 131                         packet.payload = &logic;
 132                         logic.length = ret;
 133                         logic.unitsize = vdev->unitsize;
 134                         logic.data = buf;
 135                         vdev->bytes_read += ret;
 136                         sr_session_send(sdi, &packet);
 137                 } else {
 138                         /* done with this capture file */
 139                         zip_fclose(vdev->capfile);
 140                         vdev->capfile = NULL;
 141                         if (vdev->cur_chunk == 0) {
 142                                 /* It was the only file. */
 143                                 vdev->finished = TRUE;
 144                         } else {
 145                                 /* There might be more chunks, so don't fall through
 146                                  * to the SR_DF_END here. */
 147                                 g_free(buf);
 148                                 return TRUE;
 149                         }
 150                 }
 151                 g_free(buf);
 152         }
 153
 154         if (!got_data) {
 155                 packet.type = SR_DF_END;
 156                 sr_session_send(sdi, &packet);
 157                 sr_session_source_remove(sdi->session, -1);
 158         }
 159
 160         return TRUE;
 161 }
 162
 163 /* driver callbacks */
 164
 165 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 166 {
 167         return std_init(sr_ctx, di, LOG_PREFIX);
 168 }
 169
 170 static int dev_clear(const struct sr_dev_driver *di)
 171 {
 172         struct drv_context *drvc;
 173         GSList *l;
 174
 175         drvc = di->context;
 176         for (l = drvc->instances; l; l = l->next)
 177                 sr_dev_inst_free(l->data);
 178         g_slist_free(drvc->instances);
 179         drvc->instances = NULL;
 180
 181         return SR_OK;
 182 }
 183
 184 static int dev_open(struct sr_dev_inst *sdi)
 185 {
 186         struct sr_dev_driver *di;
 187         struct drv_context *drvc;
 188         struct session_vdev *vdev;
 189
 190         di = sdi->driver;
 191         drvc = di->context;
 192         vdev = g_malloc0(sizeof(struct session_vdev));
 193         sdi->priv = vdev;
 194         drvc->instances = g_slist_append(drvc->instances, sdi);
 195
 196         return SR_OK;
 197 }
 198
 199 static int dev_close(struct sr_dev_inst *sdi)
 200 {
 201         const struct session_vdev *const vdev = sdi->priv;
 202         g_free(vdev->sessionfile);
 203         g_free(vdev->capturefile);
 204
 205         g_free(sdi->priv);
 206         sdi->priv = NULL;
 207
 208         return SR_OK;
 209 }
 210
 211 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 212                 const struct sr_channel_group *cg)
 213 {
 214         struct session_vdev *vdev;
 215
 216         (void)cg;
 217
 218         if (!sdi)
 219                 return SR_ERR;
 220
 221         vdev = sdi->priv;
 222
 223         switch (key) {
 224         case SR_CONF_SAMPLERATE:
 225                 *data = g_variant_new_uint64(vdev->samplerate);
 226                 break;
 227         case SR_CONF_CAPTURE_UNITSIZE:
 228                 *data = g_variant_new_uint64(vdev->unitsize);
 229                 break;
 230         default:
 231                 return SR_ERR_NA;
 232         }
 233
 234         return SR_OK;
 235 }
 236
 237 static int config_set(uint32_t key, 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 (key) {
 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(uint32_t 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_UINT32,
 283                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_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         (void)cb_data;
 298
 299         vdev = sdi->priv;
 300         vdev->bytes_read = 0;
 301         vdev->cur_chunk = 0;
 302         vdev->finished = FALSE;
 303
 304         sr_info("Opening archive %s file %s", vdev->sessionfile,
 305                 vdev->capturefile);
 306
 307         if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
 308                 sr_err("Failed to open session file '%s': "
 309                        "zip error %d.", vdev->sessionfile, ret);
 310                 return SR_ERR;
 311         }
 312
 313         /* Send header packet to the session bus. */
 314         std_session_send_df_header(sdi, LOG_PREFIX);
 315
 316         /* freewheeling source */
 317         sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
 318
 319         return SR_OK;
 320 }
 321
 322 /** @private */
 323 SR_PRIV struct sr_dev_driver session_driver = {
 324         .name = "virtual-session",
 325         .longname = "Session-emulating driver",
 326         .api_version = 1,
 327         .init = init,
 328         .cleanup = dev_clear,
 329         .scan = NULL,
 330         .dev_list = NULL,
 331         .dev_clear = dev_clear,
 332         .config_get = config_get,
 333         .config_set = config_set,
 334         .config_list = config_list,
 335         .dev_open = dev_open,
 336         .dev_close = dev_close,
 337         .dev_acquisition_start = dev_acquisition_start,
 338         .dev_acquisition_stop = NULL,
 339         .context = NULL,
 340 };