]> sigrok.org Git - libsigrok.git/blame - src/session_file.c
analog save: Avoid index duplication between analog & logic channels.
[libsigrok.git] / src / session_file.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 <string.h>
22#include <stdlib.h>
7d658874 23#include <zip.h>
5f9c4c8a 24#include <errno.h>
7d658874 25#include <glib.h>
3bbd9849 26#include <glib/gstdio.h>
c1aae900 27#include <libsigrok/libsigrok.h>
45c59c8b 28#include "libsigrok-internal.h"
7d658874 29
2ad1deb8 30/** @cond PRIVATE */
3544f848 31#define LOG_PREFIX "session-file"
2ad1deb8 32/** @endcond */
a885ce3e 33
393fb9cb
UH
34/**
35 * @file
36 *
37 * Loading and saving libsigrok session files.
38 */
39
7b870c38 40/**
777e2035 41 * @addtogroup grp_session
7b870c38
UH
42 *
43 * @{
44 */
45
c09f0b57 46extern SR_PRIV struct sr_dev_driver session_driver;
c6805a02
SA
47static int session_driver_initialized = 0;
48
a6dc3dac
DE
49#if !HAVE_ZIP_DISCARD
50/* Replacement for zip_discard() if it isn't available.
51 */
52SR_PRIV void sr_zip_discard(struct zip *archive)
53{
54 if (zip_unchange_all(archive) < 0 || zip_close(archive) < 0)
55 sr_err("Failed to discard ZIP archive: %s", zip_strerror(archive));
56}
57#endif
58
5e1fb334
DE
59/** Read metadata entries from a session archive.
60 * @param[in] archive An open ZIP archive.
61 * @param[in] entry Stat buffer filled in for the metadata archive member.
62 * @return A new key/value store containing the session metadata.
63 */
64SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
65 const struct zip_stat *entry)
66{
67 GKeyFile *keyfile;
68 GError *error;
69 struct zip_file *zf;
70 char *metabuf;
71 int metalen;
72
73 if (entry->size > G_MAXINT || !(metabuf = g_try_malloc(entry->size))) {
74 sr_err("Metadata buffer allocation failed.");
75 return NULL;
76 }
77 zf = zip_fopen_index(archive, entry->index, 0);
78 if (!zf) {
79 sr_err("Failed to open metadata: %s", zip_strerror(archive));
80 g_free(metabuf);
81 return NULL;
82 }
83 metalen = zip_fread(zf, metabuf, entry->size);
84 if (metalen < 0) {
85 sr_err("Failed to read metadata: %s", zip_file_strerror(zf));
86 zip_fclose(zf);
87 g_free(metabuf);
88 return NULL;
89 }
90 zip_fclose(zf);
91
92 keyfile = g_key_file_new();
93 error = NULL;
94 g_key_file_load_from_data(keyfile, metabuf, metalen,
95 G_KEY_FILE_NONE, &error);
96 g_free(metabuf);
97
98 if (error) {
99 sr_err("Failed to parse metadata: %s", error->message);
100 g_error_free(error);
101 g_key_file_free(keyfile);
102 return NULL;
103 }
104 return keyfile;
105}
106
72a08bcc 107/** @private */
f438e0c9 108SR_PRIV int sr_sessionfile_check(const char *filename)
7d658874 109{
7d658874
BV
110 struct zip *archive;
111 struct zip_file *zf;
112 struct zip_stat zs;
5e1fb334
DE
113 uint64_t version;
114 int ret;
f438e0c9 115 char s[11];
7d658874 116
f438e0c9 117 if (!filename)
9f45fb3a 118 return SR_ERR_ARG;
9f45fb3a 119
5e1fb334
DE
120 if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) {
121 sr_err("Not a regular file: %s.", filename);
5f9c4c8a
BV
122 return SR_ERR;
123 }
124
5e1fb334 125 if (!(archive = zip_open(filename, 0, NULL)))
f438e0c9
BV
126 /* No logging: this can be used just to check if it's
127 * a sigrok session file or not. */
7d658874 128 return SR_ERR;
7d658874
BV
129
130 /* check "version" */
131 if (!(zf = zip_fopen(archive, "version", 0))) {
f438e0c9 132 sr_dbg("Not a sigrok session file: no version found.");
5e1fb334 133 zip_discard(archive);
7d658874
BV
134 return SR_ERR;
135 }
5e1fb334
DE
136 ret = zip_fread(zf, s, sizeof(s) - 1);
137 if (ret < 0) {
138 sr_err("Failed to read version file: %s",
139 zip_file_strerror(zf));
140 zip_fclose(zf);
141 zip_discard(archive);
7d658874 142 return SR_ERR;
5e1fb334 143 }
7d658874 144 zip_fclose(zf);
5e1fb334
DE
145 s[ret] = '\0';
146 version = g_ascii_strtoull(s, NULL, 10);
147 if (version == 0 || version > 2) {
148 sr_dbg("Cannot handle sigrok session file version %" PRIu64 ".",
149 version);
150 zip_discard(archive);
c1864d55
BV
151 return SR_ERR;
152 }
5e1fb334 153 sr_spew("Detected sigrok session file version %" PRIu64 ".", version);
7d658874
BV
154
155 /* read "metadata" */
5e1fb334 156 if (zip_stat(archive, "metadata", 0, &zs) < 0) {
a885ce3e 157 sr_dbg("Not a valid sigrok session file.");
5e1fb334 158 zip_discard(archive);
7d658874
BV
159 return SR_ERR;
160 }
5e1fb334 161 zip_discard(archive);
aba57f35 162
f438e0c9
BV
163 return SR_OK;
164}
165
166/**
167 * Load the session from the specified filename.
168 *
61e6e2da 169 * @param ctx The context in which to load the session.
d386a52f
BV
170 * @param filename The name of the session file to load.
171 * @param session The session to load the file into.
f438e0c9 172 *
d386a52f
BV
173 * @retval SR_OK Success
174 * @retval SR_ERR_MALLOC Memory allocation error
175 * @retval SR_ERR_DATA Malformed session file
176 * @retval SR_ERR This is not a session file
f438e0c9 177 */
61e6e2da
ML
178SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
179 struct sr_session **session)
f438e0c9
BV
180{
181 GKeyFile *kf;
5e1fb334 182 GError *error;
f438e0c9 183 struct zip *archive;
f438e0c9
BV
184 struct zip_stat zs;
185 struct sr_dev_inst *sdi;
6f1346fb 186 struct sr_channel *ch;
c6805a02 187 int ret, i, j;
5e1fb334 188 uint64_t tmp_u64;
b317d1bb
ML
189 int total_channels, total_analog, k;
190 GSList *l;
5e1fb334
DE
191 int unitsize;
192 char **sections, **keys, *val;
3f239f08 193 char channelname[SR_MAX_CHANNELNAME_LEN + 1];
f438e0c9
BV
194
195 if ((ret = sr_sessionfile_check(filename)) != SR_OK)
196 return ret;
197
5e1fb334 198 if (!(archive = zip_open(filename, 0, NULL)))
f438e0c9
BV
199 return SR_ERR;
200
5e1fb334
DE
201 if (zip_stat(archive, "metadata", 0, &zs) < 0) {
202 zip_discard(archive);
f438e0c9 203 return SR_ERR;
b53738ba 204 }
5e1fb334
DE
205 kf = sr_sessionfile_read_metadata(archive, &zs);
206 zip_discard(archive);
207 if (!kf)
208 return SR_ERR_DATA;
b53738ba 209
5e1fb334
DE
210 if ((ret = sr_session_new(ctx, session)) != SR_OK) {
211 g_key_file_free(kf);
0812c40e 212 return ret;
5e1fb334 213 }
7d658874 214
5e1fb334 215 error = NULL;
d386a52f 216 ret = SR_OK;
7d658874 217 sections = g_key_file_get_groups(kf, NULL);
d386a52f 218 for (i = 0; sections[i] && ret == SR_OK; i++) {
7d658874
BV
219 if (!strcmp(sections[i], "global"))
220 /* nothing really interesting in here yet */
221 continue;
222 if (!strncmp(sections[i], "device ", 7)) {
223 /* device section */
4d684427 224 sdi = NULL;
7d658874
BV
225 keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
226 for (j = 0; keys[j]; j++) {
7d658874 227 if (!strcmp(keys[j], "capturefile")) {
5e1fb334
DE
228 val = g_key_file_get_string(kf, sections[i],
229 keys[j], &error);
230 if (!val) {
231 ret = SR_ERR_DATA;
232 break;
233 }
aac29cc1 234 sdi = g_malloc0(sizeof(struct sr_dev_inst));
4d684427 235 sdi->driver = &session_driver;
0af636be 236 sdi->status = SR_ST_ACTIVE;
c6805a02 237 if (!session_driver_initialized) {
c09f0b57 238 /* first device, init the driver */
c6805a02 239 session_driver_initialized = 1;
4f840ce9 240 sdi->driver->init(sdi->driver, NULL);
c6805a02 241 }
bd7bfe8c 242 sr_dev_open(sdi);
0812c40e 243 sr_session_dev_add(*session, sdi);
1de3cced
ML
244 (*session)->owned_devs = g_slist_append(
245 (*session)->owned_devs, sdi);
5e1fb334
DE
246 sr_config_set(sdi, NULL, SR_CONF_SESSIONFILE,
247 g_variant_new_string(filename));
248 sr_config_set(sdi, NULL, SR_CONF_CAPTUREFILE,
249 g_variant_new_string(val));
250 g_free(val);
7d658874 251 } else if (!strcmp(keys[j], "samplerate")) {
5e1fb334
DE
252 val = g_key_file_get_string(kf, sections[i],
253 keys[j], &error);
254 if (!sdi || !val || sr_parse_sizestring(val,
255 &tmp_u64) != SR_OK) {
256 g_free(val);
d386a52f
BV
257 ret = SR_ERR_DATA;
258 break;
259 }
5e1fb334
DE
260 g_free(val);
261 sr_config_set(sdi, NULL, SR_CONF_SAMPLERATE,
262 g_variant_new_uint64(tmp_u64));
7d658874 263 } else if (!strcmp(keys[j], "unitsize")) {
5e1fb334
DE
264 unitsize = g_key_file_get_integer(kf, sections[i],
265 keys[j], &error);
266 if (!sdi || unitsize <= 0 || error) {
d386a52f
BV
267 ret = SR_ERR_DATA;
268 break;
269 }
5e1fb334
DE
270 sr_config_set(sdi, NULL, SR_CONF_CAPTURE_UNITSIZE,
271 g_variant_new_uint64(unitsize));
7d658874 272 } else if (!strcmp(keys[j], "total probes")) {
5e1fb334
DE
273 total_channels = g_key_file_get_integer(kf,
274 sections[i], keys[j], &error);
275 if (!sdi || total_channels < 0 || error) {
d386a52f
BV
276 ret = SR_ERR_DATA;
277 break;
278 }
5e1fb334 279 sr_config_set(sdi, NULL, SR_CONF_NUM_LOGIC_CHANNELS,
2c38a41a 280 g_variant_new_int32(total_channels));
5e1fb334 281 for (k = 0; k < total_channels; k++) {
b3cfc6e9 282 g_snprintf(channelname, sizeof(channelname),
5e1fb334
DE
283 "%d", k);
284 sr_channel_new(sdi, k, SR_CHANNEL_LOGIC,
285 FALSE, channelname);
464d12c7 286 }
b317d1bb
ML
287 } else if (!strcmp(keys[j], "total analog")) {
288 total_analog = g_key_file_get_integer(kf,
289 sections[i], keys[j], &error);
290 if (!sdi || total_analog < 0 || error) {
291 ret = SR_ERR_DATA;
292 break;
293 }
294 sr_config_set(sdi, NULL, SR_CONF_NUM_ANALOG_CHANNELS,
295 g_variant_new_int32(total_analog));
e5b280e4 296 for (k = total_channels; k < (total_channels + total_analog); k++) {
b317d1bb
ML
297 g_snprintf(channelname, sizeof(channelname),
298 "%d", k);
299 sr_channel_new(sdi, k, SR_CHANNEL_ANALOG,
300 FALSE, channelname);
301 }
7d658874 302 } else if (!strncmp(keys[j], "probe", 5)) {
0cadb8a3 303 tmp_u64 = g_ascii_strtoull(keys[j] + 5, NULL, 10);
5e1fb334
DE
304 if (!sdi || tmp_u64 == 0 || tmp_u64 > G_MAXINT) {
305 ret = SR_ERR_DATA;
306 break;
307 }
308 ch = g_slist_nth_data(sdi->channels, tmp_u64 - 1);
309 if (!ch) {
310 ret = SR_ERR_DATA;
311 break;
312 }
313 val = g_key_file_get_string(kf, sections[i],
314 keys[j], &error);
315 if (!val) {
d386a52f
BV
316 ret = SR_ERR_DATA;
317 break;
318 }
fb381e4d 319 /* sr_session_save() */
6f1346fb 320 sr_dev_channel_name_set(ch, val);
5e1fb334 321 g_free(val);
6f1346fb 322 sr_dev_channel_enable(ch, TRUE);
b317d1bb
ML
323 } else if (!strncmp(keys[j], "analog", 6)) {
324 tmp_u64 = g_ascii_strtoull(keys[j]+6, NULL, 10);
325 if (!sdi || tmp_u64 == 0 || tmp_u64 > G_MAXINT) {
326 ret = SR_ERR_DATA;
327 break;
328 }
329 ch = NULL;
330 for (l = sdi->channels; l; l = l->next) {
331 ch = l->data;
332 if ((guint64)ch->index == tmp_u64 - 1)
333 break;
334 else
335 ch = NULL;
336 }
337 if (!ch) {
338 ret = SR_ERR_DATA;
339 break;
340 }
341 val = g_key_file_get_string(kf, sections[i],
342 keys[j], &error);
343 if (!val) {
344 ret = SR_ERR_DATA;
345 break;
346 }
347 /* sr_session_save() */
348 sr_dev_channel_name_set(ch, val);
349 g_free(val);
350 sr_dev_channel_enable(ch, TRUE);
7d658874
BV
351 }
352 }
353 g_strfreev(keys);
7d658874
BV
354 }
355 }
356 g_strfreev(sections);
357 g_key_file_free(kf);
358
5e1fb334
DE
359 if (error) {
360 sr_err("Failed to parse metadata: %s", error->message);
361 g_error_free(error);
a769b9f3 362 }
a769b9f3
BV
363 return ret;
364}
365
7b870c38 366/** @} */