]> sigrok.org Git - libsigrok.git/blame_incremental - session_file.c
doxygen: Updated Doxyfile to doxygen 1.8.6.
[libsigrok.git] / session_file.c
... / ...
CommitLineData
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 <string.h>
21#include <stdlib.h>
22#include <unistd.h>
23#include <zip.h>
24#include <sys/types.h>
25#include <sys/stat.h>
26#include <errno.h>
27#include <glib.h>
28#include <glib/gstdio.h>
29#include "config.h" /* Needed for PACKAGE_VERSION and others. */
30#include "libsigrok.h"
31#include "libsigrok-internal.h"
32
33/** @cond PRIVATE */
34#define LOG_PREFIX "session-file"
35/** @endcond */
36
37/**
38 * @file
39 *
40 * Loading and saving libsigrok session files.
41 */
42
43/**
44 * @addtogroup grp_session
45 *
46 * @{
47 */
48
49extern struct sr_session *session;
50extern SR_PRIV struct sr_dev_driver session_driver;
51
52/** @private */
53SR_PRIV int sr_sessionfile_check(const char *filename)
54{
55 struct stat st;
56 struct zip *archive;
57 struct zip_file *zf;
58 struct zip_stat zs;
59 int version, ret;
60 char s[11];
61
62 if (!filename)
63 return SR_ERR_ARG;
64
65 if (stat(filename, &st) == -1) {
66 sr_err("Couldn't stat %s: %s", filename, strerror(errno));
67 return SR_ERR;
68 }
69
70 if (!(archive = zip_open(filename, 0, &ret)))
71 /* No logging: this can be used just to check if it's
72 * a sigrok session file or not. */
73 return SR_ERR;
74
75 /* check "version" */
76 version = 0;
77 if (!(zf = zip_fopen(archive, "version", 0))) {
78 sr_dbg("Not a sigrok session file: no version found.");
79 return SR_ERR;
80 }
81 if ((ret = zip_fread(zf, s, 10)) == -1)
82 return SR_ERR;
83 zip_fclose(zf);
84 s[ret] = 0;
85 version = strtoull(s, NULL, 10);
86 if (version > 2) {
87 sr_dbg("Cannot handle sigrok session file version %d.", version);
88 return SR_ERR;
89 }
90 sr_spew("Detected sigrok session file version %d.", version);
91
92 /* read "metadata" */
93 if (zip_stat(archive, "metadata", 0, &zs) == -1) {
94 sr_dbg("Not a valid sigrok session file.");
95 return SR_ERR;
96 }
97
98 return SR_OK;
99}
100
101/**
102 * Load the session from the specified filename.
103 *
104 * @param filename The name of the session file to load. Must not be NULL.
105 *
106 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
107 * SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
108 * other errors.
109 */
110SR_API int sr_session_load(const char *filename)
111{
112 GKeyFile *kf;
113 GPtrArray *capturefiles;
114 struct zip *archive;
115 struct zip_file *zf;
116 struct zip_stat zs;
117 struct sr_dev_inst *sdi;
118 struct sr_channel *ch;
119 int ret, channelnum, devcnt, i, j;
120 uint64_t tmp_u64, total_channels, enabled_channels, p;
121 char **sections, **keys, *metafile, *val;
122 char channelname[SR_MAX_CHANNELNAME_LEN + 1];
123
124 if ((ret = sr_sessionfile_check(filename)) != SR_OK)
125 return ret;
126
127 if (!(archive = zip_open(filename, 0, &ret)))
128 return SR_ERR;
129
130 if (zip_stat(archive, "metadata", 0, &zs) == -1)
131 return SR_ERR;
132
133 if (!(metafile = g_try_malloc(zs.size))) {
134 sr_err("%s: metafile malloc failed", __func__);
135 return SR_ERR_MALLOC;
136 }
137
138 zf = zip_fopen_index(archive, zs.index, 0);
139 zip_fread(zf, metafile, zs.size);
140 zip_fclose(zf);
141
142 kf = g_key_file_new();
143 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
144 sr_dbg("Failed to parse metadata.");
145 return SR_ERR;
146 }
147
148 sr_session_new();
149
150 devcnt = 0;
151 capturefiles = g_ptr_array_new_with_free_func(g_free);
152 sections = g_key_file_get_groups(kf, NULL);
153 for (i = 0; sections[i]; i++) {
154 if (!strcmp(sections[i], "global"))
155 /* nothing really interesting in here yet */
156 continue;
157 if (!strncmp(sections[i], "device ", 7)) {
158 /* device section */
159 sdi = NULL;
160 enabled_channels = total_channels = 0;
161 keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
162 for (j = 0; keys[j]; j++) {
163 val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
164 if (!strcmp(keys[j], "capturefile")) {
165 sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
166 sdi->driver = &session_driver;
167 if (devcnt == 0)
168 /* first device, init the driver */
169 sdi->driver->init(NULL);
170 sr_dev_open(sdi);
171 sr_session_dev_add(sdi);
172 sdi->driver->config_set(SR_CONF_SESSIONFILE,
173 g_variant_new_string(filename), sdi, NULL);
174 sdi->driver->config_set(SR_CONF_CAPTUREFILE,
175 g_variant_new_string(val), sdi, NULL);
176 g_ptr_array_add(capturefiles, val);
177 } else if (!strcmp(keys[j], "samplerate")) {
178 sr_parse_sizestring(val, &tmp_u64);
179 sdi->driver->config_set(SR_CONF_SAMPLERATE,
180 g_variant_new_uint64(tmp_u64), sdi, NULL);
181 } else if (!strcmp(keys[j], "unitsize")) {
182 tmp_u64 = strtoull(val, NULL, 10);
183 sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
184 g_variant_new_uint64(tmp_u64), sdi, NULL);
185 } else if (!strcmp(keys[j], "total probes")) {
186 total_channels = strtoull(val, NULL, 10);
187 sdi->driver->config_set(SR_CONF_NUM_LOGIC_CHANNELS,
188 g_variant_new_uint64(total_channels), sdi, NULL);
189 for (p = 0; p < total_channels; p++) {
190 snprintf(channelname, SR_MAX_CHANNELNAME_LEN, "%" PRIu64, p);
191 if (!(ch = sr_channel_new(p, SR_CHANNEL_LOGIC, TRUE,
192 channelname)))
193 return SR_ERR;
194 sdi->channels = g_slist_append(sdi->channels, ch);
195 }
196 } else if (!strncmp(keys[j], "probe", 5)) {
197 if (!sdi)
198 continue;
199 enabled_channels++;
200 tmp_u64 = strtoul(keys[j]+5, NULL, 10);
201 /* sr_session_save() */
202 sr_dev_channel_name_set(sdi, tmp_u64 - 1, val);
203 } else if (!strncmp(keys[j], "trigger", 7)) {
204 channelnum = strtoul(keys[j]+7, NULL, 10);
205 sr_dev_trigger_set(sdi, channelnum, val);
206 }
207 }
208 g_strfreev(keys);
209 /* Disable channels not specifically listed. */
210 if (total_channels)
211 for (p = enabled_channels; p < total_channels; p++)
212 sr_dev_channel_enable(sdi, p, FALSE);
213 }
214 devcnt++;
215 }
216 g_strfreev(sections);
217 g_key_file_free(kf);
218
219 return SR_OK;
220}
221
222/**
223 * Save the current session to the specified file.
224 *
225 * @param filename The name of the filename to save the current session as.
226 * Must not be NULL.
227 * @param sdi The device instance from which the data was captured.
228 * @param buf The data to be saved.
229 * @param unitsize The number of bytes per sample.
230 * @param units The number of samples.
231 *
232 * @retval SR_OK Success
233 * @retval SR_ERR_ARG Invalid arguments
234 * @retval SR_ERR Other errors
235 */
236SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
237 unsigned char *buf, int unitsize, int units)
238{
239 struct sr_channel *ch;
240 GSList *l;
241 GVariant *gvar;
242 uint64_t samplerate;
243 int cnt, ret;
244 char **channel_names;
245
246 samplerate = 0;
247 if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
248 if (sr_config_get(sdi->driver, sdi, NULL,
249 SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
250 samplerate = g_variant_get_uint64(gvar);
251 g_variant_unref(gvar);
252 }
253 }
254
255 channel_names = g_malloc0(sizeof(char *) * (g_slist_length(sdi->channels) + 1));
256 cnt = 0;
257 for (l = sdi->channels; l; l = l->next) {
258 ch = l->data;
259 if (ch->type != SR_CHANNEL_LOGIC)
260 continue;
261 if (ch->enabled != TRUE)
262 continue;
263 if (!ch->name)
264 continue;
265 /* Just borrowing the ptr. */
266 channel_names[cnt++] = ch->name;
267 }
268
269 if ((ret = sr_session_save_init(filename, samplerate, channel_names)) != SR_OK)
270 return ret;
271
272 ret = sr_session_append(filename, buf, unitsize, units);
273
274 return ret;
275}
276
277/**
278 * Initialize a saved session file.
279 *
280 * @param filename The name of the filename to save the current session as.
281 * Must not be NULL.
282 * @param samplerate The samplerate to store for this session.
283 * @param channels A NULL-terminated array of strings containing the names
284 * of all the channels active in this session.
285 *
286 * @retval SR_OK Success
287 * @retval SR_ERR_ARG Invalid arguments
288 * @retval SR_ERR Other errors
289 */
290SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
291 char **channels)
292{
293 FILE *meta;
294 struct zip *zipfile;
295 struct zip_source *versrc, *metasrc;
296 int tmpfile, cnt, ret, i;
297 char version[1], metafile[32], *s;
298
299 if (!filename) {
300 sr_err("%s: filename was NULL", __func__);
301 return SR_ERR_ARG;
302 }
303
304 /* Quietly delete it first, libzip wants replace ops otherwise. */
305 unlink(filename);
306 if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
307 return SR_ERR;
308
309 /* "version" */
310 version[0] = '2';
311 if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
312 return SR_ERR;
313 if (zip_add(zipfile, "version", versrc) == -1) {
314 sr_info("error saving version into zipfile: %s",
315 zip_strerror(zipfile));
316 return SR_ERR;
317 }
318
319 /* init "metadata" */
320 strcpy(metafile, "sigrok-meta-XXXXXX");
321 if ((tmpfile = g_mkstemp(metafile)) == -1)
322 return SR_ERR;
323 close(tmpfile);
324 meta = g_fopen(metafile, "wb");
325 fprintf(meta, "[global]\n");
326 fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
327
328 /* metadata */
329 fprintf(meta, "[device 1]\n");
330
331 /* metadata */
332 fprintf(meta, "capturefile = logic-1\n");
333 cnt = 0;
334 for (i = 0; channels[i]; i++)
335 cnt++;
336 fprintf(meta, "total probes = %d\n", cnt);
337 s = sr_samplerate_string(samplerate);
338 fprintf(meta, "samplerate = %s\n", s);
339 g_free(s);
340
341 for (i = 0; channels[i]; i++)
342 fprintf(meta, "probe%d = %s\n", i + 1, channels[i]);
343
344 fclose(meta);
345
346 if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
347 unlink(metafile);
348 return SR_ERR;
349 }
350 if (zip_add(zipfile, "metadata", metasrc) == -1) {
351 unlink(metafile);
352 return SR_ERR;
353 }
354
355 if ((ret = zip_close(zipfile)) == -1) {
356 sr_info("error saving zipfile: %s", zip_strerror(zipfile));
357 unlink(metafile);
358 return SR_ERR;
359 }
360
361 unlink(metafile);
362
363 return SR_OK;
364}
365
366/**
367 * Append data to an existing session file.
368 *
369 * The session file must have been created with sr_session_save_init()
370 * or sr_session_save() beforehand.
371 *
372 * @param filename The name of the filename to append to. Must not be NULL.
373 * @param buf The data to be appended.
374 * @param unitsize The number of bytes per sample.
375 * @param units The number of samples.
376 *
377 * @retval SR_OK Success
378 * @retval SR_ERR_ARG Invalid arguments
379 * @retval SR_ERR Other errors
380 */
381SR_API int sr_session_append(const char *filename, unsigned char *buf,
382 int unitsize, int units)
383{
384 struct zip *archive;
385 struct zip_source *logicsrc;
386 zip_int64_t num_files;
387 struct zip_file *zf;
388 struct zip_stat zs;
389 struct zip_source *metasrc;
390 GKeyFile *kf;
391 GError *error;
392 gsize len;
393 int chunk_num, next_chunk_num, tmpfile, ret, i;
394 const char *entry_name;
395 char *metafile, tmpname[32], chunkname[16];
396
397 if ((ret = sr_sessionfile_check(filename)) != SR_OK)
398 return ret;
399
400 if (!(archive = zip_open(filename, 0, &ret)))
401 return SR_ERR;
402
403 if (zip_stat(archive, "metadata", 0, &zs) == -1)
404 return SR_ERR;
405
406 metafile = g_malloc(zs.size);
407 zf = zip_fopen_index(archive, zs.index, 0);
408 zip_fread(zf, metafile, zs.size);
409 zip_fclose(zf);
410
411 /*
412 * If the file was only initialized but doesn't yet have any
413 * data it in, it won't have a unitsize field in metadata yet.
414 */
415 error = NULL;
416 kf = g_key_file_new();
417 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
418 sr_err("Failed to parse metadata: %s.", error->message);
419 return SR_ERR;
420 }
421 g_free(metafile);
422 tmpname[0] = '\0';
423 if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
424 if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
425 sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
426 return SR_ERR;
427 }
428 /* Add unitsize field. */
429 g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
430 metafile = g_key_file_to_data(kf, &len, &error);
431 strcpy(tmpname, "sigrok-meta-XXXXXX");
432 if ((tmpfile = g_mkstemp(tmpname)) == -1)
433 return SR_ERR;
434 if (write(tmpfile, metafile, len) < 0) {
435 sr_dbg("Failed to create new metadata: %s", strerror(errno));
436 g_free(metafile);
437 unlink(tmpname);
438 return SR_ERR;
439 }
440 close(tmpfile);
441 if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
442 sr_err("Failed to create zip source for metadata.");
443 g_free(metafile);
444 unlink(tmpname);
445 return SR_ERR;
446 }
447 if (zip_replace(archive, zs.index, metasrc) == -1) {
448 sr_err("Failed to replace metadata file.");
449 g_free(metafile);
450 unlink(tmpname);
451 return SR_ERR;
452 }
453 g_free(metafile);
454 }
455 g_key_file_free(kf);
456
457 next_chunk_num = 1;
458 num_files = zip_get_num_entries(archive, 0);
459 for (i = 0; i < num_files; i++) {
460 entry_name = zip_get_name(archive, i, 0);
461 if (strncmp(entry_name, "logic-1", 7))
462 continue;
463 if (strlen(entry_name) == 7) {
464 /* This file has no extra chunks, just a single "logic-1".
465 * Rename it to "logic-1-1" * and continue with chunk 2. */
466 if (zip_rename(archive, i, "logic-1-1") == -1) {
467 sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
468 unlink(tmpname);
469 return SR_ERR;
470 }
471 next_chunk_num = 2;
472 break;
473 } else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
474 chunk_num = strtoull(entry_name + 8, NULL, 10);
475 if (chunk_num >= next_chunk_num)
476 next_chunk_num = chunk_num + 1;
477 }
478 }
479 snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
480 if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE))) {
481 unlink(tmpname);
482 return SR_ERR;
483 }
484 if (zip_add(archive, chunkname, logicsrc) == -1) {
485 unlink(tmpname);
486 return SR_ERR;
487 }
488 if ((ret = zip_close(archive)) == -1) {
489 sr_info("error saving session file: %s", zip_strerror(archive));
490 unlink(tmpname);
491 return SR_ERR;
492 }
493 unlink(tmpname);
494
495 return SR_OK;
496}
497
498/** @} */