#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>
extern SR_PRIV struct sr_dev_driver session_driver;
static int session_driver_initialized = 0;
+/** Read metadata entries from a session archive.
+ * @param[in] archive An open ZIP archive.
+ * @param[in] entry Stat buffer filled in for the metadata archive member.
+ * @return A new key/value store containing the session metadata.
+ */
+SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
+ const struct zip_stat *entry)
+{
+ GKeyFile *keyfile;
+ GError *error;
+ struct zip_file *zf;
+ char *metabuf;
+ int metalen;
+
+ if (entry->size > G_MAXINT || !(metabuf = g_try_malloc(entry->size))) {
+ sr_err("Metadata buffer allocation failed.");
+ return NULL;
+ }
+ zf = zip_fopen_index(archive, entry->index, 0);
+ if (!zf) {
+ sr_err("Failed to open metadata: %s", zip_strerror(archive));
+ g_free(metabuf);
+ return NULL;
+ }
+ metalen = zip_fread(zf, metabuf, entry->size);
+ if (metalen < 0) {
+ sr_err("Failed to read metadata: %s", zip_file_strerror(zf));
+ zip_fclose(zf);
+ g_free(metabuf);
+ return NULL;
+ }
+ zip_fclose(zf);
+
+ keyfile = g_key_file_new();
+ error = NULL;
+ g_key_file_load_from_data(keyfile, metabuf, metalen,
+ G_KEY_FILE_NONE, &error);
+ g_free(metabuf);
+
+ if (error) {
+ sr_err("Failed to parse metadata: %s", error->message);
+ g_error_free(error);
+ g_key_file_free(keyfile);
+ return NULL;
+ }
+ return keyfile;
+}
+
/** @private */
SR_PRIV int sr_sessionfile_check(const char *filename)
{
- struct stat st;
struct zip *archive;
struct zip_file *zf;
struct zip_stat zs;
- int version, ret;
+ uint64_t version;
+ int ret;
char s[11];
if (!filename)
return SR_ERR_ARG;
- if (stat(filename, &st) == -1) {
- sr_err("Couldn't stat %s: %s", filename, g_strerror(errno));
+ if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) {
+ sr_err("Not a regular file: %s.", filename);
return SR_ERR;
}
- if (!(archive = zip_open(filename, 0, &ret)))
+ if (!(archive = zip_open(filename, 0, NULL)))
/* No logging: this can be used just to check if it's
* a sigrok session file or not. */
return SR_ERR;
/* check "version" */
if (!(zf = zip_fopen(archive, "version", 0))) {
sr_dbg("Not a sigrok session file: no version found.");
+ zip_discard(archive);
return SR_ERR;
}
- if ((ret = zip_fread(zf, s, 10)) == -1)
+ ret = zip_fread(zf, s, sizeof(s) - 1);
+ if (ret < 0) {
+ sr_err("Failed to read version file: %s",
+ zip_file_strerror(zf));
+ zip_fclose(zf);
+ zip_discard(archive);
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);
+ s[ret] = '\0';
+ version = g_ascii_strtoull(s, NULL, 10);
+ if (version == 0 || version > 2) {
+ sr_dbg("Cannot handle sigrok session file version %" PRIu64 ".",
+ version);
+ zip_discard(archive);
return SR_ERR;
}
- sr_spew("Detected sigrok session file version %d.", version);
+ sr_spew("Detected sigrok session file version %" PRIu64 ".", version);
/* read "metadata" */
- if (zip_stat(archive, "metadata", 0, &zs) == -1) {
+ if (zip_stat(archive, "metadata", 0, &zs) < 0) {
sr_dbg("Not a valid sigrok session file.");
+ zip_discard(archive);
return SR_ERR;
}
-
- if ((ret = zip_close(archive)) == -1) {
- sr_dbg("error closing zipfile: %s", zip_strerror(archive));
- return SR_ERR;
- }
+ zip_discard(archive);
return SR_OK;
}
struct sr_session **session)
{
GKeyFile *kf;
- GPtrArray *capturefiles;
+ GError *error;
struct zip *archive;
- struct zip_file *zf;
struct zip_stat zs;
struct sr_dev_inst *sdi;
struct sr_channel *ch;
int ret, i, j;
- uint64_t tmp_u64, total_channels, p;
- char **sections, **keys, *metafile, *val;
+ uint64_t tmp_u64;
+ int total_channels, k;
+ int unitsize;
+ char **sections, **keys, *val;
char channelname[SR_MAX_CHANNELNAME_LEN + 1];
if ((ret = sr_sessionfile_check(filename)) != SR_OK)
return ret;
- if (!(archive = zip_open(filename, 0, &ret)))
+ if (!(archive = zip_open(filename, 0, NULL)))
return SR_ERR;
- if (zip_stat(archive, "metadata", 0, &zs) == -1)
+ if (zip_stat(archive, "metadata", 0, &zs) < 0) {
+ zip_discard(archive);
return SR_ERR;
-
- if (!(metafile = g_try_malloc(zs.size))) {
- sr_err("%s: metafile malloc failed", __func__);
- return SR_ERR_MALLOC;
}
+ kf = sr_sessionfile_read_metadata(archive, &zs);
+ zip_discard(archive);
+ if (!kf)
+ return SR_ERR_DATA;
- 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)) {
- sr_dbg("Failed to parse metadata.");
- return SR_ERR;
- }
-
- if ((ret = sr_session_new(ctx, session)) != SR_OK)
+ if ((ret = sr_session_new(ctx, session)) != SR_OK) {
+ g_key_file_free(kf);
return ret;
+ }
+ error = NULL;
ret = SR_OK;
- capturefiles = g_ptr_array_new_with_free_func(g_free);
sections = g_key_file_get_groups(kf, NULL);
for (i = 0; sections[i] && ret == SR_OK; i++) {
if (!strcmp(sections[i], "global"))
sdi = NULL;
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")) {
+ val = g_key_file_get_string(kf, sections[i],
+ keys[j], &error);
+ if (!val) {
+ ret = SR_ERR_DATA;
+ break;
+ }
sdi = g_malloc0(sizeof(struct sr_dev_inst));
sdi->driver = &session_driver;
sdi->status = SR_ST_ACTIVE;
sr_session_dev_add(*session, sdi);
(*session)->owned_devs = g_slist_append(
(*session)->owned_devs, 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);
+ sr_config_set(sdi, NULL, SR_CONF_SESSIONFILE,
+ g_variant_new_string(filename));
+ sr_config_set(sdi, NULL, SR_CONF_CAPTUREFILE,
+ g_variant_new_string(val));
+ g_free(val);
} else if (!strcmp(keys[j], "samplerate")) {
- if (!sdi) {
+ val = g_key_file_get_string(kf, sections[i],
+ keys[j], &error);
+ if (!sdi || !val || sr_parse_sizestring(val,
+ &tmp_u64) != SR_OK) {
+ g_free(val);
ret = SR_ERR_DATA;
break;
}
- sr_parse_sizestring(val, &tmp_u64);
- sdi->driver->config_set(SR_CONF_SAMPLERATE,
- g_variant_new_uint64(tmp_u64), sdi, NULL);
+ g_free(val);
+ sr_config_set(sdi, NULL, SR_CONF_SAMPLERATE,
+ g_variant_new_uint64(tmp_u64));
} else if (!strcmp(keys[j], "unitsize")) {
- if (!sdi) {
+ unitsize = g_key_file_get_integer(kf, sections[i],
+ keys[j], &error);
+ if (!sdi || unitsize <= 0 || error) {
ret = SR_ERR_DATA;
break;
}
- tmp_u64 = strtoull(val, NULL, 10);
- sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
- g_variant_new_uint64(tmp_u64), sdi, NULL);
+ sr_config_set(sdi, NULL, SR_CONF_CAPTURE_UNITSIZE,
+ g_variant_new_uint64(unitsize));
} else if (!strcmp(keys[j], "total probes")) {
- if (!sdi) {
+ total_channels = g_key_file_get_integer(kf,
+ sections[i], keys[j], &error);
+ if (!sdi || total_channels < 0 || error) {
ret = SR_ERR_DATA;
break;
}
- total_channels = strtoull(val, NULL, 10);
- sdi->driver->config_set(SR_CONF_NUM_LOGIC_CHANNELS,
- g_variant_new_uint64(total_channels), sdi, NULL);
- for (p = 0; p < total_channels; p++) {
- snprintf(channelname, SR_MAX_CHANNELNAME_LEN, "%" PRIu64, p);
- sr_channel_new(sdi, p, SR_CHANNEL_LOGIC, FALSE,
- channelname);
+ sr_config_set(sdi, NULL, SR_CONF_NUM_LOGIC_CHANNELS,
+ g_variant_new_uint64(total_channels));
+ for (k = 0; k < total_channels; k++) {
+ g_snprintf(channelname, sizeof channelname,
+ "%d", k);
+ sr_channel_new(sdi, k, SR_CHANNEL_LOGIC,
+ FALSE, channelname);
}
} else if (!strncmp(keys[j], "probe", 5)) {
- if (!sdi) {
+ tmp_u64 = g_ascii_strtoull(keys[j]+5, NULL, 10);
+ if (!sdi || tmp_u64 == 0 || tmp_u64 > G_MAXINT) {
+ ret = SR_ERR_DATA;
+ break;
+ }
+ ch = g_slist_nth_data(sdi->channels, tmp_u64 - 1);
+ if (!ch) {
+ ret = SR_ERR_DATA;
+ break;
+ }
+ val = g_key_file_get_string(kf, sections[i],
+ keys[j], &error);
+ if (!val) {
ret = SR_ERR_DATA;
break;
}
- tmp_u64 = strtoul(keys[j]+5, NULL, 10) - 1;
- ch = g_slist_nth_data(sdi->channels, tmp_u64);
/* sr_session_save() */
sr_dev_channel_name_set(ch, val);
+ g_free(val);
sr_dev_channel_enable(ch, TRUE);
}
}
g_strfreev(sections);
g_key_file_free(kf);
- return ret;
-}
-
-/**
- * Save a session to the specified file.
- *
- * @param session The session to save to the specified file. Must not be NULL.
- * @param filename The name of the filename to save the 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
- *
- * @since 0.2.0
- */
-SR_API int sr_session_save(struct sr_session *session, 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_CHANNEL_LOGIC)
- continue;
- if (ch->enabled != TRUE)
- continue;
- if (!ch->name)
- continue;
- /* Just borrowing the ptr. */
- channel_names[cnt++] = ch->name;
+ if (error) {
+ sr_err("Failed to parse metadata: %s", error->message);
+ g_error_free(error);
}
-
- if ((ret = sr_session_save_init(session, filename, samplerate,
- channel_names)) != SR_OK)
- return ret;
-
- ret = sr_session_append(session, filename, buf, unitsize, units);
-
return ret;
}
-/**
- * Initialize a saved session file.
- *
- * @param session The session to use. Must not be NULL.
- * @param filename The name of the filename to save the 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
- *
- * @since 0.3.0
- */
-SR_API int sr_session_save_init(struct sr_session *session,
- const char *filename, uint64_t samplerate, char **channels)
-{
- FILE *meta;
- struct zip *zipfile;
- struct zip_source *versrc, *metasrc;
- int tmpfile, cnt, ret, i;
- char version[1], metafile[32], *s;
-
- (void)session;
-
- 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, &ret)))
- return SR_ERR;
-
- /* "version" */
- version[0] = '2';
- if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
- return SR_ERR;
- if (zip_add(zipfile, "version", versrc) == -1) {
- sr_info("error saving version into zipfile: %s",
- zip_strerror(zipfile));
- return SR_ERR;
- }
-
- /* init "metadata" */
- strcpy(metafile, "sigrok-meta-XXXXXX");
- if ((tmpfile = g_mkstemp(metafile)) == -1)
- return SR_ERR;
- close(tmpfile);
- meta = g_fopen(metafile, "wb");
- fprintf(meta, "[global]\n");
- fprintf(meta, "sigrok version = %s\n", SR_PACKAGE_VERSION_STRING);
-
- /* 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))) {
- unlink(metafile);
- return SR_ERR;
- }
- if (zip_add(zipfile, "metadata", metasrc) == -1) {
- unlink(metafile);
- return SR_ERR;
- }
-
- if ((ret = zip_close(zipfile)) == -1) {
- sr_info("error saving zipfile: %s", zip_strerror(zipfile));
- unlink(metafile);
- return SR_ERR;
- }
-
- unlink(metafile);
-
- 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 session The session to use. Must not be NULL.
- * @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
- *
- * @since 0.3.0
- */
-SR_API int sr_session_append(struct sr_session *session, 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];
-
- (void)session;
-
- 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", g_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 / commitdiff