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 static struct sr_dev_driver *di = &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 hwcaps[] = {
  53         SR_CONF_CAPTUREFILE,
  54         SR_CONF_CAPTURE_UNITSIZE,
  55         SR_CONF_SAMPLERATE,
  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                 if (!(buf = g_try_malloc(CHUNKSIZE))) {
 122                         sr_err("%s: buf malloc failed", __func__);
 123                         return FALSE;
 124                 }
 125
 126                 ret = zip_fread(vdev->capfile, buf,
 127                                 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
 128                 if (ret > 0) {
 129                         if (ret % vdev->unitsize != 0)
 130                                 sr_warn("Read size %d not a multiple of the"
 131                                         " unit size %d.", ret, vdev->unitsize);
 132                         got_data = TRUE;
 133                         packet.type = SR_DF_LOGIC;
 134                         packet.payload = &logic;
 135                         logic.length = ret;
 136                         logic.unitsize = vdev->unitsize;
 137                         logic.data = buf;
 138                         vdev->bytes_read += ret;
 139                         sr_session_send(sdi, &packet);
 140                 } else {
 141                         /* done with this capture file */
 142                         zip_fclose(vdev->capfile);
 143                         vdev->capfile = NULL;
 144                         if (vdev->cur_chunk == 0) {
 145                                 /* It was the only file. */
 146                                 vdev->finished = TRUE;
 147                         } else {
 148                                 /* There might be more chunks, so don't fall through
 149                                  * to the SR_DF_END here. */
 150                                 g_free(buf);
 151                                 return TRUE;
 152                         }
 153                 }
 154                 g_free(buf);
 155         }
 156
 157         if (!got_data) {
 158                 packet.type = SR_DF_END;
 159                 sr_session_send(sdi, &packet);
 160                 sr_session_source_remove(sdi->session, -1);
 161         }
 162
 163         return TRUE;
 164 }
 165
 166 /* driver callbacks */
 167
 168 static int init(struct sr_context *sr_ctx)
 169 {
 170         return std_init(sr_ctx, di, LOG_PREFIX);
 171 }
 172
 173 static int dev_clear(void)
 174 {
 175         struct drv_context *drvc;
 176         GSList *l;
 177
 178         drvc = di->priv;
 179         for (l = drvc->instances; l; l = l->next)
 180                 sr_dev_inst_free(l->data);
 181         g_slist_free(drvc->instances);
 182         drvc->instances = NULL;
 183
 184         return SR_OK;
 185 }
 186
 187 static int dev_open(struct sr_dev_inst *sdi)
 188 {
 189         struct drv_context *drvc;
 190         struct session_vdev *vdev;
 191
 192         drvc = di->priv;
 193         vdev = g_malloc0(sizeof(struct session_vdev));
 194         sdi->priv = vdev;
 195         drvc->instances = g_slist_append(drvc->instances, sdi);
 196
 197         return SR_OK;
 198 }
 199
 200 static int dev_close(struct sr_dev_inst *sdi)
 201 {
 202         const struct session_vdev *const vdev = sdi->priv;
 203         g_free(vdev->sessionfile);
 204         g_free(vdev->capturefile);
 205
 206         g_free(sdi->priv);
 207         sdi->priv = NULL;
 208
 209         return SR_OK;
 210 }
 211
 212 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 213                 const struct sr_channel_group *cg)
 214 {
 215         struct session_vdev *vdev;
 216
 217         (void)cg;
 218
 219         switch (key) {
 220         case SR_CONF_SAMPLERATE:
 221                 if (sdi) {
 222                         vdev = sdi->priv;
 223                         *data = g_variant_new_uint64(vdev->samplerate);
 224                 } else
 225                         return SR_ERR;
 226                 break;
 227         default:
 228                 return SR_ERR_NA;
 229         }
 230
 231         return SR_OK;
 232 }
 233
 234 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 235                 const struct sr_channel_group *cg)
 236 {
 237         struct session_vdev *vdev;
 238
 239         (void)cg;
 240
 241         vdev = sdi->priv;
 242
 243         switch (key) {
 244         case SR_CONF_SAMPLERATE:
 245                 vdev->samplerate = g_variant_get_uint64(data);
 246                 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
 247                 break;
 248         case SR_CONF_SESSIONFILE:
 249                 g_free(vdev->sessionfile);
 250                 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
 251                 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
 252                 break;
 253         case SR_CONF_CAPTUREFILE:
 254                 g_free(vdev->capturefile);
 255                 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
 256                 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
 257                 break;
 258         case SR_CONF_CAPTURE_UNITSIZE:
 259                 vdev->unitsize = g_variant_get_uint64(data);
 260                 break;
 261         case SR_CONF_NUM_LOGIC_CHANNELS:
 262                 vdev->num_channels = g_variant_get_uint64(data);
 263                 break;
 264         default:
 265                 return SR_ERR_NA;
 266         }
 267
 268         return SR_OK;
 269 }
 270
 271 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 272                 const struct sr_channel_group *cg)
 273 {
 274         (void)sdi;
 275         (void)cg;
 276
 277         switch (key) {
 278         case SR_CONF_DEVICE_OPTIONS:
 279                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 280                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(uint32_t));
 281                 break;
 282         default:
 283                 return SR_ERR_NA;
 284         }
 285
 286         return SR_OK;
 287 }
 288
 289 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 290 {
 291         struct session_vdev *vdev;
 292         int ret;
 293
 294         (void)cb_data;
 295
 296         vdev = sdi->priv;
 297         vdev->bytes_read = 0;
 298         vdev->cur_chunk = 0;
 299         vdev->finished = FALSE;
 300
 301         sr_info("Opening archive %s file %s", vdev->sessionfile,
 302                 vdev->capturefile);
 303
 304         if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
 305                 sr_err("Failed to open session file '%s': "
 306                        "zip error %d.", vdev->sessionfile, ret);
 307                 return SR_ERR;
 308         }
 309
 310         /* Send header packet to the session bus. */
 311         std_session_send_df_header(sdi, LOG_PREFIX);
 312
 313         /* freewheeling source */
 314         sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
 315
 316         return SR_OK;
 317 }
 318
 319 /** @private */
 320 SR_PRIV struct sr_dev_driver session_driver = {
 321         .name = "virtual-session",
 322         .longname = "Session-emulating driver",
 323         .api_version = 1,
 324         .init = init,
 325         .cleanup = dev_clear,
 326         .scan = NULL,
 327         .dev_list = NULL,
 328         .dev_clear = dev_clear,
 329         .config_get = config_get,
 330         .config_set = config_set,
 331         .config_list = config_list,
 332         .dev_open = dev_open,
 333         .dev_close = dev_close,
 334         .dev_acquisition_start = dev_acquisition_start,
 335         .dev_acquisition_stop = NULL,
 336         .priv = NULL,
 337 };