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;
54 SR_PRIV int sr_sessionfile_check(const char *filename)
66 if (stat(filename, &st) == -1) {
67 sr_err("Couldn't stat %s: %s", filename, strerror(errno));
71 if (!(archive = zip_open(filename, 0, &ret)))
72 /* No logging: this can be used just to check if it's
73 * a sigrok session file or not. */
77 if (!(zf = zip_fopen(archive, "version", 0))) {
78 sr_dbg("Not a sigrok session file: no version found.");
81 if ((ret = zip_fread(zf, s, 10)) == -1)
85 version = strtoull(s, NULL, 10);
87 sr_dbg("Cannot handle sigrok session file version %d.", version);
90 sr_spew("Detected sigrok session file version %d.", version);
93 if (zip_stat(archive, "metadata", 0, &zs) == -1) {
94 sr_dbg("Not a valid sigrok session file.");
98 if ((ret = zip_close(archive)) == -1) {
99 sr_dbg("error closing zipfile: %s", zip_strerror(archive));
107 * Load the session from the specified filename.
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(const char *filename, struct sr_session **session)
120 GPtrArray *capturefiles;
124 struct sr_dev_inst *sdi;
125 struct sr_channel *ch;
127 uint64_t tmp_u64, total_channels, enabled_channels, p;
128 char **sections, **keys, *metafile, *val;
129 char channelname[SR_MAX_CHANNELNAME_LEN + 1];
131 if ((ret = sr_sessionfile_check(filename)) != SR_OK)
134 if (!(archive = zip_open(filename, 0, &ret)))
137 if (zip_stat(archive, "metadata", 0, &zs) == -1)
140 if (!(metafile = g_try_malloc(zs.size))) {
141 sr_err("%s: metafile malloc failed", __func__);
142 return SR_ERR_MALLOC;
145 zf = zip_fopen_index(archive, zs.index, 0);
146 zip_fread(zf, metafile, zs.size);
149 kf = g_key_file_new();
150 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
151 sr_dbg("Failed to parse metadata.");
155 if ((ret = sr_session_new(session)) != SR_OK)
159 capturefiles = g_ptr_array_new_with_free_func(g_free);
160 sections = g_key_file_get_groups(kf, NULL);
161 for (i = 0; sections[i] && ret == SR_OK; i++) {
162 if (!strcmp(sections[i], "global"))
163 /* nothing really interesting in here yet */
165 if (!strncmp(sections[i], "device ", 7)) {
168 enabled_channels = total_channels = 0;
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 = sr_dev_inst_new(SR_ST_ACTIVE, NULL, NULL, NULL);
174 sdi->driver = &session_driver;
175 if (!session_driver_initialized) {
176 /* first device, init the driver */
177 session_driver_initialized = 1;
178 sdi->driver->init(NULL);
181 sr_session_dev_add(*session, sdi);
182 (*session)->owned_devs = g_slist_append(
183 (*session)->owned_devs, sdi);
184 sdi->driver->config_set(SR_CONF_SESSIONFILE,
185 g_variant_new_string(filename), sdi, NULL);
186 sdi->driver->config_set(SR_CONF_CAPTUREFILE,
187 g_variant_new_string(val), sdi, NULL);
188 g_ptr_array_add(capturefiles, val);
189 } else if (!strcmp(keys[j], "samplerate")) {
194 sr_parse_sizestring(val, &tmp_u64);
195 sdi->driver->config_set(SR_CONF_SAMPLERATE,
196 g_variant_new_uint64(tmp_u64), sdi, NULL);
197 } else if (!strcmp(keys[j], "unitsize")) {
202 tmp_u64 = strtoull(val, NULL, 10);
203 sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
204 g_variant_new_uint64(tmp_u64), sdi, NULL);
205 } else if (!strcmp(keys[j], "total probes")) {
210 total_channels = strtoull(val, NULL, 10);
211 sdi->driver->config_set(SR_CONF_NUM_LOGIC_CHANNELS,
212 g_variant_new_uint64(total_channels), sdi, NULL);
213 for (p = 0; p < total_channels; p++) {
214 snprintf(channelname, SR_MAX_CHANNELNAME_LEN, "%" PRIu64, p);
215 if (!(ch = sr_channel_new(p, SR_CHANNEL_LOGIC, TRUE,
218 sdi->channels = g_slist_append(sdi->channels, ch);
220 } else if (!strncmp(keys[j], "probe", 5)) {
226 tmp_u64 = strtoul(keys[j]+5, NULL, 10);
227 /* sr_session_save() */
228 sr_dev_channel_name_set(sdi, tmp_u64 - 1, val);
232 /* Disable channels not specifically listed. */
234 for (p = enabled_channels; p < total_channels; p++)
235 sr_dev_channel_enable(sdi, p, FALSE);
238 g_strfreev(sections);
245 * Save a session to the specified file.
247 * @param session The session to save to the specified file. Must not be NULL.
248 * @param filename The name of the filename to save the session as.
250 * @param sdi The device instance from which the data was captured.
251 * @param buf The data to be saved.
252 * @param unitsize The number of bytes per sample.
253 * @param units The number of samples.
255 * @retval SR_OK Success
256 * @retval SR_ERR_ARG Invalid arguments
257 * @retval SR_ERR Other errors
261 SR_API int sr_session_save(struct sr_session *session, const char *filename,
262 const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize,
265 struct sr_channel *ch;
270 char **channel_names;
273 if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
274 if (sr_config_get(sdi->driver, sdi, NULL,
275 SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
276 samplerate = g_variant_get_uint64(gvar);
277 g_variant_unref(gvar);
281 channel_names = g_malloc0(sizeof(char *) * (g_slist_length(sdi->channels) + 1));
283 for (l = sdi->channels; l; l = l->next) {
285 if (ch->type != SR_CHANNEL_LOGIC)
287 if (ch->enabled != TRUE)
291 /* Just borrowing the ptr. */
292 channel_names[cnt++] = ch->name;
295 if ((ret = sr_session_save_init(session, filename, samplerate,
296 channel_names)) != SR_OK)
299 ret = sr_session_append(session, filename, buf, unitsize, units);
305 * Initialize a saved session file.
307 * @param session The session to use. Must not be NULL.
308 * @param filename The name of the filename to save the session as.
310 * @param samplerate The samplerate to store for this session.
311 * @param channels A NULL-terminated array of strings containing the names
312 * of all the channels active in this session.
314 * @retval SR_OK Success
315 * @retval SR_ERR_ARG Invalid arguments
316 * @retval SR_ERR Other errors
320 SR_API int sr_session_save_init(struct sr_session *session,
321 const char *filename, uint64_t samplerate, char **channels)
325 struct zip_source *versrc, *metasrc;
326 int tmpfile, cnt, ret, i;
327 char version[1], metafile[32], *s;
332 sr_err("%s: filename was NULL", __func__);
336 /* Quietly delete it first, libzip wants replace ops otherwise. */
338 if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
343 if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
345 if (zip_add(zipfile, "version", versrc) == -1) {
346 sr_info("error saving version into zipfile: %s",
347 zip_strerror(zipfile));
351 /* init "metadata" */
352 strcpy(metafile, "sigrok-meta-XXXXXX");
353 if ((tmpfile = g_mkstemp(metafile)) == -1)
356 meta = g_fopen(metafile, "wb");
357 fprintf(meta, "[global]\n");
358 fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
361 fprintf(meta, "[device 1]\n");
364 fprintf(meta, "capturefile = logic-1\n");
366 for (i = 0; channels[i]; i++)
368 fprintf(meta, "total probes = %d\n", cnt);
369 s = sr_samplerate_string(samplerate);
370 fprintf(meta, "samplerate = %s\n", s);
373 for (i = 0; channels[i]; i++)
374 fprintf(meta, "probe%d = %s\n", i + 1, channels[i]);
378 if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
382 if (zip_add(zipfile, "metadata", metasrc) == -1) {
387 if ((ret = zip_close(zipfile)) == -1) {
388 sr_info("error saving zipfile: %s", zip_strerror(zipfile));
399 * Append data to an existing session file.
401 * The session file must have been created with sr_session_save_init()
402 * or sr_session_save() beforehand.
404 * @param session The session to use. Must not be NULL.
405 * @param filename The name of the filename to append to. Must not be NULL.
406 * @param buf The data to be appended.
407 * @param unitsize The number of bytes per sample.
408 * @param units The number of samples.
410 * @retval SR_OK Success
411 * @retval SR_ERR_ARG Invalid arguments
412 * @retval SR_ERR Other errors
416 SR_API int sr_session_append(struct sr_session *session, const char *filename,
417 unsigned char *buf, int unitsize, int units)
420 struct zip_source *logicsrc;
421 zip_int64_t num_files;
424 struct zip_source *metasrc;
428 int chunk_num, next_chunk_num, tmpfile, ret, i;
429 const char *entry_name;
430 char *metafile, tmpname[32], chunkname[16];
434 if ((ret = sr_sessionfile_check(filename)) != SR_OK)
437 if (!(archive = zip_open(filename, 0, &ret)))
440 if (zip_stat(archive, "metadata", 0, &zs) == -1)
443 metafile = g_malloc(zs.size);
444 zf = zip_fopen_index(archive, zs.index, 0);
445 zip_fread(zf, metafile, zs.size);
449 * If the file was only initialized but doesn't yet have any
450 * data it in, it won't have a unitsize field in metadata yet.
453 kf = g_key_file_new();
454 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
455 sr_err("Failed to parse metadata: %s.", error->message);
460 if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
461 if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
462 sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
465 /* Add unitsize field. */
466 g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
467 metafile = g_key_file_to_data(kf, &len, &error);
468 strcpy(tmpname, "sigrok-meta-XXXXXX");
469 if ((tmpfile = g_mkstemp(tmpname)) == -1)
471 if (write(tmpfile, metafile, len) < 0) {
472 sr_dbg("Failed to create new metadata: %s", strerror(errno));
478 if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
479 sr_err("Failed to create zip source for metadata.");
484 if (zip_replace(archive, zs.index, metasrc) == -1) {
485 sr_err("Failed to replace metadata file.");
495 num_files = zip_get_num_entries(archive, 0);
496 for (i = 0; i < num_files; i++) {
497 entry_name = zip_get_name(archive, i, 0);
498 if (strncmp(entry_name, "logic-1", 7))
500 if (strlen(entry_name) == 7) {
501 /* This file has no extra chunks, just a single "logic-1".
502 * Rename it to "logic-1-1" * and continue with chunk 2. */
503 if (zip_rename(archive, i, "logic-1-1") == -1) {
504 sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
510 } else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
511 chunk_num = strtoull(entry_name + 8, NULL, 10);
512 if (chunk_num >= next_chunk_num)
513 next_chunk_num = chunk_num + 1;
516 snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
517 if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE))) {
521 if (zip_add(archive, chunkname, logicsrc) == -1) {
525 if ((ret = zip_close(archive)) == -1) {
526 sr_info("error saving session file: %s", zip_strerror(archive));