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