session_file.c

   1 /*
   2  * This file is part of the libsigrok 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 subsystem-specific prefix string. */
  31 #define LOG_PREFIX "session-file: "
  32 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  33 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  34 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  35 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  36 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  37 #define sr_err(s, args...) sr_err(LOG_PREFIX 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 /** @private */
  55 SR_PRIV int sr_sessionfile_check(const char *filename)
  56 {
  57         struct zip *archive;
  58         struct zip_file *zf;
  59         struct zip_stat zs;
  60         int version, ret;
  61         char s[11];
  62
  63         if (!filename)
  64                 return SR_ERR_ARG;
  65
  66         if (!(archive = zip_open(filename, 0, &ret)))
  67                 /* No logging: this can be used just to check if it's
  68                  * a sigrok session file or not. */
  69                 return SR_ERR;
  70
  71         /* check "version" */
  72         version = 0;
  73         if (!(zf = zip_fopen(archive, "version", 0))) {
  74                 sr_dbg("Not a sigrok session file: no version found.");
  75                 return SR_ERR;
  76         }
  77         if ((ret = zip_fread(zf, s, 10)) == -1)
  78                 return SR_ERR;
  79         zip_fclose(zf);
  80         s[ret] = 0;
  81         version = strtoull(s, NULL, 10);
  82         if (version != 1) {
  83                 sr_dbg("Cannot handle sigrok session file version %d.", version);
  84                 return SR_ERR;
  85         }
  86
  87         /* read "metadata" */
  88         if (zip_stat(archive, "metadata", 0, &zs) == -1) {
  89                 sr_dbg("Not a valid sigrok session file.");
  90                 return SR_ERR;
  91         }
  92
  93         return SR_OK;
  94 }
  95
  96 /**
  97  * Load the session from the specified filename.
  98  *
  99  * @param filename The name of the session file to load. Must not be NULL.
 100  *
 101  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
 102  *         SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
 103  *         other errors.
 104  */
 105 SR_API int sr_session_load(const char *filename)
 106 {
 107         GKeyFile *kf;
 108         GPtrArray *capturefiles;
 109         struct zip *archive;
 110         struct zip_file *zf;
 111         struct zip_stat zs;
 112         struct sr_dev_inst *sdi;
 113         struct sr_probe *probe;
 114         int ret, probenum, devcnt, i, j;
 115         uint64_t tmp_u64, total_probes, enabled_probes, p;
 116         char **sections, **keys, *metafile, *val;
 117         char probename[SR_MAX_PROBENAME_LEN + 1];
 118
 119         if ((ret = sr_sessionfile_check(filename)) != SR_OK)
 120                 return ret;
 121
 122         if (!(archive = zip_open(filename, 0, &ret)))
 123                 return SR_ERR;
 124
 125         if (zip_stat(archive, "metadata", 0, &zs) == -1)
 126                 return SR_ERR;
 127
 128         if (!(metafile = g_try_malloc(zs.size))) {
 129                 sr_err("%s: metafile malloc failed", __func__);
 130                 return SR_ERR_MALLOC;
 131         }
 132
 133         zf = zip_fopen_index(archive, zs.index, 0);
 134         zip_fread(zf, metafile, zs.size);
 135         zip_fclose(zf);
 136
 137         kf = g_key_file_new();
 138         if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
 139                 sr_dbg("Failed to parse metadata.");
 140                 return SR_ERR;
 141         }
 142
 143         sr_session_new();
 144
 145         devcnt = 0;
 146         capturefiles = g_ptr_array_new_with_free_func(g_free);
 147         sections = g_key_file_get_groups(kf, NULL);
 148         for (i = 0; sections[i]; i++) {
 149                 if (!strcmp(sections[i], "global"))
 150                         /* nothing really interesting in here yet */
 151                         continue;
 152                 if (!strncmp(sections[i], "device ", 7)) {
 153                         /* device section */
 154                         sdi = NULL;
 155                         enabled_probes = total_probes = 0;
 156                         keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
 157                         for (j = 0; keys[j]; j++) {
 158                                 val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
 159                                 if (!strcmp(keys[j], "capturefile")) {
 160                                         sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
 161                                         sdi->driver = &session_driver;
 162                                         if (devcnt == 0)
 163                                                 /* first device, init the driver */
 164                                                 sdi->driver->init(NULL);
 165                                         sr_dev_open(sdi);
 166                                         sr_session_dev_add(sdi);
 167                                         sdi->driver->config_set(SR_CONF_SESSIONFILE,
 168                                                         g_variant_new_string(filename), sdi);
 169                                         sdi->driver->config_set(SR_CONF_CAPTUREFILE,
 170                                                         g_variant_new_string(val), sdi);
 171                                         g_ptr_array_add(capturefiles, val);
 172                                 } else if (!strcmp(keys[j], "samplerate")) {
 173                                         sr_parse_sizestring(val, &tmp_u64);
 174                                         sdi->driver->config_set(SR_CONF_SAMPLERATE,
 175                                                         g_variant_new_uint64(tmp_u64), sdi);
 176                                 } else if (!strcmp(keys[j], "unitsize")) {
 177                                         tmp_u64 = strtoull(val, NULL, 10);
 178                                         sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
 179                                                         g_variant_new_uint64(tmp_u64), sdi);
 180                                 } else if (!strcmp(keys[j], "total probes")) {
 181                                         total_probes = strtoull(val, NULL, 10);
 182                                         sdi->driver->config_set(SR_CONF_CAPTURE_NUM_PROBES,
 183                                                         g_variant_new_uint64(total_probes), sdi);
 184                                         for (p = 0; p < total_probes; p++) {
 185                                                 snprintf(probename, SR_MAX_PROBENAME_LEN, "%" PRIu64, p);
 186                                                 if (!(probe = sr_probe_new(p, SR_PROBE_LOGIC, TRUE,
 187                                                                 probename)))
 188                                                         return SR_ERR;
 189                                                 sdi->probes = g_slist_append(sdi->probes, probe);
 190                                         }
 191                                 } else if (!strncmp(keys[j], "probe", 5)) {
 192                                         if (!sdi)
 193                                                 continue;
 194                                         enabled_probes++;
 195                                         tmp_u64 = strtoul(keys[j]+5, NULL, 10);
 196                                         /* sr_session_save() */
 197                                         sr_dev_probe_name_set(sdi, tmp_u64 - 1, val);
 198                                 } else if (!strncmp(keys[j], "trigger", 7)) {
 199                                         probenum = strtoul(keys[j]+7, NULL, 10);
 200                                         sr_dev_trigger_set(sdi, probenum, val);
 201                                 }
 202                         }
 203                         g_strfreev(keys);
 204                         /* Disable probes not specifically listed. */
 205                         if (total_probes)
 206                                 for (p = enabled_probes; p < total_probes; p++)
 207                                         sr_dev_probe_enable(sdi, p, FALSE);
 208                 }
 209                 devcnt++;
 210         }
 211         g_strfreev(sections);
 212         g_key_file_free(kf);
 213
 214         return SR_OK;
 215 }
 216
 217 /**
 218  * Save the current session to the specified file.
 219  *
 220  * @param filename The name of the filename to save the current session as.
 221  *                 Must not be NULL.
 222  * @param sdi The device instance from which the data was captured.
 223  * @param buf The data to be saved.
 224  * @param unitsize The number of bytes per sample.
 225  * @param units The number of samples.
 226  *
 227  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
 228  *         upon other errors.
 229  */
 230 SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
 231                 unsigned char *buf, int unitsize, int units)
 232 {
 233         GSList *l;
 234         GVariant *gvar;
 235         FILE *meta;
 236         struct sr_probe *probe;
 237         struct zip *zipfile;
 238         struct zip_source *versrc, *metasrc, *logicsrc;
 239         int tmpfile, ret, probecnt;
 240         uint64_t samplerate;
 241         char version[1], rawname[16], metafile[32], *s;
 242
 243         if (!filename) {
 244                 sr_err("%s: filename was NULL", __func__);
 245                 return SR_ERR_ARG;
 246         }
 247
 248         /* Quietly delete it first, libzip wants replace ops otherwise. */
 249         unlink(filename);
 250         if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
 251                 return SR_ERR;
 252
 253         /* "version" */
 254         version[0] = '1';
 255         if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
 256                 return SR_ERR;
 257         if (zip_add(zipfile, "version", versrc) == -1) {
 258                 sr_info("error saving version into zipfile: %s",
 259                         zip_strerror(zipfile));
 260                 return SR_ERR;
 261         }
 262
 263         /* init "metadata" */
 264         strcpy(metafile, "sigrok-meta-XXXXXX");
 265         if ((tmpfile = g_mkstemp(metafile)) == -1)
 266                 return SR_ERR;
 267         close(tmpfile);
 268         meta = g_fopen(metafile, "wb");
 269         fprintf(meta, "[global]\n");
 270         fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
 271
 272         /* metadata */
 273         fprintf(meta, "[device 1]\n");
 274         if (sdi->driver)
 275                 fprintf(meta, "driver = %s\n", sdi->driver->name);
 276
 277         /* metadata */
 278         fprintf(meta, "capturefile = logic-1\n");
 279         fprintf(meta, "unitsize = %d\n", unitsize);
 280         fprintf(meta, "total probes = %d\n", g_slist_length(sdi->probes));
 281         if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
 282                 if (sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
 283                                 &gvar, sdi) == SR_OK) {
 284                         samplerate = g_variant_get_uint64(gvar);
 285                         s = sr_samplerate_string(samplerate);
 286                         fprintf(meta, "samplerate = %s\n", s);
 287                         g_free(s);
 288                         g_variant_unref(gvar);
 289                 }
 290         }
 291         probecnt = 1;
 292         for (l = sdi->probes; l; l = l->next) {
 293                 probe = l->data;
 294                 if (probe->enabled) {
 295                         if (probe->name)
 296                                 fprintf(meta, "probe%d = %s\n", probecnt, probe->name);
 297                         if (probe->trigger)
 298                                 fprintf(meta, " trigger%d = %s\n", probecnt, probe->trigger);
 299                         probecnt++;
 300                 }
 301         }
 302
 303         if (!(logicsrc = zip_source_buffer(zipfile, buf,
 304                            units * unitsize, FALSE)))
 305                 return SR_ERR;
 306         snprintf(rawname, 15, "logic-1");
 307         if (zip_add(zipfile, rawname, logicsrc) == -1)
 308                 return SR_ERR;
 309         fclose(meta);
 310
 311         if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1)))
 312                 return SR_ERR;
 313         if (zip_add(zipfile, "metadata", metasrc) == -1)
 314                 return SR_ERR;
 315
 316         if ((ret = zip_close(zipfile)) == -1) {
 317                 sr_info("error saving zipfile: %s", zip_strerror(zipfile));
 318                 return SR_ERR;
 319         }
 320
 321         unlink(metafile);
 322
 323         return SR_OK;
 324 }
 325
 326 /**
 327  * Append data to an existing session file.
 328  *
 329  * @param filename The name of the filename to append to. Must not be NULL.
 330  * @param buf The data to be appended.
 331  * @param unitsize The number of bytes per sample.
 332  * @param units The number of samples.
 333  *
 334  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
 335  *         upon other errors.
 336  */
 337 SR_API int sr_session_append(const char *filename, unsigned char *buf,
 338                 int unitsize, int units)
 339 {
 340         struct zip *archive;
 341         struct zip_source *logicsrc;
 342         zip_int64_t num_files;
 343         int chunk_num, next_chunk_num, ret, i;
 344         const char *entry_name;
 345         char chunkname[16];
 346
 347         if ((ret = sr_sessionfile_check(filename)) != SR_OK)
 348                 return ret;
 349
 350         if (!(archive = zip_open(filename, 0, &ret)))
 351                 return SR_ERR;
 352
 353         next_chunk_num = 1;
 354         num_files = zip_get_num_entries(archive, 0);
 355         for (i = 0; i < num_files; i++) {
 356                 entry_name = zip_get_name(archive, i, 0);
 357                 if (strncmp(entry_name, "logic-1", 7))
 358                         continue;
 359                 if (strlen(entry_name) == 7) {
 360                         /* This file has no extra chunks, just a single "logic-1".
 361                          * Rename it to "logic-1-1" * and continue with chunk 2. */
 362                         if (zip_rename(archive, i, "logic-1-1") == -1) {
 363                                 sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
 364                                 return SR_ERR;
 365                         }
 366                         next_chunk_num = 2;
 367                         break;
 368                 } else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
 369                         chunk_num = strtoull(entry_name + 8, NULL, 10);
 370                         if (chunk_num >= next_chunk_num)
 371                                 next_chunk_num = chunk_num + 1;
 372                 }
 373         }
 374         snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
 375         if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE)))
 376                 return SR_ERR;
 377         if (zip_add(archive, chunkname, logicsrc) == -1)
 378                 return SR_ERR;
 379         if ((ret = zip_close(archive)) == -1) {
 380                 sr_info("error saving session file: %s", zip_strerror(archive));
 381                 return SR_ERR;
 382         }
 383
 384         return SR_OK;
 385 }
 386
 387 /** @} */