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