]> sigrok.org Git - libsigrok.git/blame - src/session_driver.c
session-file: Use 32-bit int for channel count
[libsigrok.git] / src / session_driver.c
CommitLineData
7d658874 1/*
50985c20 2 * This file is part of the libsigrok project.
7d658874 3 *
13d8e03c 4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
7d658874
BV
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
6ec6c43b 20#include <config.h>
7d658874
BV
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>
c1aae900 27#include <libsigrok/libsigrok.h>
45c59c8b 28#include "libsigrok-internal.h"
7d658874 29
3544f848 30#define LOG_PREFIX "virtual-session"
a885ce3e 31
7d658874 32/* size of payloads sent across the session bus */
b4bd7088 33/** @cond PRIVATE */
8ff6afc9 34#define CHUNKSIZE (512 * 1024)
b4bd7088 35/** @endcond */
7d658874 36
102f1239 37SR_PRIV struct sr_dev_driver session_driver_info;
102f1239 38
bb7ef793 39struct session_vdev {
40dda2c3 40 char *sessionfile;
7d658874
BV
41 char *capturefile;
42 struct zip *archive;
43 struct zip_file *capfile;
cb1e389c 44 int bytes_read;
7d658874
BV
45 uint64_t samplerate;
46 int unitsize;
fca75cbb 47 int num_channels;
f438e0c9 48 int cur_chunk;
aa48adf9 49 gboolean finished;
7d658874
BV
50};
51
f254bc4b 52static const uint32_t devopts[] = {
68ac991d
BV
53 SR_CONF_CAPTUREFILE | SR_CONF_SET,
54 SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
02e49ae5 55 SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_SET,
68ac991d 56 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
02e49ae5 57 SR_CONF_SESSIONFILE | SR_CONF_SET,
7d658874
BV
58};
59
8d4097ff 60static gboolean stream_session_data(struct sr_dev_inst *sdi)
7d658874 61{
bb7ef793 62 struct session_vdev *vdev;
7d658874 63 struct sr_datafeed_packet packet;
9c939c51 64 struct sr_datafeed_logic logic;
f438e0c9 65 struct zip_stat zs;
7d658874 66 int ret, got_data;
f438e0c9
BV
67 char capturefile[16];
68 void *buf;
7d658874 69
7d658874 70 got_data = FALSE;
102f1239 71 vdev = sdi->priv;
8d4097ff
DE
72 if (!vdev->capfile) {
73 /* No capture file opened yet, or finished with the last
74 * chunked one. */
75 if (vdev->cur_chunk == 0) {
76 /* capturefile is always the unchunked base name. */
77 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
78 /* No chunks, just a single capture file. */
79 vdev->cur_chunk = 0;
80 if (!(vdev->capfile = zip_fopen(vdev->archive,
81 vdev->capturefile, 0)))
82 return FALSE;
83 sr_dbg("Opened %s.", vdev->capturefile);
f438e0c9 84 } else {
8d4097ff
DE
85 /* Try as first chunk filename. */
86 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
f438e0c9 87 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
8d4097ff 88 vdev->cur_chunk = 1;
f438e0c9
BV
89 if (!(vdev->capfile = zip_fopen(vdev->archive,
90 capturefile, 0)))
91 return FALSE;
92 sr_dbg("Opened %s.", capturefile);
93 } else {
8d4097ff
DE
94 sr_err("No capture file '%s' in " "session file '%s'.",
95 vdev->capturefile, vdev->sessionfile);
96 return FALSE;
f438e0c9
BV
97 }
98 }
7d658874 99 } else {
8d4097ff
DE
100 /* Capture data is chunked, advance to the next chunk. */
101 vdev->cur_chunk++;
102 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
103 vdev->cur_chunk);
104 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
105 if (!(vdev->capfile = zip_fopen(vdev->archive,
106 capturefile, 0)))
107 return FALSE;
108 sr_dbg("Opened %s.", capturefile);
f438e0c9 109 } else {
8d4097ff
DE
110 /* We got all the chunks, finish up. */
111 return FALSE;
f438e0c9 112 }
7d658874
BV
113 }
114 }
115
8d4097ff
DE
116 buf = g_malloc(CHUNKSIZE);
117
118 ret = zip_fread(vdev->capfile, buf,
119 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
120 if (ret > 0) {
121 if (ret % vdev->unitsize != 0)
122 sr_warn("Read size %d not a multiple of the"
123 " unit size %d.", ret, vdev->unitsize);
124 got_data = TRUE;
125 packet.type = SR_DF_LOGIC;
126 packet.payload = &logic;
127 logic.length = ret;
128 logic.unitsize = vdev->unitsize;
129 logic.data = buf;
130 vdev->bytes_read += ret;
102f1239 131 sr_session_send(sdi, &packet);
8d4097ff
DE
132 } else {
133 /* done with this capture file */
134 zip_fclose(vdev->capfile);
135 vdev->capfile = NULL;
136 if (vdev->cur_chunk != 0) {
137 /* There might be more chunks, so don't fall through
138 * to the SR_DF_END here. */
139 got_data = TRUE;
140 }
7d658874 141 }
8d4097ff 142 g_free(buf);
7d658874 143
8d4097ff
DE
144 return got_data;
145}
146
147static int receive_data(int fd, int revents, void *cb_data)
148{
149 struct sr_dev_inst *sdi;
150 struct session_vdev *vdev;
151 struct sr_datafeed_packet packet;
152
153 (void)fd;
154 (void)revents;
155
156 sdi = cb_data;
157 vdev = sdi->priv;
158
159 if (!vdev->finished && !stream_session_data(sdi))
160 vdev->finished = TRUE;
161 if (!vdev->finished)
162 return G_SOURCE_CONTINUE;
163
164 if (vdev->capfile) {
165 zip_fclose(vdev->capfile);
166 vdev->capfile = NULL;
167 }
168 if (vdev->archive) {
169 zip_discard(vdev->archive);
170 vdev->archive = NULL;
171 }
172 packet.type = SR_DF_END;
173 packet.payload = NULL;
174 sr_session_send(sdi, &packet);
175
176 return G_SOURCE_REMOVE;
7d658874
BV
177}
178
179/* driver callbacks */
180
4f840ce9 181static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
7d658874 182{
102f1239 183 return std_init(sr_ctx, di, LOG_PREFIX);
7d658874
BV
184}
185
4f840ce9 186static int dev_clear(const struct sr_dev_driver *di)
7d658874 187{
102f1239 188 struct drv_context *drvc;
7d658874
BV
189 GSList *l;
190
41812aca 191 drvc = di->context;
102f1239 192 for (l = drvc->instances; l; l = l->next)
d3683c42 193 sr_dev_inst_free(l->data);
102f1239
BV
194 g_slist_free(drvc->instances);
195 drvc->instances = NULL;
805e9640 196
57ab7d9f 197 return SR_OK;
7d658874
BV
198}
199
6078d2c9 200static int dev_open(struct sr_dev_inst *sdi)
7d658874 201{
4f840ce9 202 struct sr_dev_driver *di;
102f1239 203 struct drv_context *drvc;
aa48adf9 204 struct session_vdev *vdev;
b53738ba 205
4f840ce9 206 di = sdi->driver;
41812aca 207 drvc = di->context;
102f1239 208 vdev = g_malloc0(sizeof(struct session_vdev));
aa48adf9 209 sdi->priv = vdev;
102f1239 210 drvc->instances = g_slist_append(drvc->instances, sdi);
7d658874
BV
211
212 return SR_OK;
213}
214
aa48adf9
BV
215static int dev_close(struct sr_dev_inst *sdi)
216{
8c9d4d67
JH
217 const struct session_vdev *const vdev = sdi->priv;
218 g_free(vdev->sessionfile);
219 g_free(vdev->capturefile);
220
aa48adf9
BV
221 g_free(sdi->priv);
222 sdi->priv = NULL;
223
224 return SR_OK;
225}
226
584560f1 227static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 228 const struct sr_channel_group *cg)
7d658874 229{
bb7ef793 230 struct session_vdev *vdev;
7d658874 231
53b4680f 232 (void)cg;
8f996b89 233
3f2cd87f
UH
234 if (!sdi)
235 return SR_ERR;
236
237 vdev = sdi->priv;
238
584560f1 239 switch (key) {
123e1313 240 case SR_CONF_SAMPLERATE:
3f2cd87f
UH
241 *data = g_variant_new_uint64(vdev->samplerate);
242 break;
243 case SR_CONF_CAPTURE_UNITSIZE:
244 *data = g_variant_new_uint64(vdev->unitsize);
387014de
BV
245 break;
246 default:
96ea73db 247 return SR_ERR_NA;
387014de 248 }
7d658874 249
387014de 250 return SR_OK;
7d658874
BV
251}
252
584560f1 253static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 254 const struct sr_channel_group *cg)
7d658874 255{
bb7ef793 256 struct session_vdev *vdev;
7d658874 257
53b4680f 258 (void)cg;
8f996b89 259
6f4b1868 260 vdev = sdi->priv;
7d658874 261
584560f1 262 switch (key) {
1953564a 263 case SR_CONF_SAMPLERATE:
003595ac 264 vdev->samplerate = g_variant_get_uint64(data);
a885ce3e 265 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
7d658874 266 break;
1953564a 267 case SR_CONF_SESSIONFILE:
8c9d4d67 268 g_free(vdev->sessionfile);
003595ac 269 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 270 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
40dda2c3 271 break;
1953564a 272 case SR_CONF_CAPTUREFILE:
8c9d4d67 273 g_free(vdev->capturefile);
003595ac 274 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 275 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
7d658874 276 break;
1953564a 277 case SR_CONF_CAPTURE_UNITSIZE:
003595ac 278 vdev->unitsize = g_variant_get_uint64(data);
7d658874 279 break;
3f239f08 280 case SR_CONF_NUM_LOGIC_CHANNELS:
2c38a41a 281 vdev->num_channels = g_variant_get_int32(data);
7d658874
BV
282 break;
283 default:
96ea73db 284 return SR_ERR_NA;
7d658874
BV
285 }
286
287 return SR_OK;
288}
289
584560f1 290static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 291 const struct sr_channel_group *cg)
9a6517d1 292{
9a6517d1 293 (void)sdi;
53b4680f 294 (void)cg;
9a6517d1
BV
295
296 switch (key) {
297 case SR_CONF_DEVICE_OPTIONS:
584560f1 298 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 299 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1
BV
300 break;
301 default:
96ea73db 302 return SR_ERR_NA;
9a6517d1
BV
303 }
304
305 return SR_OK;
306}
307
6078d2c9 308static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
7d658874 309{
bb7ef793 310 struct session_vdev *vdev;
ebc34738 311 int ret;
7d658874 312
102f1239 313 (void)cb_data;
7d658874 314
102f1239 315 vdev = sdi->priv;
8c9d4d67
JH
316 vdev->bytes_read = 0;
317 vdev->cur_chunk = 0;
318 vdev->finished = FALSE;
319
a885ce3e 320 sr_info("Opening archive %s file %s", vdev->sessionfile,
bb7ef793 321 vdev->capturefile);
7d658874 322
40dda2c3 323 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
a885ce3e 324 sr_err("Failed to open session file '%s': "
9d122af8 325 "zip error %d.", vdev->sessionfile, ret);
7d658874
BV
326 return SR_ERR;
327 }
328
4afdfd46 329 /* Send header packet to the session bus. */
102f1239 330 std_session_send_df_header(sdi, LOG_PREFIX);
4afdfd46 331
7d658874 332 /* freewheeling source */
102f1239 333 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
7d658874 334
7d658874
BV
335 return SR_OK;
336}
337
8d4097ff
DE
338static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
339{
340 struct session_vdev *vdev;
341
342 (void)cb_data;
343 vdev = sdi->priv;
344
345 vdev->finished = TRUE;
346
347 return SR_OK;
348}
349
b4bd7088 350/** @private */
c09f0b57 351SR_PRIV struct sr_dev_driver session_driver = {
a885ce3e 352 .name = "virtual-session",
5097b0d0
UH
353 .longname = "Session-emulating driver",
354 .api_version = 1,
6078d2c9 355 .init = init,
824fba03 356 .cleanup = dev_clear,
96ea73db
UH
357 .scan = NULL,
358 .dev_list = NULL,
824fba03 359 .dev_clear = dev_clear,
035a1078
BV
360 .config_get = config_get,
361 .config_set = config_set,
9a6517d1 362 .config_list = config_list,
6078d2c9 363 .dev_open = dev_open,
aa48adf9 364 .dev_close = dev_close,
6078d2c9 365 .dev_acquisition_start = dev_acquisition_start,
8d4097ff 366 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 367 .context = NULL,
7d658874 368};