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