2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 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 <glib/gstdio.h>
27 #include "libsigrok.h"
28 #include "libsigrok-internal.h"
30 extern struct sr_session *session;
31 extern SR_PRIV struct sr_dev_driver session_driver;
34 * Load the session from the specified filename.
36 * @param filename The name of the session file to load. Must not be NULL.
38 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
39 * SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
42 SR_API int sr_session_load(const char *filename)
45 GPtrArray *capturefiles;
49 struct sr_dev_inst *sdi;
50 struct sr_probe *probe;
51 int ret, probenum, devcnt, version, i, j;
52 uint64_t tmp_u64, total_probes, enabled_probes, p;
53 char **sections, **keys, *metafile, *val, s[11];
54 char probename[SR_MAX_PROBENAME_LEN + 1];
57 sr_err("session file: %s: filename was NULL", __func__);
61 if (!(archive = zip_open(filename, 0, &ret))) {
62 sr_dbg("session file: Failed to open session file: zip "
69 if (!(zf = zip_fopen(archive, "version", 0))) {
70 sr_dbg("session file: Not a sigrok session file.");
73 if ((ret = zip_fread(zf, s, 10)) == -1) {
74 sr_dbg("session file: Not a valid sigrok session file.");
79 version = strtoull(s, NULL, 10);
81 sr_dbg("session file: Not a valid sigrok session file version.");
86 if (zip_stat(archive, "metadata", 0, &zs) == -1) {
87 sr_dbg("session file: Not a valid sigrok session file.");
91 if (!(metafile = g_try_malloc(zs.size))) {
92 sr_err("session file: %s: metafile malloc failed", __func__);
96 zf = zip_fopen_index(archive, zs.index, 0);
97 zip_fread(zf, metafile, zs.size);
100 kf = g_key_file_new();
101 if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
102 sr_dbg("session file: Failed to parse metadata.");
109 capturefiles = g_ptr_array_new_with_free_func(g_free);
110 sections = g_key_file_get_groups(kf, NULL);
111 for (i = 0; sections[i]; i++) {
112 if (!strcmp(sections[i], "global"))
113 /* nothing really interesting in here yet */
115 if (!strncmp(sections[i], "device ", 7)) {
119 keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
120 for (j = 0; keys[j]; j++) {
121 val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
122 if (!strcmp(keys[j], "capturefile")) {
123 sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
124 sdi->driver = &session_driver;
126 /* first device, init the driver */
128 sr_session_dev_add(sdi);
129 sdi->driver->dev_config_set(sdi, SR_HWCAP_SESSIONFILE, filename);
130 sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTUREFILE, val);
131 g_ptr_array_add(capturefiles, val);
132 } else if (!strcmp(keys[j], "samplerate")) {
133 sr_parse_sizestring(val, &tmp_u64);
134 sdi->driver->dev_config_set(sdi, SR_HWCAP_SAMPLERATE, &tmp_u64);
135 } else if (!strcmp(keys[j], "unitsize")) {
136 tmp_u64 = strtoull(val, NULL, 10);
137 sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTURE_UNITSIZE, &tmp_u64);
138 } else if (!strcmp(keys[j], "total probes")) {
139 total_probes = strtoull(val, NULL, 10);
140 sdi->driver->dev_config_set(sdi, SR_HWCAP_CAPTURE_NUM_PROBES, &total_probes);
141 for (p = 0; p < total_probes; p++) {
142 snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
143 if (!(probe = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
146 sdi->probes = g_slist_append(sdi->probes, probe);
148 } else if (!strncmp(keys[j], "probe", 5)) {
152 tmp_u64 = strtoul(keys[j]+5, NULL, 10);
153 /* sr_session_save() */
154 sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
155 } else if (!strncmp(keys[j], "trigger", 7)) {
156 probenum = strtoul(keys[j]+7, NULL, 10);
157 sr_dev_trigger_set(sdi, probenum, val);
161 /* Disable probes not specifically listed. */
162 for (p = enabled_probes; p < total_probes; p++)
163 sr_dev_probe_enable(sdi, p, FALSE);
167 g_strfreev(sections);
174 * Save the current session to the specified file.
176 * @param filename The name of the file where to save the current session.
178 * @param sdi The device instance from which the data was captured.
179 * @param ds The datastore where the session's captured data was stored.
181 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
184 SR_API int sr_session_save(const char *filename,
185 const struct sr_dev_inst *sdi, struct sr_datastore *ds)
189 struct sr_probe *probe;
191 struct zip_source *versrc, *metasrc, *logicsrc;
192 int bufcnt, tmpfile, ret, probecnt;
193 uint64_t *samplerate;
194 char version[1], rawname[16], metafile[32], *buf, *s;
197 sr_err("session file: %s: filename was NULL", __func__);
201 /* Quietly delete it first, libzip wants replace ops otherwise. */
203 if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
208 if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
210 if (zip_add(zipfile, "version", versrc) == -1) {
211 sr_info("session file: error saving version into zipfile: %s",
212 zip_strerror(zipfile));
216 /* init "metadata" */
217 strcpy(metafile, "sigrok-meta-XXXXXX");
218 if ((tmpfile = g_mkstemp(metafile)) == -1)
221 meta = g_fopen(metafile, "wb");
222 fprintf(meta, "[global]\n");
223 fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
226 fprintf(meta, "[device 1]\n");
228 fprintf(meta, "driver = %s\n", sdi->driver->name);
231 fprintf(meta, "capturefile = logic-1\n");
232 fprintf(meta, "unitsize = %d\n", ds->ds_unitsize);
233 fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
234 if (sr_dev_has_hwcap(sdi, SR_HWCAP_SAMPLERATE)) {
235 if (sr_info_get(sdi->driver, SR_DI_CUR_SAMPLERATE,
236 (const void **)&samplerate, sdi) == SR_OK) {
237 s = sr_samplerate_string(*samplerate);
238 fprintf(meta, "samplerate = %s\n", s);
243 for (l = sdi->probes; l; l = l->next) {
245 if (probe->enabled) {
247 fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
249 fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
254 /* dump datastore into logic-n */
255 buf = g_try_malloc(ds->num_units * ds->ds_unitsize +
256 DATASTORE_CHUNKSIZE);
258 sr_err("session file: %s: buf malloc failed",
260 return SR_ERR_MALLOC;
264 for (d = ds->chunklist; d; d = d->next) {
265 memcpy(buf + bufcnt, d->data,
266 DATASTORE_CHUNKSIZE);
267 bufcnt += DATASTORE_CHUNKSIZE;
269 if (!(logicsrc = zip_source_buffer(zipfile, buf,
270 ds->num_units * ds->ds_unitsize, TRUE)))
272 snprintf(rawname, 15, "logic-1");
273 if (zip_add(zipfile, rawname, logicsrc) == -1)
277 if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
279 if (zip_add(zipfile, "metadata", metasrc) == -1)
282 if ((ret = zip_close(zipfile)) == -1) {
283 sr_info("session file: error saving zipfile: %s",
284 zip_strerror(zipfile));