2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
24 #include <sys/types.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"
34 #define LOG_PREFIX "session-file"
40 * Loading and saving libsigrok session files.
44 * @addtogroup grp_session
49 extern SR_PRIV struct sr_dev_driver session_driver;
50 static int session_driver_initialized = 0;
53 SR_PRIV int sr_sessionfile_check(const char *filename)
65 if (stat(filename, &st) == -1) {
66 sr_err("Couldn't stat %s: %s", filename, strerror(errno));
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. */
76 if (!(zf = zip_fopen(archive, "version", 0))) {
77 sr_dbg("Not a sigrok session file: no version found.");
80 if ((ret = zip_fread(zf, s, 10)) == -1)
84 version = strtoull(s, NULL, 10);
86 sr_dbg("Cannot handle sigrok session file version %d.", version);
89 sr_spew("Detected sigrok session file version %d.", version);
92 if (zip_stat(archive, "metadata", 0, &zs) == -1) {
93 sr_dbg("Not a valid sigrok session file.");
97 if ((ret = zip_close(archive)) == -1) {
98 sr_dbg("error closing zipfile: %s", zip_strerror(archive));
106 * Load the session from the specified filename.
108 * @param filename The name of the session file to load.
109 * @param session The session to load the file into.
111 * @retval SR_OK Success
112 * @retval SR_ERR_MALLOC Memory allocation error
113 * @retval SR_ERR_DATA Malformed session file
114 * @retval SR_ERR This is not a session file
116 SR_API int sr_session_load(const char *filename, struct sr_session **session)
119 GPtrArray *capturefiles;
123 struct sr_dev_inst *sdi;
124 struct sr_channel *ch;
126 uint64_t tmp_u64, total_channels, p;
127 char **sections, **keys, *metafile, *val;
128 char channelname[SR_MAX_CHANNELNAME_LEN + 1];
130 if ((ret = sr_sessionfile_check(filename)) != SR_OK)
133 if (!(archive = zip_open(filename, 0, &ret)))
136 if (zip_stat(archive, "metadata", 0, &zs) == -1)
139 if (!(metafile = g_try_malloc(zs.size))) {
140 sr_err("%s: metafile malloc failed", __func__);
141 return SR_ERR_MALLOC;
144 zf = zip_fopen_index(archive, zs.index, 0);
145 zip_fread(zf, metafile, zs.size);
148 kf = g_key_file_new();
149 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
150 sr_dbg("Failed to parse metadata.");
154 if ((ret = sr_session_new(session)) != SR_OK)
158 capturefiles = g_ptr_array_new_with_free_func(g_free);
159 sections = g_key_file_get_groups(kf, NULL);
160 for (i = 0; sections[i] && ret == SR_OK; i++) {
161 if (!strcmp(sections[i], "global"))
162 /* nothing really interesting in here yet */
164 if (!strncmp(sections[i], "device ", 7)) {
167 keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
168 for (j = 0; keys[j]; j++) {
169 val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
170 if (!strcmp(keys[j], "capturefile")) {
171 sdi = g_malloc0(sizeof(struct sr_dev_inst));
172 sdi->driver = &session_driver;
173 sdi->status = SR_ST_ACTIVE;
174 if (!session_driver_initialized) {
175 /* first device, init the driver */
176 session_driver_initialized = 1;
177 sdi->driver->init(sdi->driver, NULL);
180 sr_session_dev_add(*session, sdi);
181 (*session)->owned_devs = g_slist_append(
182 (*session)->owned_devs, sdi);
183 sdi->driver->config_set(SR_CONF_SESSIONFILE,
184 g_variant_new_string(filename), sdi, NULL);
185 sdi->driver->config_set(SR_CONF_CAPTUREFILE,
186 g_variant_new_string(val), sdi, NULL);
187 g_ptr_array_add(capturefiles, val);
188 } else if (!strcmp(keys[j], "samplerate")) {
193 sr_parse_sizestring(val, &tmp_u64);
194 sdi->driver->config_set(SR_CONF_SAMPLERATE,
195 g_variant_new_uint64(tmp_u64), sdi, NULL);
196 } else if (!strcmp(keys[j], "unitsize")) {
201 tmp_u64 = strtoull(val, NULL, 10);
202 sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
203 g_variant_new_uint64(tmp_u64), sdi, NULL);
204 } else if (!strcmp(keys[j], "total probes")) {
209 total_channels = strtoull(val, NULL, 10);
210 sdi->driver->config_set(SR_CONF_NUM_LOGIC_CHANNELS,
211 g_variant_new_uint64(total_channels), sdi, NULL);
212 for (p = 0; p < total_channels; p++) {
213 snprintf(channelname, SR_MAX_CHANNELNAME_LEN, "%" PRIu64, p);
214 sr_channel_new(sdi, p, SR_CHANNEL_LOGIC, FALSE,
217 } else if (!strncmp(keys[j], "probe", 5)) {
222 tmp_u64 = strtoul(keys[j]+5, NULL, 10) - 1;
223 ch = g_slist_nth_data(sdi->channels, tmp_u64);
224 /* sr_session_save() */
225 sr_dev_channel_name_set(ch, val);
226 sr_dev_channel_enable(ch, TRUE);
232 g_strfreev(sections);
239 * Save a session to the specified file.
241 * @param session The session to save to the specified file. Must not be NULL.
242 * @param filename The name of the filename to save the session as.
244 * @param sdi The device instance from which the data was captured.
245 * @param buf The data to be saved.
246 * @param unitsize The number of bytes per sample.
247 * @param units The number of samples.
249 * @retval SR_OK Success
250 * @retval SR_ERR_ARG Invalid arguments
251 * @retval SR_ERR Other errors
255 SR_API int sr_session_save(struct sr_session *session, const char *filename,
256 const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize,
259 struct sr_channel *ch;
264 char **channel_names;
267 if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
268 if (sr_config_get(sdi->driver, sdi, NULL,
269 SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
270 samplerate = g_variant_get_uint64(gvar);
271 g_variant_unref(gvar);
275 channel_names = g_malloc0(sizeof(char *) * (g_slist_length(sdi->channels) + 1));
277 for (l = sdi->channels; l; l = l->next) {
279 if (ch->type != SR_CHANNEL_LOGIC)
281 if (ch->enabled != TRUE)
285 /* Just borrowing the ptr. */
286 channel_names[cnt++] = ch->name;
289 if ((ret = sr_session_save_init(session, filename, samplerate,
290 channel_names)) != SR_OK)
293 ret = sr_session_append(session, filename, buf, unitsize, units);
299 * Initialize a saved session file.
301 * @param session The session to use. Must not be NULL.
302 * @param filename The name of the filename to save the session as.
304 * @param samplerate The samplerate to store for this session.
305 * @param channels A NULL-terminated array of strings containing the names
306 * of all the channels active in this session.
308 * @retval SR_OK Success
309 * @retval SR_ERR_ARG Invalid arguments
310 * @retval SR_ERR Other errors
314 SR_API int sr_session_save_init(struct sr_session *session,
315 const char *filename, uint64_t samplerate, char **channels)
319 struct zip_source *versrc, *metasrc;
320 int tmpfile, cnt, ret, i;
321 char version[1], metafile[32], *s;
326 sr_err("%s: filename was NULL", __func__);
330 /* Quietly delete it first, libzip wants replace ops otherwise. */
332 if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
337 if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
339 if (zip_add(zipfile, "version", versrc) == -1) {
340 sr_info("error saving version into zipfile: %s",
341 zip_strerror(zipfile));
345 /* init "metadata" */
346 strcpy(metafile, "sigrok-meta-XXXXXX");
347 if ((tmpfile = g_mkstemp(metafile)) == -1)
350 meta = g_fopen(metafile, "wb");
351 fprintf(meta, "[global]\n");
352 fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
355 fprintf(meta, "[device 1]\n");
358 fprintf(meta, "capturefile = logic-1\n");
360 for (i = 0; channels[i]; i++)
362 fprintf(meta, "total probes = %d\n", cnt);
363 s = sr_samplerate_string(samplerate);
364 fprintf(meta, "samplerate = %s\n", s);
367 for (i = 0; channels[i]; i++)
368 fprintf(meta, "probe%d = %s\n", i + 1, channels[i]);
372 if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
376 if (zip_add(zipfile, "metadata", metasrc) == -1) {
381 if ((ret = zip_close(zipfile)) == -1) {
382 sr_info("error saving zipfile: %s", zip_strerror(zipfile));
393 * Append data to an existing session file.
395 * The session file must have been created with sr_session_save_init()
396 * or sr_session_save() beforehand.
398 * @param session The session to use. Must not be NULL.
399 * @param filename The name of the filename to append to. Must not be NULL.
400 * @param buf The data to be appended.
401 * @param unitsize The number of bytes per sample.
402 * @param units The number of samples.
404 * @retval SR_OK Success
405 * @retval SR_ERR_ARG Invalid arguments
406 * @retval SR_ERR Other errors
410 SR_API int sr_session_append(struct sr_session *session, const char *filename,
411 unsigned char *buf, int unitsize, int units)
414 struct zip_source *logicsrc;
415 zip_int64_t num_files;
418 struct zip_source *metasrc;
422 int chunk_num, next_chunk_num, tmpfile, ret, i;
423 const char *entry_name;
424 char *metafile, tmpname[32], chunkname[16];
428 if ((ret = sr_sessionfile_check(filename)) != SR_OK)
431 if (!(archive = zip_open(filename, 0, &ret)))
434 if (zip_stat(archive, "metadata", 0, &zs) == -1)
437 metafile = g_malloc(zs.size);
438 zf = zip_fopen_index(archive, zs.index, 0);
439 zip_fread(zf, metafile, zs.size);
443 * If the file was only initialized but doesn't yet have any
444 * data it in, it won't have a unitsize field in metadata yet.
447 kf = g_key_file_new();
448 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
449 sr_err("Failed to parse metadata: %s.", error->message);
454 if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
455 if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
456 sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
459 /* Add unitsize field. */
460 g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
461 metafile = g_key_file_to_data(kf, &len, &error);
462 strcpy(tmpname, "sigrok-meta-XXXXXX");
463 if ((tmpfile = g_mkstemp(tmpname)) == -1)
465 if (write(tmpfile, metafile, len) < 0) {
466 sr_dbg("Failed to create new metadata: %s", strerror(errno));
472 if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
473 sr_err("Failed to create zip source for metadata.");
478 if (zip_replace(archive, zs.index, metasrc) == -1) {
479 sr_err("Failed to replace metadata file.");
489 num_files = zip_get_num_entries(archive, 0);
490 for (i = 0; i < num_files; i++) {
491 entry_name = zip_get_name(archive, i, 0);
492 if (strncmp(entry_name, "logic-1", 7))
494 if (strlen(entry_name) == 7) {
495 /* This file has no extra chunks, just a single "logic-1".
496 * Rename it to "logic-1-1" * and continue with chunk 2. */
497 if (zip_rename(archive, i, "logic-1-1") == -1) {
498 sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
504 } else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
505 chunk_num = strtoull(entry_name + 8, NULL, 10);
506 if (chunk_num >= next_chunk_num)
507 next_chunk_num = chunk_num + 1;
510 snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
511 if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE))) {
515 if (zip_add(archive, chunkname, logicsrc) == -1) {
519 if ((ret = zip_close(archive)) == -1) {
520 sr_info("error saving session file: %s", zip_strerror(archive));