/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
*
- * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "config.h"
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <zip.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <errno.h>
#include <glib.h>
#include <glib/gstdio.h>
-#include <sigrok.h>
+#include "config.h" /* Needed for PACKAGE_VERSION and others. */
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
-extern struct session *session;
-extern struct sr_device_plugin session_driver;
+#define LOG_PREFIX "session-file"
+/**
+ * @file
+ *
+ * Loading and saving libsigrok session files.
+ */
+
+/**
+ * @addtogroup grp_session
+ *
+ * @{
+ */
+
+extern struct sr_session *session;
+extern SR_PRIV struct sr_dev_driver session_driver;
-int session_load(const char *filename)
+/** @private */
+SR_PRIV int sr_sessionfile_check(const char *filename)
{
- GKeyFile *kf;
- GPtrArray *capturefiles;
+ struct stat st;
struct zip *archive;
struct zip_file *zf;
struct zip_stat zs;
- struct session *session;
- struct sr_device *device;
- struct sr_probe *probe;
- int ret, err, probenum, devcnt, i, j;
- uint64_t tmp_u64, total_probes, enabled_probes, p;
- char **sections, **keys, *metafile, *val, c;
+ int version, ret;
+ char s[11];
- if (!(archive = zip_open(filename, 0, &err))) {
- g_debug("Failed to open session file: zip error %d", err);
+ if (!filename)
+ return SR_ERR_ARG;
+
+ if (stat(filename, &st) == -1) {
+ sr_err("Couldn't stat %s: %s", filename, strerror(errno));
return SR_ERR;
}
+ if (!(archive = zip_open(filename, 0, &ret)))
+ /* No logging: this can be used just to check if it's
+ * a sigrok session file or not. */
+ return SR_ERR;
+
/* check "version" */
+ version = 0;
if (!(zf = zip_fopen(archive, "version", 0))) {
- g_debug("Not a sigrok session file.");
+ sr_dbg("Not a sigrok session file: no version found.");
return SR_ERR;
}
- ret = zip_fread(zf, &c, 1);
- if (ret != 1 || c != '1') {
- g_debug("Not a valid sigrok session file.");
+ if ((ret = zip_fread(zf, s, 10)) == -1)
return SR_ERR;
- }
zip_fclose(zf);
+ s[ret] = 0;
+ version = strtoull(s, NULL, 10);
+ if (version > 2) {
+ sr_dbg("Cannot handle sigrok session file version %d.", version);
+ return SR_ERR;
+ }
+ sr_spew("Detected sigrok session file version %d.", version);
/* read "metadata" */
if (zip_stat(archive, "metadata", 0, &zs) == -1) {
- g_debug("Not a valid sigrok session file.");
+ sr_dbg("Not a valid sigrok session file.");
return SR_ERR;
}
- metafile = g_malloc(zs.size);
+
+ return SR_OK;
+}
+
+/**
+ * Load the session from the specified filename.
+ *
+ * @param filename The name of the session file to load. Must not be NULL.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
+ * SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
+ * other errors.
+ */
+SR_API int sr_session_load(const char *filename)
+{
+ GKeyFile *kf;
+ GPtrArray *capturefiles;
+ struct zip *archive;
+ struct zip_file *zf;
+ struct zip_stat zs;
+ struct sr_dev_inst *sdi;
+ struct sr_channel *ch;
+ int ret, channelnum, devcnt, i, j;
+ uint64_t tmp_u64, total_channels, enabled_channels, p;
+ char **sections, **keys, *metafile, *val;
+ char channelname[SR_MAX_PROBENAME_LEN + 1];
+
+ if ((ret = sr_sessionfile_check(filename)) != SR_OK)
+ return ret;
+
+ if (!(archive = zip_open(filename, 0, &ret)))
+ return SR_ERR;
+
+ if (zip_stat(archive, "metadata", 0, &zs) == -1)
+ return SR_ERR;
+
+ if (!(metafile = g_try_malloc(zs.size))) {
+ sr_err("%s: metafile malloc failed", __func__);
+ return SR_ERR_MALLOC;
+ }
+
zf = zip_fopen_index(archive, zs.index, 0);
zip_fread(zf, metafile, zs.size);
zip_fclose(zf);
kf = g_key_file_new();
if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
- g_debug("Failed to parse metadata.");
+ sr_dbg("Failed to parse metadata.");
return SR_ERR;
}
- session = session_new();
+ sr_session_new();
devcnt = 0;
capturefiles = g_ptr_array_new_with_free_func(g_free);
continue;
if (!strncmp(sections[i], "device ", 7)) {
/* device section */
- device = NULL;
- enabled_probes = 0;
+ sdi = NULL;
+ enabled_channels = total_channels = 0;
keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
for (j = 0; keys[j]; j++) {
val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
if (!strcmp(keys[j], "capturefile")) {
- device = device_new(&session_driver, devcnt, 0);
+ sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
+ sdi->driver = &session_driver;
if (devcnt == 0)
- /* first device, init the plugin */
- device->plugin->init((char *)filename);
- session_device_add(device);
- device->plugin->set_configuration(devcnt, SR_HWCAP_CAPTUREFILE, val);
+ /* first device, init the driver */
+ sdi->driver->init(NULL);
+ sr_dev_open(sdi);
+ sr_session_dev_add(sdi);
+ sdi->driver->config_set(SR_CONF_SESSIONFILE,
+ g_variant_new_string(filename), sdi, NULL);
+ sdi->driver->config_set(SR_CONF_CAPTUREFILE,
+ g_variant_new_string(val), sdi, NULL);
g_ptr_array_add(capturefiles, val);
} else if (!strcmp(keys[j], "samplerate")) {
- tmp_u64 = sr_parse_sizestring(val);
- device->plugin->set_configuration(devcnt, SR_HWCAP_SAMPLERATE, &tmp_u64);
+ sr_parse_sizestring(val, &tmp_u64);
+ sdi->driver->config_set(SR_CONF_SAMPLERATE,
+ g_variant_new_uint64(tmp_u64), sdi, NULL);
} else if (!strcmp(keys[j], "unitsize")) {
tmp_u64 = strtoull(val, NULL, 10);
- device->plugin->set_configuration(devcnt, SR_HWCAP_CAPTURE_UNITSIZE, &tmp_u64);
+ sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
+ g_variant_new_uint64(tmp_u64), sdi, NULL);
} else if (!strcmp(keys[j], "total probes")) {
- total_probes = strtoull(val, NULL, 10);
- device->plugin->set_configuration(devcnt, SR_HWCAP_CAPTURE_NUM_PROBES, &total_probes);
- for (p = 1; p <= total_probes; p++)
- device_probe_add(device, NULL);
+ total_channels = strtoull(val, NULL, 10);
+ sdi->driver->config_set(SR_CONF_NUM_LOGIC_PROBES,
+ g_variant_new_uint64(total_channels), sdi, NULL);
+ for (p = 0; p < total_channels; p++) {
+ snprintf(channelname, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
+ if (!(ch = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
+ channelname)))
+ return SR_ERR;
+ sdi->channels = g_slist_append(sdi->channels, ch);
+ }
} else if (!strncmp(keys[j], "probe", 5)) {
- if (!device)
+ if (!sdi)
continue;
- enabled_probes++;
+ enabled_channels++;
tmp_u64 = strtoul(keys[j]+5, NULL, 10);
- device_probe_name(device, tmp_u64, val);
+ /* sr_session_save() */
+ sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
} else if (!strncmp(keys[j], "trigger", 7)) {
- probenum = strtoul(keys[j]+7, NULL, 10);
- device_trigger_set(device, probenum, val);
+ channelnum = strtoul(keys[j]+7, NULL, 10);
+ sr_dev_trigger_set(sdi, channelnum, val);
}
}
g_strfreev(keys);
- for (p = enabled_probes; p < total_probes; p++) {
- probe = g_slist_nth_data(device->probes, p);
- probe->enabled = FALSE;
- }
+ /* Disable channels not specifically listed. */
+ if (total_channels)
+ for (p = enabled_channels; p < total_channels; p++)
+ sr_dev_probe_enable(sdi, p, FALSE);
}
+ devcnt++;
}
g_strfreev(sections);
g_key_file_free(kf);
return SR_OK;
}
-int session_save(char *filename)
+/**
+ * Save the current session to the specified file.
+ *
+ * @param filename The name of the filename to save the current session as.
+ * Must not be NULL.
+ * @param sdi The device instance from which the data was captured.
+ * @param buf The data to be saved.
+ * @param unitsize The number of bytes per sample.
+ * @param units The number of samples.
+ *
+ * @retval SR_OK Success
+ * @retval SR_ERR_ARG Invalid arguments
+ * @retval SR_ERR Other errors
+ */
+SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
+ unsigned char *buf, int unitsize, int units)
+{
+ struct sr_channel *ch;
+ GSList *l;
+ GVariant *gvar;
+ uint64_t samplerate;
+ int cnt, ret;
+ char **channel_names;
+
+ samplerate = 0;
+ if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
+ if (sr_config_get(sdi->driver, sdi, NULL,
+ SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
+ samplerate = g_variant_get_uint64(gvar);
+ g_variant_unref(gvar);
+ }
+ }
+
+ channel_names = g_malloc0(sizeof(char *) * (g_slist_length(sdi->channels) + 1));
+ cnt = 0;
+ for (l = sdi->channels; l; l = l->next) {
+ ch = l->data;
+ if (ch->type != SR_PROBE_LOGIC)
+ continue;
+ if (ch->enabled != TRUE)
+ continue;
+ if (!ch->name)
+ continue;
+ /* Just borrowing the ptr. */
+ channel_names[cnt++] = ch->name;
+ }
+
+ if ((ret = sr_session_save_init(filename, samplerate, channel_names)) != SR_OK)
+ return ret;
+
+ ret = sr_session_append(filename, buf, unitsize, units);
+
+ return ret;
+}
+
+/**
+ * Initialize a saved session file.
+ *
+ * @param filename The name of the filename to save the current session as.
+ * Must not be NULL.
+ * @param samplerate The samplerate to store for this session.
+ * @param channels A NULL-terminated array of strings containing the names
+ * of all the channels active in this session.
+ *
+ * @retval SR_OK Success
+ * @retval SR_ERR_ARG Invalid arguments
+ * @retval SR_ERR Other errors
+ */
+SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
+ char **channels)
{
- GSList *l, *p, *d;
FILE *meta;
- struct sr_device *device;
- struct sr_probe *probe;
- struct datastore *ds;
struct zip *zipfile;
- struct zip_source *versrc, *metasrc, *logicsrc;
- int bufcnt, devcnt, tmpfile, ret, error, probecnt;
- uint64_t samplerate;
- char version[1], rawname[16], metafile[32], *buf, *s;
+ struct zip_source *versrc, *metasrc;
+ int tmpfile, cnt, ret, i;
+ char version[1], metafile[32], *s;
+
+ if (!filename) {
+ sr_err("%s: filename was NULL", __func__);
+ return SR_ERR_ARG;
+ }
/* Quietly delete it first, libzip wants replace ops otherwise. */
unlink(filename);
- if (!(zipfile = zip_open(filename, ZIP_CREATE, &error)))
+ if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
return SR_ERR;
/* "version" */
- version[0] = '1';
+ version[0] = '2';
if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
return SR_ERR;
if (zip_add(zipfile, "version", versrc) == -1) {
- g_message("error saving version into zipfile: %s",
- zip_strerror(zipfile));
+ sr_info("error saving version into zipfile: %s",
+ zip_strerror(zipfile));
return SR_ERR;
}
meta = g_fopen(metafile, "wb");
fprintf(meta, "[global]\n");
fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
- /* TODO: save protocol decoders used */
-
- /* all datastores in all devices */
- devcnt = 1;
- for (l = session->devices; l; l = l->next) {
- device = l->data;
- /* metadata */
- fprintf(meta, "[device %d]\n", devcnt);
- if (device->plugin)
- fprintf(meta, "driver = %s\n", device->plugin->name);
-
- ds = device->datastore;
- if (ds) {
- /* metadata */
- fprintf(meta, "capturefile = logic-%d\n", devcnt);
- fprintf(meta, "unitsize = %d\n", ds->ds_unitsize);
- fprintf(meta, "total probes = %d\n", g_slist_length(device->probes));
- if (device_has_hwcap(device, SR_HWCAP_SAMPLERATE)) {
- samplerate = *((uint64_t *) device->plugin->get_device_info(
- device->plugin_index, SR_DI_CUR_SAMPLERATE));
- s = sr_samplerate_string(samplerate);
- fprintf(meta, "samplerate = %s\n", s);
- free(s);
- }
- probecnt = 1;
- for (p = device->probes; p; p = p->next) {
- probe = p->data;
- if (probe->enabled) {
- if (probe->name)
- fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
- if (probe->trigger)
- fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
- probecnt++;
- }
- }
- /* dump datastore into logic-n */
- buf = malloc(ds->num_units * ds->ds_unitsize +
- DATASTORE_CHUNKSIZE);
- bufcnt = 0;
- for (d = ds->chunklist; d; d = d->next) {
- memcpy(buf + bufcnt, d->data,
- DATASTORE_CHUNKSIZE);
- bufcnt += DATASTORE_CHUNKSIZE;
- }
- if (!(logicsrc = zip_source_buffer(zipfile, buf,
- ds->num_units * ds->ds_unitsize, TRUE)))
- return SR_ERR;
- snprintf(rawname, 15, "logic-%d", devcnt);
- if (zip_add(zipfile, rawname, logicsrc) == -1)
- return SR_ERR;
- }
- devcnt++;
- }
+ /* metadata */
+ fprintf(meta, "[device 1]\n");
+
+ /* metadata */
+ fprintf(meta, "capturefile = logic-1\n");
+ cnt = 0;
+ for (i = 0; channels[i]; i++)
+ cnt++;
+ fprintf(meta, "total probes = %d\n", cnt);
+ s = sr_samplerate_string(samplerate);
+ fprintf(meta, "samplerate = %s\n", s);
+ g_free(s);
+
+ for (i = 0; channels[i]; i++)
+ fprintf(meta, "probe%d = %s\n", i + 1, channels[i]);
+
fclose(meta);
- if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
+ if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
+ unlink(metafile);
return SR_ERR;
- if (zip_add(zipfile, "metadata", metasrc) == -1)
+ }
+ if (zip_add(zipfile, "metadata", metasrc) == -1) {
+ unlink(metafile);
return SR_ERR;
+ }
if ((ret = zip_close(zipfile)) == -1) {
- g_message("error saving zipfile: %s", zip_strerror(zipfile));
+ sr_info("error saving zipfile: %s", zip_strerror(zipfile));
+ unlink(metafile);
return SR_ERR;
}
return SR_OK;
}
+/**
+ * Append data to an existing session file.
+ *
+ * The session file must have been created with sr_session_save_init()
+ * or sr_session_save() beforehand.
+ *
+ * @param filename The name of the filename to append to. Must not be NULL.
+ * @param buf The data to be appended.
+ * @param unitsize The number of bytes per sample.
+ * @param units The number of samples.
+ *
+ * @retval SR_OK Success
+ * @retval SR_ERR_ARG Invalid arguments
+ * @retval SR_ERR Other errors
+ */
+SR_API int sr_session_append(const char *filename, unsigned char *buf,
+ int unitsize, int units)
+{
+ struct zip *archive;
+ struct zip_source *logicsrc;
+ zip_int64_t num_files;
+ struct zip_file *zf;
+ struct zip_stat zs;
+ struct zip_source *metasrc;
+ GKeyFile *kf;
+ GError *error;
+ gsize len;
+ int chunk_num, next_chunk_num, tmpfile, ret, i;
+ const char *entry_name;
+ char *metafile, tmpname[32], chunkname[16];
+
+ if ((ret = sr_sessionfile_check(filename)) != SR_OK)
+ return ret;
+
+ if (!(archive = zip_open(filename, 0, &ret)))
+ return SR_ERR;
+
+ if (zip_stat(archive, "metadata", 0, &zs) == -1)
+ return SR_ERR;
+
+ metafile = g_malloc(zs.size);
+ zf = zip_fopen_index(archive, zs.index, 0);
+ zip_fread(zf, metafile, zs.size);
+ zip_fclose(zf);
+
+ /*
+ * If the file was only initialized but doesn't yet have any
+ * data it in, it won't have a unitsize field in metadata yet.
+ */
+ error = NULL;
+ kf = g_key_file_new();
+ if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
+ sr_err("Failed to parse metadata: %s.", error->message);
+ return SR_ERR;
+ }
+ g_free(metafile);
+ tmpname[0] = '\0';
+ if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
+ if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
+ sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
+ return SR_ERR;
+ }
+ /* Add unitsize field. */
+ g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
+ metafile = g_key_file_to_data(kf, &len, &error);
+ strcpy(tmpname, "sigrok-meta-XXXXXX");
+ if ((tmpfile = g_mkstemp(tmpname)) == -1)
+ return SR_ERR;
+ if (write(tmpfile, metafile, len) < 0) {
+ sr_dbg("Failed to create new metadata: %s", strerror(errno));
+ g_free(metafile);
+ unlink(tmpname);
+ return SR_ERR;
+ }
+ close(tmpfile);
+ if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
+ sr_err("Failed to create zip source for metadata.");
+ g_free(metafile);
+ unlink(tmpname);
+ return SR_ERR;
+ }
+ if (zip_replace(archive, zs.index, metasrc) == -1) {
+ sr_err("Failed to replace metadata file.");
+ g_free(metafile);
+ unlink(tmpname);
+ return SR_ERR;
+ }
+ g_free(metafile);
+ }
+ g_key_file_free(kf);
+
+ next_chunk_num = 1;
+ num_files = zip_get_num_entries(archive, 0);
+ for (i = 0; i < num_files; i++) {
+ entry_name = zip_get_name(archive, i, 0);
+ if (strncmp(entry_name, "logic-1", 7))
+ continue;
+ if (strlen(entry_name) == 7) {
+ /* This file has no extra chunks, just a single "logic-1".
+ * Rename it to "logic-1-1" * and continue with chunk 2. */
+ if (zip_rename(archive, i, "logic-1-1") == -1) {
+ sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
+ unlink(tmpname);
+ return SR_ERR;
+ }
+ next_chunk_num = 2;
+ break;
+ } else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
+ chunk_num = strtoull(entry_name + 8, NULL, 10);
+ if (chunk_num >= next_chunk_num)
+ next_chunk_num = chunk_num + 1;
+ }
+ }
+ snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
+ if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE))) {
+ unlink(tmpname);
+ return SR_ERR;
+ }
+ if (zip_add(archive, chunkname, logicsrc) == -1) {
+ unlink(tmpname);
+ return SR_ERR;
+ }
+ if ((ret = zip_close(archive)) == -1) {
+ sr_info("error saving session file: %s", zip_strerror(archive));
+ unlink(tmpname);
+ return SR_ERR;
+ }
+ unlink(tmpname);
+
+ return SR_OK;
+}
+
+/** @} */
projects / libsigrok.git / blobdiff