]> sigrok.org Git - libsigrok.git/blame - src/session_driver.c
Build: Set local include directories in Makefile.am
[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
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>
c1aae900 26#include <libsigrok/libsigrok.h>
45c59c8b 27#include "libsigrok-internal.h"
7d658874 28
3544f848 29#define LOG_PREFIX "virtual-session"
a885ce3e 30
7d658874 31/* size of payloads sent across the session bus */
b4bd7088 32/** @cond PRIVATE */
8ff6afc9 33#define CHUNKSIZE (512 * 1024)
b4bd7088 34/** @endcond */
7d658874 35
102f1239 36SR_PRIV struct sr_dev_driver session_driver_info;
102f1239 37
bb7ef793 38struct session_vdev {
40dda2c3 39 char *sessionfile;
7d658874
BV
40 char *capturefile;
41 struct zip *archive;
42 struct zip_file *capfile;
cb1e389c 43 int bytes_read;
7d658874
BV
44 uint64_t samplerate;
45 int unitsize;
fca75cbb 46 int num_channels;
f438e0c9 47 int cur_chunk;
aa48adf9 48 gboolean finished;
7d658874
BV
49};
50
f254bc4b 51static const uint32_t devopts[] = {
68ac991d
BV
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,
7d658874
BV
55};
56
9289e273 57static int receive_data(int fd, int revents, void *cb_data)
7d658874 58{
d68e2d1a 59 struct sr_dev_inst *sdi;
bb7ef793 60 struct session_vdev *vdev;
7d658874 61 struct sr_datafeed_packet packet;
9c939c51 62 struct sr_datafeed_logic logic;
f438e0c9 63 struct zip_stat zs;
7d658874 64 int ret, got_data;
f438e0c9
BV
65 char capturefile[16];
66 void *buf;
7d658874 67
cb93f8a9
UH
68 (void)fd;
69 (void)revents;
7d658874 70
102f1239 71 sdi = cb_data;
7d658874 72 got_data = FALSE;
102f1239
BV
73 vdev = sdi->priv;
74 if (!vdev->finished) {
f438e0c9
BV
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. */
aa48adf9 114 vdev->finished = TRUE;
102f1239 115 return TRUE;
f438e0c9
BV
116 }
117 }
118 }
119
a95f142e 120 buf = g_malloc(CHUNKSIZE);
016f2e00 121
8bbdd364
DE
122 ret = zip_fread(vdev->capfile, buf,
123 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
7d658874 124 if (ret > 0) {
8bbdd364
DE
125 if (ret % vdev->unitsize != 0)
126 sr_warn("Read size %d not a multiple of the"
127 " unit size %d.", ret, vdev->unitsize);
7d658874
BV
128 got_data = TRUE;
129 packet.type = SR_DF_LOGIC;
9c939c51
BV
130 packet.payload = &logic;
131 logic.length = ret;
bb7ef793 132 logic.unitsize = vdev->unitsize;
9c939c51 133 logic.data = buf;
bb7ef793 134 vdev->bytes_read += ret;
102f1239 135 sr_session_send(sdi, &packet);
7d658874
BV
136 } else {
137 /* done with this capture file */
bb7ef793 138 zip_fclose(vdev->capfile);
f438e0c9
BV
139 vdev->capfile = NULL;
140 if (vdev->cur_chunk == 0) {
141 /* It was the only file. */
aa48adf9 142 vdev->finished = TRUE;
f438e0c9
BV
143 } else {
144 /* There might be more chunks, so don't fall through
145 * to the SR_DF_END here. */
016f2e00 146 g_free(buf);
f438e0c9
BV
147 return TRUE;
148 }
7d658874 149 }
016f2e00 150 g_free(buf);
7d658874
BV
151 }
152
153 if (!got_data) {
154 packet.type = SR_DF_END;
102f1239
BV
155 sr_session_send(sdi, &packet);
156 sr_session_source_remove(sdi->session, -1);
7d658874
BV
157 }
158
159 return TRUE;
160}
161
162/* driver callbacks */
163
4f840ce9 164static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
7d658874 165{
102f1239 166 return std_init(sr_ctx, di, LOG_PREFIX);
7d658874
BV
167}
168
4f840ce9 169static int dev_clear(const struct sr_dev_driver *di)
7d658874 170{
102f1239 171 struct drv_context *drvc;
7d658874
BV
172 GSList *l;
173
41812aca 174 drvc = di->context;
102f1239 175 for (l = drvc->instances; l; l = l->next)
d3683c42 176 sr_dev_inst_free(l->data);
102f1239
BV
177 g_slist_free(drvc->instances);
178 drvc->instances = NULL;
805e9640 179
57ab7d9f 180 return SR_OK;
7d658874
BV
181}
182
6078d2c9 183static int dev_open(struct sr_dev_inst *sdi)
7d658874 184{
4f840ce9 185 struct sr_dev_driver *di;
102f1239 186 struct drv_context *drvc;
aa48adf9 187 struct session_vdev *vdev;
b53738ba 188
4f840ce9 189 di = sdi->driver;
41812aca 190 drvc = di->context;
102f1239 191 vdev = g_malloc0(sizeof(struct session_vdev));
aa48adf9 192 sdi->priv = vdev;
102f1239 193 drvc->instances = g_slist_append(drvc->instances, sdi);
7d658874
BV
194
195 return SR_OK;
196}
197
aa48adf9
BV
198static int dev_close(struct sr_dev_inst *sdi)
199{
8c9d4d67
JH
200 const struct session_vdev *const vdev = sdi->priv;
201 g_free(vdev->sessionfile);
202 g_free(vdev->capturefile);
203
aa48adf9
BV
204 g_free(sdi->priv);
205 sdi->priv = NULL;
206
207 return SR_OK;
208}
209
584560f1 210static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 211 const struct sr_channel_group *cg)
7d658874 212{
bb7ef793 213 struct session_vdev *vdev;
7d658874 214
53b4680f 215 (void)cg;
8f996b89 216
3f2cd87f
UH
217 if (!sdi)
218 return SR_ERR;
219
220 vdev = sdi->priv;
221
584560f1 222 switch (key) {
123e1313 223 case SR_CONF_SAMPLERATE:
3f2cd87f
UH
224 *data = g_variant_new_uint64(vdev->samplerate);
225 break;
226 case SR_CONF_CAPTURE_UNITSIZE:
227 *data = g_variant_new_uint64(vdev->unitsize);
387014de
BV
228 break;
229 default:
96ea73db 230 return SR_ERR_NA;
387014de 231 }
7d658874 232
387014de 233 return SR_OK;
7d658874
BV
234}
235
584560f1 236static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 237 const struct sr_channel_group *cg)
7d658874 238{
bb7ef793 239 struct session_vdev *vdev;
7d658874 240
53b4680f 241 (void)cg;
8f996b89 242
6f4b1868 243 vdev = sdi->priv;
7d658874 244
584560f1 245 switch (key) {
1953564a 246 case SR_CONF_SAMPLERATE:
003595ac 247 vdev->samplerate = g_variant_get_uint64(data);
a885ce3e 248 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
7d658874 249 break;
1953564a 250 case SR_CONF_SESSIONFILE:
8c9d4d67 251 g_free(vdev->sessionfile);
003595ac 252 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 253 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
40dda2c3 254 break;
1953564a 255 case SR_CONF_CAPTUREFILE:
8c9d4d67 256 g_free(vdev->capturefile);
003595ac 257 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 258 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
7d658874 259 break;
1953564a 260 case SR_CONF_CAPTURE_UNITSIZE:
003595ac 261 vdev->unitsize = g_variant_get_uint64(data);
7d658874 262 break;
3f239f08 263 case SR_CONF_NUM_LOGIC_CHANNELS:
fca75cbb 264 vdev->num_channels = g_variant_get_uint64(data);
7d658874
BV
265 break;
266 default:
96ea73db 267 return SR_ERR_NA;
7d658874
BV
268 }
269
270 return SR_OK;
271}
272
584560f1 273static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 274 const struct sr_channel_group *cg)
9a6517d1 275{
9a6517d1 276 (void)sdi;
53b4680f 277 (void)cg;
9a6517d1
BV
278
279 switch (key) {
280 case SR_CONF_DEVICE_OPTIONS:
584560f1 281 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 282 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1
BV
283 break;
284 default:
96ea73db 285 return SR_ERR_NA;
9a6517d1
BV
286 }
287
288 return SR_OK;
289}
290
6078d2c9 291static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
7d658874 292{
bb7ef793 293 struct session_vdev *vdev;
ebc34738 294 int ret;
7d658874 295
102f1239 296 (void)cb_data;
7d658874 297
102f1239 298 vdev = sdi->priv;
8c9d4d67
JH
299 vdev->bytes_read = 0;
300 vdev->cur_chunk = 0;
301 vdev->finished = FALSE;
302
a885ce3e 303 sr_info("Opening archive %s file %s", vdev->sessionfile,
bb7ef793 304 vdev->capturefile);
7d658874 305
40dda2c3 306 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
a885ce3e 307 sr_err("Failed to open session file '%s': "
9d122af8 308 "zip error %d.", vdev->sessionfile, ret);
7d658874
BV
309 return SR_ERR;
310 }
311
4afdfd46 312 /* Send header packet to the session bus. */
102f1239 313 std_session_send_df_header(sdi, LOG_PREFIX);
4afdfd46 314
7d658874 315 /* freewheeling source */
102f1239 316 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
7d658874 317
7d658874
BV
318 return SR_OK;
319}
320
b4bd7088 321/** @private */
c09f0b57 322SR_PRIV struct sr_dev_driver session_driver = {
a885ce3e 323 .name = "virtual-session",
5097b0d0
UH
324 .longname = "Session-emulating driver",
325 .api_version = 1,
6078d2c9 326 .init = init,
824fba03 327 .cleanup = dev_clear,
96ea73db
UH
328 .scan = NULL,
329 .dev_list = NULL,
824fba03 330 .dev_clear = dev_clear,
035a1078
BV
331 .config_get = config_get,
332 .config_set = config_set,
9a6517d1 333 .config_list = config_list,
6078d2c9 334 .dev_open = dev_open,
aa48adf9 335 .dev_close = dev_close,
6078d2c9 336 .dev_acquisition_start = dev_acquisition_start,
69040b7c 337 .dev_acquisition_stop = NULL,
41812aca 338 .context = NULL,
7d658874 339};