session_file.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 #include <string.h>
  21 #include <stdlib.h>
  22 #include <unistd.h>
  23 #include <zip.h>
  24 #include <glib.h>
  25 #include <glib/gstdio.h>
  26 #include "config.h" /* Needed for PACKAGE_VERSION and others. */
  27 #include "libsigrok.h"
  28 #include "libsigrok-internal.h"
  29
  30 /* Message logging helpers with driver-specific prefix string. */
  31 #define DRIVER_LOG_DOMAIN "session-file: "
  32 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  33 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  34 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  35 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  36 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  37 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  38
  39 /**
  40  * @file
  41  *
  42  * Loading and saving libsigrok session files.
  43  */
  44
  45 /**
  46  * @addtogroup grp_session
  47  *
  48  * @{
  49  */
  50
  51 extern struct sr_session *session;
  52 extern SR_PRIV struct sr_dev_driver session_driver;
  53
  54 /**
  55  * Load the session from the specified filename.
  56  *
  57  * @param filename The name of the session file to load. Must not be NULL.
  58  *
  59  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
  60  *         SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
  61  *         other errors.
  62  */
  63 SR_API int sr_session_load(const char *filename)
  64 {
  65         GKeyFile *kf;
  66         GPtrArray *capturefiles;
  67         struct zip *archive;
  68         struct zip_file *zf;
  69         struct zip_stat zs;
  70         struct sr_dev_inst *sdi;
  71         struct sr_probe *probe;
  72         int ret, probenum, devcnt, version, i, j;
  73         uint64_t tmp_u64, total_probes, enabled_probes, p;
  74         char **sections, **keys, *metafile, *val, s[11];
  75         char probename[SR_MAX_PROBENAME_LEN + 1];
  76
  77         if (!filename) {
  78                 sr_err("%s: filename was NULL", __func__);
  79                 return SR_ERR_ARG;
  80         }
  81
  82         if (!(archive = zip_open(filename, 0, &ret))) {
  83                 sr_dbg("Failed to open session file: zip error %d", ret);
  84                 return SR_ERR;
  85         }
  86
  87         /* check "version" */
  88         version = 0;
  89         if (!(zf = zip_fopen(archive, "version", 0))) {
  90                 sr_dbg("Not a sigrok session file.");
  91                 return SR_ERR;
  92         }
  93         if ((ret = zip_fread(zf, s, 10)) == -1) {
  94                 sr_dbg("Not a valid sigrok session file.");
  95                 return SR_ERR;
  96         }
  97         zip_fclose(zf);
  98         s[ret] = 0;
  99         version = strtoull(s, NULL, 10);
 100         if (version != 1) {
 101                 sr_dbg("Not a valid sigrok session file version.");
 102                 return SR_ERR;
 103         }
 104
 105         /* read "metadata" */
 106         if (zip_stat(archive, "metadata", 0, &zs) == -1) {
 107                 sr_dbg("Not a valid sigrok session file.");
 108                 return SR_ERR;
 109         }
 110
 111         if (!(metafile = g_try_malloc(zs.size))) {
 112                 sr_err("%s: metafile malloc failed", __func__);
 113                 return SR_ERR_MALLOC;
 114         }
 115
 116         zf = zip_fopen_index(archive, zs.index, 0);
 117         zip_fread(zf, metafile, zs.size);
 118         zip_fclose(zf);
 119
 120         kf = g_key_file_new();
 121         if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
 122                 sr_dbg("Failed to parse metadata.");
 123                 return SR_ERR;
 124         }
 125
 126         sr_session_new();
 127
 128         devcnt = 0;
 129         capturefiles = g_ptr_array_new_with_free_func(g_free);
 130         sections = g_key_file_get_groups(kf, NULL);
 131         for (i = 0; sections[i]; i++) {
 132                 if (!strcmp(sections[i], "global"))
 133                         /* nothing really interesting in here yet */
 134                         continue;
 135                 if (!strncmp(sections[i], "device ", 7)) {
 136                         /* device section */
 137                         sdi = NULL;
 138                         enabled_probes = total_probes = 0;
 139                         keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
 140                         for (j = 0; keys[j]; j++) {
 141                                 val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
 142                                 if (!strcmp(keys[j], "capturefile")) {
 143                                         sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
 144                                         sdi->driver = &session_driver;
 145                                         if (devcnt == 0)
 146                                                 /* first device, init the driver */
 147                                                 sdi->driver->init(NULL);
 148                                         sr_session_dev_add(sdi);
 149                                         sdi->driver->config_set(SR_CONF_SESSIONFILE,
 150                                                         g_variant_new_string(filename), sdi);
 151                                         sdi->driver->config_set(SR_CONF_CAPTUREFILE,
 152                                                         g_variant_new_string(val), sdi);
 153                                         g_ptr_array_add(capturefiles, val);
 154                                 } else if (!strcmp(keys[j], "samplerate")) {
 155                                         sr_parse_sizestring(val, &tmp_u64);
 156                                         sdi->driver->config_set(SR_CONF_SAMPLERATE,
 157                                                         g_variant_new_uint64(tmp_u64), sdi);
 158                                 } else if (!strcmp(keys[j], "unitsize")) {
 159                                         tmp_u64 = strtoull(val, NULL, 10);
 160                                         sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
 161                                                         g_variant_new_uint64(tmp_u64), sdi);
 162                                 } else if (!strcmp(keys[j], "total probes")) {
 163                                         total_probes = strtoull(val, NULL, 10);
 164                                         sdi->driver->config_set(SR_CONF_CAPTURE_NUM_PROBES,
 165                                                         g_variant_new_uint64(total_probes), sdi);
 166                                         for (p = 0; p < total_probes; p++) {
 167                                                 snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
 168                                                 if (!(probe = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
 169                                                                 probename)))
 170                                                         return SR_ERR;
 171                                                 sdi->probes = g_slist_append(sdi->probes, probe);
 172                                         }
 173                                 } else if (!strncmp(keys[j], "probe", 5)) {
 174                                         if (!sdi)
 175                                                 continue;
 176                                         enabled_probes++;
 177                                         tmp_u64 = strtoul(keys[j]+5, NULL, 10);
 178                                         /* sr_session_save() */
 179                                         sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
 180                                 } else if (!strncmp(keys[j], "trigger", 7)) {
 181                                         probenum = strtoul(keys[j]+7, NULL, 10);
 182                                         sr_dev_trigger_set(sdi, probenum, val);
 183                                 }
 184                         }
 185                         g_strfreev(keys);
 186                         /* Disable probes not specifically listed. */
 187                         if (total_probes)
 188                                 for (p = enabled_probes; p < total_probes; p++)
 189                                         sr_dev_probe_enable(sdi, p, FALSE);
 190                 }
 191                 devcnt++;
 192         }
 193         g_strfreev(sections);
 194         g_key_file_free(kf);
 195
 196         return SR_OK;
 197 }
 198
 199 /**
 200  * Save the current session to the specified file.
 201  *
 202  * @param filename The name of the filename to save the current session as.
 203  *                 Must not be NULL.
 204  * @param sdi The device instance from which the data was captured.
 205  * @param buf The data to be saved.
 206  * @param unitsize The number of bytes per sample.
 207  * @param units The number of samples.
 208  *
 209  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
 210  *         upon other errors.
 211  */
 212 SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
 213                 unsigned char *buf, int unitsize, int units)
 214 {
 215         GSList *l;
 216         GVariant *gvar;
 217         FILE *meta;
 218         struct sr_probe *probe;
 219         struct zip *zipfile;
 220         struct zip_source *versrc, *metasrc, *logicsrc;
 221         int tmpfile, ret, probecnt;
 222         uint64_t samplerate;
 223         char version[1], rawname[16], metafile[32], *s;
 224
 225         if (!filename) {
 226                 sr_err("%s: filename was NULL", __func__);
 227                 return SR_ERR_ARG;
 228         }
 229
 230         /* Quietly delete it first, libzip wants replace ops otherwise. */
 231         unlink(filename);
 232         if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
 233                 return SR_ERR;
 234
 235         /* "version" */
 236         version[0] = '1';
 237         if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
 238                 return SR_ERR;
 239         if (zip_add(zipfile, "version", versrc) == -1) {
 240                 sr_info("error saving version into zipfile: %s",
 241                         zip_strerror(zipfile));
 242                 return SR_ERR;
 243         }
 244
 245         /* init "metadata" */
 246         strcpy(metafile, "sigrok-meta-XXXXXX");
 247         if ((tmpfile = g_mkstemp(metafile)) == -1)
 248                 return SR_ERR;
 249         close(tmpfile);
 250         meta = g_fopen(metafile, "wb");
 251         fprintf(meta, "[global]\n");
 252         fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
 253
 254         /* metadata */
 255         fprintf(meta, "[device 1]\n");
 256         if (sdi->driver)
 257                 fprintf(meta, "driver = %s\n", sdi->driver->name);
 258
 259         /* metadata */
 260         fprintf(meta, "capturefile = logic-1\n");
 261         fprintf(meta, "unitsize = %d\n", unitsize);
 262         fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
 263         if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
 264                 if (sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
 265                                 &gvar, sdi) == SR_OK) {
 266                         samplerate = g_variant_get_uint64(gvar);
 267                         s = sr_samplerate_string(samplerate);
 268                         fprintf(meta, "samplerate = %s\n", s);
 269                         g_free(s);
 270                         g_variant_unref(gvar);
 271                 }
 272         }
 273         probecnt = 1;
 274         for (l = sdi->probes; l; l = l->next) {
 275                 probe = l->data;
 276                 if (probe->enabled) {
 277                         if (probe->name)
 278                                 fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
 279                         if (probe->trigger)
 280                                 fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
 281                         probecnt++;
 282                 }
 283         }
 284
 285         if (!(logicsrc = zip_source_buffer(zipfile, buf,
 286                            units * unitsize, FALSE)))
 287                 return SR_ERR;
 288         snprintf(rawname, 15, "logic-1");
 289         if (zip_add(zipfile, rawname, logicsrc) == -1)
 290                 return SR_ERR;
 291         fclose(meta);
 292
 293         if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
 294                 return SR_ERR;
 295         if (zip_add(zipfile, "metadata", metasrc) == -1)
 296                 return SR_ERR;
 297
 298         if ((ret = zip_close(zipfile)) == -1) {
 299                 sr_info("error saving zipfile: %s", zip_strerror(zipfile));
 300                 return SR_ERR;
 301         }
 302
 303         unlink(metafile);
 304
 305         return SR_OK;
 306 }
 307
 308 /** @} */