]> sigrok.org Git - libsigrok.git/blame - session_file.c
sr: fix sr_parse_triggerstring() to use probe numbers starting from 0
[libsigrok.git] / session_file.c
CommitLineData
7d658874
BV
1/*
2 * This file is part of the sigrok project.
3 *
c73d2ea4 4 * Copyright (C) 2010-2012 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 <string.h>
21#include <stdlib.h>
22#include <unistd.h>
23#include <zip.h>
24#include <glib.h>
3bbd9849 25#include <glib/gstdio.h>
1a081ca6 26#include "config.h"
45c59c8b
BV
27#include "libsigrok.h"
28#include "libsigrok-internal.h"
7d658874 29
2872d21e 30extern struct sr_session *session;
c09f0b57 31extern SR_PRIV struct sr_dev_driver session_driver;
7d658874 32
9f45fb3a
UH
33/**
34 * Load the session from the specified filename.
35 *
36 * @param filename The name of the session file to load. Must not be NULL.
37 *
38 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
39 * SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
40 * other errors.
41 */
1a081ca6 42SR_API int sr_session_load(const char *filename)
7d658874
BV
43{
44 GKeyFile *kf;
45 GPtrArray *capturefiles;
46 struct zip *archive;
47 struct zip_file *zf;
48 struct zip_stat zs;
4d684427 49 struct sr_dev_inst *sdi;
1afe8989 50 struct sr_probe *probe;
ebc34738 51 int ret, probenum, devcnt, i, j;
7d658874
BV
52 uint64_t tmp_u64, total_probes, enabled_probes, p;
53 char **sections, **keys, *metafile, *val, c;
c37d2b1b 54 char probename[SR_MAX_PROBENAME_LEN + 1];
7d658874 55
9f45fb3a
UH
56 if (!filename) {
57 sr_err("session file: %s: filename was NULL", __func__);
58 return SR_ERR_ARG;
59 }
60
ebc34738 61 if (!(archive = zip_open(filename, 0, &ret))) {
7b48d6e1 62 sr_dbg("session file: Failed to open session file: zip "
ebc34738 63 "error %d", ret);
7d658874
BV
64 return SR_ERR;
65 }
66
67 /* check "version" */
68 if (!(zf = zip_fopen(archive, "version", 0))) {
7b48d6e1 69 sr_dbg("session file: Not a sigrok session file.");
7d658874
BV
70 return SR_ERR;
71 }
72 ret = zip_fread(zf, &c, 1);
73 if (ret != 1 || c != '1') {
7b48d6e1 74 sr_dbg("session file: Not a valid sigrok session file.");
7d658874
BV
75 return SR_ERR;
76 }
77 zip_fclose(zf);
78
79 /* read "metadata" */
80 if (zip_stat(archive, "metadata", 0, &zs) == -1) {
7b48d6e1 81 sr_dbg("session file: Not a valid sigrok session file.");
7d658874
BV
82 return SR_ERR;
83 }
b53738ba
UH
84
85 if (!(metafile = g_try_malloc(zs.size))) {
86 sr_err("session file: %s: metafile malloc failed", __func__);
87 return SR_ERR_MALLOC;
88 }
89
7d658874
BV
90 zf = zip_fopen_index(archive, zs.index, 0);
91 zip_fread(zf, metafile, zs.size);
92 zip_fclose(zf);
93
94 kf = g_key_file_new();
95 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
7b48d6e1 96 sr_dbg("session file: Failed to parse metadata.");
7d658874
BV
97 return SR_ERR;
98 }
99
2285cf9b 100 sr_session_new();
7d658874
BV
101
102 devcnt = 0;
103 capturefiles = g_ptr_array_new_with_free_func(g_free);
104 sections = g_key_file_get_groups(kf, NULL);
105 for (i = 0; sections[i]; i++) {
106 if (!strcmp(sections[i], "global"))
107 /* nothing really interesting in here yet */
108 continue;
109 if (!strncmp(sections[i], "device ", 7)) {
110 /* device section */
4d684427 111 sdi = NULL;
7d658874
BV
112 enabled_probes = 0;
113 keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
114 for (j = 0; keys[j]; j++) {
115 val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
116 if (!strcmp(keys[j], "capturefile")) {
4d684427
BV
117 sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
118 sdi->driver = &session_driver;
7d658874 119 if (devcnt == 0)
c09f0b57 120 /* first device, init the driver */
4d684427
BV
121 sdi->driver->init();
122 sr_session_dev_add(sdi);
123 sdi->driver->dev_config_set(sdi, SR_HWCAP_SESSIONFILE, filename);
124 sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTUREFILE, val);
7d658874
BV
125 g_ptr_array_add(capturefiles, val);
126 } else if (!strcmp(keys[j], "samplerate")) {
f64c1414 127 sr_parse_sizestring(val, &tmp_u64);
4d684427 128 sdi->driver->dev_config_set(sdi, SR_HWCAP_SAMPLERATE, &tmp_u64);
7d658874
BV
129 } else if (!strcmp(keys[j], "unitsize")) {
130 tmp_u64 = strtoull(val, NULL, 10);
4d684427 131 sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTURE_UNITSIZE, &tmp_u64);
7d658874
BV
132 } else if (!strcmp(keys[j], "total probes")) {
133 total_probes = strtoull(val, NULL, 10);
4d684427 134 sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTURE_NUM_PROBES, &total_probes);
464d12c7
KS
135 for (p = 0; p < total_probes; p++) {
136 snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
4d684427
BV
137 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
138 probename)))
139 return SR_ERR;
140 sdi->probes = g_slist_append(sdi->probes, probe);
464d12c7 141 }
7d658874 142 } else if (!strncmp(keys[j], "probe", 5)) {
4d684427 143 if (!sdi)
7d658874
BV
144 continue;
145 enabled_probes++;
146 tmp_u64 = strtoul(keys[j]+5, NULL, 10);
37e8b4c4 147 sr_dev_probe_name_set(sdi, tmp_u64, val);
7d658874
BV
148 } else if (!strncmp(keys[j], "trigger", 7)) {
149 probenum = strtoul(keys[j]+7, NULL, 10);
4d684427 150 sr_dev_trigger_set(sdi, probenum, val);
7d658874
BV
151 }
152 }
153 g_strfreev(keys);
be5bf44d
BV
154 for (p = enabled_probes; p < total_probes; p++)
155 sr_dev_probe_enable(sdi, p, FALSE);
7d658874 156 }
4d684427 157 devcnt++;
7d658874
BV
158 }
159 g_strfreev(sections);
160 g_key_file_free(kf);
161
162 return SR_OK;
163}
164
9f45fb3a
UH
165/**
166 * Save the current session to the specified file.
167 *
168 * @param filename The name of the file where to save the current session.
169 * Must not be NULL.
170 *
171 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
172 * upon other errors.
173 */
8225e921 174int sr_session_save(const char *filename)
7d658874
BV
175{
176 GSList *l, *p, *d;
177 FILE *meta;
4d684427 178 struct sr_dev_inst *sdi;
1afe8989 179 struct sr_probe *probe;
c4911129 180 struct sr_datastore *ds;
7d658874
BV
181 struct zip *zipfile;
182 struct zip_source *versrc, *metasrc, *logicsrc;
ebc34738 183 int bufcnt, devcnt, tmpfile, ret, probecnt;
7d658874 184 uint64_t samplerate;
4a1b18f8 185 char version[1], rawname[16], metafile[32], *buf, *s;
7d658874 186
9f45fb3a
UH
187 if (!filename) {
188 sr_err("session file: %s: filename was NULL", __func__);
189 return SR_ERR_ARG;
190 }
191
7d658874 192 /* Quietly delete it first, libzip wants replace ops otherwise. */
4a1b18f8 193 unlink(filename);
ebc34738 194 if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
7d658874 195 return SR_ERR;
7d658874
BV
196
197 /* "version" */
198 version[0] = '1';
199 if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
200 return SR_ERR;
201 if (zip_add(zipfile, "version", versrc) == -1) {
7b48d6e1 202 sr_info("session file: error saving version into zipfile: %s",
b08024a8 203 zip_strerror(zipfile));
7d658874
BV
204 return SR_ERR;
205 }
206
207 /* init "metadata" */
208 strcpy(metafile, "sigrok-meta-XXXXXX");
209 if ((tmpfile = g_mkstemp(metafile)) == -1)
210 return SR_ERR;
211 close(tmpfile);
868d8cef 212 meta = g_fopen(metafile, "wb");
7d658874
BV
213 fprintf(meta, "[global]\n");
214 fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
215 /* TODO: save protocol decoders used */
216
217 /* all datastores in all devices */
218 devcnt = 1;
bb7ef793
UH
219 for (l = session->devs; l; l = l->next) {
220 dev = l->data;
7d658874
BV
221 /* metadata */
222 fprintf(meta, "[device %d]\n", devcnt);
c09f0b57
UH
223 if (dev->driver)
224 fprintf(meta, "driver = %s\n", dev->driver->name);
7d658874 225
bb7ef793 226 ds = dev->datastore;
7d658874
BV
227 if (ds) {
228 /* metadata */
229 fprintf(meta, "capturefile = logic-%d\n", devcnt);
230 fprintf(meta, "unitsize = %d\n", ds->ds_unitsize);
bb7ef793
UH
231 fprintf(meta, "total probes = %d\n", g_slist_length(dev->probes));
232 if (sr_dev_has_hwcap(dev, SR_HWCAP_SAMPLERATE)) {
c09f0b57
UH
233 samplerate = *((uint64_t *) dev->driver->dev_info_get(
234 dev->driver_index, SR_DI_CUR_SAMPLERATE));
7d658874
BV
235 s = sr_samplerate_string(samplerate);
236 fprintf(meta, "samplerate = %s\n", s);
133a37bf 237 g_free(s);
7d658874
BV
238 }
239 probecnt = 1;
bb7ef793 240 for (p = dev->probes; p; p = p->next) {
7d658874
BV
241 probe = p->data;
242 if (probe->enabled) {
243 if (probe->name)
244 fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
245 if (probe->trigger)
246 fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
247 probecnt++;
248 }
249 }
250
251 /* dump datastore into logic-n */
133a37bf 252 buf = g_try_malloc(ds->num_units * ds->ds_unitsize +
7d658874 253 DATASTORE_CHUNKSIZE);
133a37bf
UH
254 if (!buf) {
255 sr_err("session file: %s: buf malloc failed",
256 __func__);
257 return SR_ERR_MALLOC;
258 }
259
7d658874
BV
260 bufcnt = 0;
261 for (d = ds->chunklist; d; d = d->next) {
262 memcpy(buf + bufcnt, d->data,
263 DATASTORE_CHUNKSIZE);
264 bufcnt += DATASTORE_CHUNKSIZE;
265 }
266 if (!(logicsrc = zip_source_buffer(zipfile, buf,
267 ds->num_units * ds->ds_unitsize, TRUE)))
268 return SR_ERR;
269 snprintf(rawname, 15, "logic-%d", devcnt);
270 if (zip_add(zipfile, rawname, logicsrc) == -1)
271 return SR_ERR;
272 }
273 devcnt++;
274 }
275 fclose(meta);
276
277 if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
278 return SR_ERR;
279 if (zip_add(zipfile, "metadata", metasrc) == -1)
280 return SR_ERR;
281
282 if ((ret = zip_close(zipfile)) == -1) {
7b48d6e1
UH
283 sr_info("session file: error saving zipfile: %s",
284 zip_strerror(zipfile));
7d658874
BV
285 return SR_ERR;
286 }
287
288 unlink(metafile);
289
290 return SR_OK;
291}