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/>.
26 #include <glib/gstdio.h>
27 #include <libsigrok/libsigrok.h>
28 #include "libsigrok-internal.h"
31 #define LOG_PREFIX "session-file"
37 * Loading and saving libsigrok session files.
41 * @addtogroup grp_session
46 extern SR_PRIV struct sr_dev_driver session_driver;
47 static int session_driver_initialized = 0;
50 /* Replacement for zip_discard() if it isn't available.
52 SR_PRIV void sr_zip_discard(struct zip *archive)
54 if (zip_unchange_all(archive) < 0 || zip_close(archive) < 0)
55 sr_err("Failed to discard ZIP archive: %s", zip_strerror(archive));
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.
64 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
65 const struct zip_stat *entry)
73 if (entry->size > G_MAXINT || !(metabuf = g_try_malloc(entry->size))) {
74 sr_err("Metadata buffer allocation failed.");
77 zf = zip_fopen_index(archive, entry->index, 0);
79 sr_err("Failed to open metadata: %s", zip_strerror(archive));
83 metalen = zip_fread(zf, metabuf, entry->size);
85 sr_err("Failed to read metadata: %s", zip_file_strerror(zf));
92 keyfile = g_key_file_new();
94 g_key_file_load_from_data(keyfile, metabuf, metalen,
95 G_KEY_FILE_NONE, &error);
99 sr_err("Failed to parse metadata: %s", error->message);
101 g_key_file_free(keyfile);
108 SR_PRIV int sr_sessionfile_check(const char *filename)
120 if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) {
121 sr_err("Not a regular file: %s.", filename);
125 if (!(archive = zip_open(filename, 0, NULL)))
126 /* No logging: this can be used just to check if it's
127 * a sigrok session file or not. */
130 /* check "version" */
131 if (!(zf = zip_fopen(archive, "version", 0))) {
132 sr_dbg("Not a sigrok session file: no version found.");
133 zip_discard(archive);
136 ret = zip_fread(zf, s, sizeof(s) - 1);
138 sr_err("Failed to read version file: %s",
139 zip_file_strerror(zf));
141 zip_discard(archive);
146 version = g_ascii_strtoull(s, NULL, 10);
147 if (version == 0 || version > 2) {
148 sr_dbg("Cannot handle sigrok session file version %" PRIu64 ".",
150 zip_discard(archive);
153 sr_spew("Detected sigrok session file version %" PRIu64 ".", version);
155 /* read "metadata" */
156 if (zip_stat(archive, "metadata", 0, &zs) < 0) {
157 sr_dbg("Not a valid sigrok session file.");
158 zip_discard(archive);
161 zip_discard(archive);
166 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename, struct sr_session **session)
168 struct sr_dev_inst *sdi = NULL;
170 sdi = g_malloc0(sizeof(struct sr_dev_inst));
171 sdi->driver = &session_driver;
172 sdi->status = SR_ST_ACTIVE;
173 if (!session_driver_initialized) {
174 /* first device, init the driver */
175 session_driver_initialized = 1;
176 sdi->driver->init(sdi->driver, NULL);
179 sr_session_dev_add(*session, sdi);
180 (*session)->owned_devs = g_slist_append((*session)->owned_devs, sdi);
181 sr_config_set(sdi, NULL, SR_CONF_SESSIONFILE,
182 g_variant_new_string(filename));
188 * Load the session from the specified filename.
190 * @param ctx The context in which to load the session.
191 * @param filename The name of the session file to load.
192 * @param session The session to load the file into.
194 * @retval SR_OK Success
195 * @retval SR_ERR_MALLOC Memory allocation error
196 * @retval SR_ERR_DATA Malformed session file
197 * @retval SR_ERR This is not a session file
199 SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
200 struct sr_session **session)
206 struct sr_dev_inst *sdi;
207 struct sr_channel *ch;
210 int total_channels, total_analog, k;
213 char **sections, **keys, *val;
214 char channelname[SR_MAX_CHANNELNAME_LEN + 1];
215 gboolean file_has_logic;
217 if ((ret = sr_sessionfile_check(filename)) != SR_OK)
220 if (!(archive = zip_open(filename, 0, NULL)))
223 if (zip_stat(archive, "metadata", 0, &zs) < 0) {
224 zip_discard(archive);
227 kf = sr_sessionfile_read_metadata(archive, &zs);
228 zip_discard(archive);
232 if ((ret = sr_session_new(ctx, session)) != SR_OK) {
241 file_has_logic = FALSE;
242 sections = g_key_file_get_groups(kf, NULL);
243 for (i = 0; sections[i] && ret == SR_OK; i++) {
244 if (!strcmp(sections[i], "global"))
245 /* nothing really interesting in here yet */
247 if (!strncmp(sections[i], "device ", 7)) {
250 keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
252 /* File contains analog data if there are analog channels. */
253 total_analog = g_key_file_get_integer(kf, sections[i],
254 "total analog", &error);
255 if (total_analog > 0 && !error)
256 sdi = sr_session_prepare_sdi(filename, session);
257 g_clear_error(&error);
259 /* File contains logic data if a capturefile is set. */
260 val = g_key_file_get_string(kf, sections[i],
261 "capturefile", &error);
264 sdi = sr_session_prepare_sdi(filename, session);
265 sr_config_set(sdi, NULL, SR_CONF_CAPTUREFILE,
266 g_variant_new_string(val));
268 file_has_logic = TRUE;
270 g_clear_error(&error);
272 for (j = 0; keys[j]; j++) {
273 if (!strcmp(keys[j], "samplerate")) {
274 val = g_key_file_get_string(kf, sections[i],
276 if (!sdi || !val || sr_parse_sizestring(val,
277 &tmp_u64) != SR_OK) {
283 sr_config_set(sdi, NULL, SR_CONF_SAMPLERATE,
284 g_variant_new_uint64(tmp_u64));
285 } else if (!strcmp(keys[j], "unitsize") && file_has_logic) {
286 unitsize = g_key_file_get_integer(kf, sections[i],
288 if (!sdi || unitsize <= 0 || error) {
292 sr_config_set(sdi, NULL, SR_CONF_CAPTURE_UNITSIZE,
293 g_variant_new_uint64(unitsize));
294 } else if (!strcmp(keys[j], "total probes")) {
295 total_channels = g_key_file_get_integer(kf,
296 sections[i], keys[j], &error);
297 if (!sdi || total_channels < 0 || error) {
301 sr_config_set(sdi, NULL, SR_CONF_NUM_LOGIC_CHANNELS,
302 g_variant_new_int32(total_channels));
303 for (k = 0; k < total_channels; k++) {
304 g_snprintf(channelname, sizeof(channelname),
306 sr_channel_new(sdi, k, SR_CHANNEL_LOGIC,
309 } else if (!strcmp(keys[j], "total analog")) {
310 total_analog = g_key_file_get_integer(kf,
311 sections[i], keys[j], &error);
312 if (!sdi || total_analog < 0 || error) {
316 sr_config_set(sdi, NULL, SR_CONF_NUM_ANALOG_CHANNELS,
317 g_variant_new_int32(total_analog));
318 for (k = total_channels; k < (total_channels + total_analog); k++) {
319 g_snprintf(channelname, sizeof(channelname),
321 sr_channel_new(sdi, k, SR_CHANNEL_ANALOG,
324 } else if (!strncmp(keys[j], "probe", 5)) {
325 tmp_u64 = g_ascii_strtoull(keys[j] + 5, NULL, 10);
326 if (!sdi || tmp_u64 == 0 || tmp_u64 > G_MAXINT) {
330 ch = g_slist_nth_data(sdi->channels, tmp_u64 - 1);
335 val = g_key_file_get_string(kf, sections[i],
341 /* sr_session_save() */
342 sr_dev_channel_name_set(ch, val);
344 sr_dev_channel_enable(ch, TRUE);
345 } else if (!strncmp(keys[j], "analog", 6)) {
346 tmp_u64 = g_ascii_strtoull(keys[j]+6, NULL, 10);
347 if (!sdi || tmp_u64 == 0 || tmp_u64 > G_MAXINT) {
352 for (l = sdi->channels; l; l = l->next) {
354 if ((guint64)ch->index == tmp_u64 - 1)
363 val = g_key_file_get_string(kf, sections[i],
369 /* sr_session_save() */
370 sr_dev_channel_name_set(ch, val);
372 sr_dev_channel_enable(ch, TRUE);
378 g_strfreev(sections);
382 sr_err("Failed to parse metadata: %s", error->message);