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/>.
25 #include <sys/types.h>
29 #include <glib/gstdio.h>
30 #include <libsigrok/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, g_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 ctx The context in which to load the session.
109 * @param filename The name of the session file to load.
110 * @param session The session to load the file into.
112 * @retval SR_OK Success
113 * @retval SR_ERR_MALLOC Memory allocation error
114 * @retval SR_ERR_DATA Malformed session file
115 * @retval SR_ERR This is not a session file
117 SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
118 struct sr_session **session)
121 GPtrArray *capturefiles;
125 struct sr_dev_inst *sdi;
126 struct sr_channel *ch;
128 uint64_t tmp_u64, total_channels, p;
129 char **sections, **keys, *metafile, *val;
130 char channelname[SR_MAX_CHANNELNAME_LEN + 1];
132 if ((ret = sr_sessionfile_check(filename)) != SR_OK)
135 if (!(archive = zip_open(filename, 0, &ret)))
138 if (zip_stat(archive, "metadata", 0, &zs) == -1)
141 if (!(metafile = g_try_malloc(zs.size))) {
142 sr_err("%s: metafile malloc failed", __func__);
143 return SR_ERR_MALLOC;
146 zf = zip_fopen_index(archive, zs.index, 0);
147 zip_fread(zf, metafile, zs.size);
150 kf = g_key_file_new();
151 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
152 sr_dbg("Failed to parse metadata.");
156 if ((ret = sr_session_new(ctx, session)) != SR_OK)
160 capturefiles = g_ptr_array_new_with_free_func(g_free);
161 sections = g_key_file_get_groups(kf, NULL);
162 for (i = 0; sections[i] && ret == SR_OK; i++) {
163 if (!strcmp(sections[i], "global"))
164 /* nothing really interesting in here yet */
166 if (!strncmp(sections[i], "device ", 7)) {
169 keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
170 for (j = 0; keys[j]; j++) {
171 val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
172 if (!strcmp(keys[j], "capturefile")) {
173 sdi = g_malloc0(sizeof(struct sr_dev_inst));
174 sdi->driver = &session_driver;
175 sdi->status = SR_ST_ACTIVE;
176 if (!session_driver_initialized) {
177 /* first device, init the driver */
178 session_driver_initialized = 1;
179 sdi->driver->init(sdi->driver, NULL);
182 sr_session_dev_add(*session, sdi);
183 (*session)->owned_devs = g_slist_append(
184 (*session)->owned_devs, sdi);
185 sdi->driver->config_set(SR_CONF_SESSIONFILE,
186 g_variant_new_string(filename), sdi, NULL);
187 sdi->driver->config_set(SR_CONF_CAPTUREFILE,
188 g_variant_new_string(val), sdi, NULL);
189 g_ptr_array_add(capturefiles, val);
190 } else if (!strcmp(keys[j], "samplerate")) {
195 sr_parse_sizestring(val, &tmp_u64);
196 sdi->driver->config_set(SR_CONF_SAMPLERATE,
197 g_variant_new_uint64(tmp_u64), sdi, NULL);
198 } else if (!strcmp(keys[j], "unitsize")) {
203 tmp_u64 = strtoull(val, NULL, 10);
204 sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
205 g_variant_new_uint64(tmp_u64), sdi, NULL);
206 } else if (!strcmp(keys[j], "total probes")) {
211 total_channels = strtoull(val, NULL, 10);
212 sdi->driver->config_set(SR_CONF_NUM_LOGIC_CHANNELS,
213 g_variant_new_uint64(total_channels), sdi, NULL);
214 for (p = 0; p < total_channels; p++) {
215 snprintf(channelname, SR_MAX_CHANNELNAME_LEN, "%" PRIu64, p);
216 sr_channel_new(sdi, p, SR_CHANNEL_LOGIC, FALSE,
219 } else if (!strncmp(keys[j], "probe", 5)) {
224 tmp_u64 = strtoul(keys[j]+5, NULL, 10) - 1;
225 ch = g_slist_nth_data(sdi->channels, tmp_u64);
226 /* sr_session_save() */
227 sr_dev_channel_name_set(ch, val);
228 sr_dev_channel_enable(ch, TRUE);
234 g_strfreev(sections);
241 * Save a session to the specified file.
243 * @param session The session to save to the specified file. Must not be NULL.
244 * @param filename The name of the filename to save the session as.
246 * @param sdi The device instance from which the data was captured.
247 * @param buf The data to be saved.
248 * @param unitsize The number of bytes per sample.
249 * @param units The number of samples.
251 * @retval SR_OK Success
252 * @retval SR_ERR_ARG Invalid arguments
253 * @retval SR_ERR Other errors
257 SR_API int sr_session_save(struct sr_session *session, const char *filename,
258 const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize,
261 struct sr_channel *ch;
266 char **channel_names;
269 if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
270 if (sr_config_get(sdi->driver, sdi, NULL,
271 SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
272 samplerate = g_variant_get_uint64(gvar);
273 g_variant_unref(gvar);
277 channel_names = g_malloc0(sizeof(char *) * (g_slist_length(sdi->channels) + 1));
279 for (l = sdi->channels; l; l = l->next) {
281 if (ch->type != SR_CHANNEL_LOGIC)
283 if (ch->enabled != TRUE)
287 /* Just borrowing the ptr. */
288 channel_names[cnt++] = ch->name;
291 if ((ret = sr_session_save_init(session, filename, samplerate,
292 channel_names)) != SR_OK)
295 ret = sr_session_append(session, filename, buf, unitsize, units);
301 * Initialize a saved session file.
303 * @param session The session to use. Must not be NULL.
304 * @param filename The name of the filename to save the session as.
306 * @param samplerate The samplerate to store for this session.
307 * @param channels A NULL-terminated array of strings containing the names
308 * of all the channels active in this session.
310 * @retval SR_OK Success
311 * @retval SR_ERR_ARG Invalid arguments
312 * @retval SR_ERR Other errors
316 SR_API int sr_session_save_init(struct sr_session *session,
317 const char *filename, uint64_t samplerate, char **channels)
321 struct zip_source *versrc, *metasrc;
322 int tmpfile, cnt, ret, i;
323 char version[1], metafile[32], *s;
328 sr_err("%s: filename was NULL", __func__);
332 /* Quietly delete it first, libzip wants replace ops otherwise. */
334 if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
339 if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
341 if (zip_add(zipfile, "version", versrc) == -1) {
342 sr_info("error saving version into zipfile: %s",
343 zip_strerror(zipfile));
347 /* init "metadata" */
348 strcpy(metafile, "sigrok-meta-XXXXXX");
349 if ((tmpfile = g_mkstemp(metafile)) == -1)
352 meta = g_fopen(metafile, "wb");
353 fprintf(meta, "[global]\n");
354 fprintf(meta, "sigrok version = %s\n", SR_PACKAGE_VERSION_STRING);
357 fprintf(meta, "[device 1]\n");
360 fprintf(meta, "capturefile = logic-1\n");
362 for (i = 0; channels[i]; i++)
364 fprintf(meta, "total probes = %d\n", cnt);
365 s = sr_samplerate_string(samplerate);
366 fprintf(meta, "samplerate = %s\n", s);
369 for (i = 0; channels[i]; i++)
370 fprintf(meta, "probe%d = %s\n", i + 1, channels[i]);
374 if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
378 if (zip_add(zipfile, "metadata", metasrc) == -1) {
383 if ((ret = zip_close(zipfile)) == -1) {
384 sr_info("error saving zipfile: %s", zip_strerror(zipfile));
395 * Append data to an existing session file.
397 * The session file must have been created with sr_session_save_init()
398 * or sr_session_save() beforehand.
400 * @param session The session to use. Must not be NULL.
401 * @param filename The name of the filename to append to. Must not be NULL.
402 * @param buf The data to be appended.
403 * @param unitsize The number of bytes per sample.
404 * @param units The number of samples.
406 * @retval SR_OK Success
407 * @retval SR_ERR_ARG Invalid arguments
408 * @retval SR_ERR Other errors
412 SR_API int sr_session_append(struct sr_session *session, const char *filename,
413 unsigned char *buf, int unitsize, int units)
416 struct zip_source *logicsrc;
417 zip_int64_t num_files;
420 struct zip_source *metasrc;
424 int chunk_num, next_chunk_num, tmpfile, ret, i;
425 const char *entry_name;
426 char *metafile, tmpname[32], chunkname[16];
430 if ((ret = sr_sessionfile_check(filename)) != SR_OK)
433 if (!(archive = zip_open(filename, 0, &ret)))
436 if (zip_stat(archive, "metadata", 0, &zs) == -1)
439 metafile = g_malloc(zs.size);
440 zf = zip_fopen_index(archive, zs.index, 0);
441 zip_fread(zf, metafile, zs.size);
445 * If the file was only initialized but doesn't yet have any
446 * data it in, it won't have a unitsize field in metadata yet.
449 kf = g_key_file_new();
450 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
451 sr_err("Failed to parse metadata: %s.", error->message);
456 if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
457 if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
458 sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
461 /* Add unitsize field. */
462 g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
463 metafile = g_key_file_to_data(kf, &len, &error);
464 strcpy(tmpname, "sigrok-meta-XXXXXX");
465 if ((tmpfile = g_mkstemp(tmpname)) == -1)
467 if (write(tmpfile, metafile, len) < 0) {
468 sr_dbg("Failed to create new metadata: %s", g_strerror(errno));
474 if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
475 sr_err("Failed to create zip source for metadata.");
480 if (zip_replace(archive, zs.index, metasrc) == -1) {
481 sr_err("Failed to replace metadata file.");
491 num_files = zip_get_num_entries(archive, 0);
492 for (i = 0; i < num_files; i++) {
493 entry_name = zip_get_name(archive, i, 0);
494 if (strncmp(entry_name, "logic-1", 7))
496 if (strlen(entry_name) == 7) {
497 /* This file has no extra chunks, just a single "logic-1".
498 * Rename it to "logic-1-1" * and continue with chunk 2. */
499 if (zip_rename(archive, i, "logic-1-1") == -1) {
500 sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
506 } else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
507 chunk_num = strtoull(entry_name + 8, NULL, 10);
508 if (chunk_num >= next_chunk_num)
509 next_chunk_num = chunk_num + 1;
512 snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
513 if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE))) {
517 if (zip_add(archive, chunkname, logicsrc) == -1) {
521 if ((ret = zip_close(archive)) == -1) {
522 sr_info("error saving session file: %s", zip_strerror(archive));