src/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 <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <errno.h>
  27 #include <glib.h>
  28 #include <glib/gstdio.h>
  29 #include "config.h" /* Needed for PACKAGE_VERSION and others. */
  30 #include "libsigrok.h"
  31 #include "libsigrok-internal.h"
  32
  33 /** @cond PRIVATE */
  34 #define LOG_PREFIX "session-file"
  35 /** @endcond */
  36
  37 /**
  38  * @file
  39  *
  40  * Loading and saving libsigrok session files.
  41  */
  42
  43 /**
  44  * @addtogroup grp_session
  45  *
  46  * @{
  47  */
  48
  49 extern SR_PRIV struct sr_dev_driver session_driver;
  50
  51 /** @private */
  52 SR_PRIV int sr_sessionfile_check(const char *filename)
  53 {
  54         struct stat st;
  55         struct zip *archive;
  56         struct zip_file *zf;
  57         struct zip_stat zs;
  58         int version, ret;
  59         char s[11];
  60
  61         if (!filename)
  62                 return SR_ERR_ARG;
  63
  64         if (stat(filename, &st) == -1) {
  65                 sr_err("Couldn't stat %s: %s", filename, strerror(errno));
  66                 return SR_ERR;
  67         }
  68
  69         if (!(archive = zip_open(filename, 0, &ret)))
  70                 /* No logging: this can be used just to check if it's
  71                  * a sigrok session file or not. */
  72                 return SR_ERR;
  73
  74         /* check "version" */
  75         version = 0;
  76         if (!(zf = zip_fopen(archive, "version", 0))) {
  77                 sr_dbg("Not a sigrok session file: no version found.");
  78                 return SR_ERR;
  79         }
  80         if ((ret = zip_fread(zf, s, 10)) == -1)
  81                 return SR_ERR;
  82         zip_fclose(zf);
  83         s[ret] = 0;
  84         version = strtoull(s, NULL, 10);
  85         if (version > 2) {
  86                 sr_dbg("Cannot handle sigrok session file version %d.", version);
  87                 return SR_ERR;
  88         }
  89         sr_spew("Detected sigrok session file version %d.", version);
  90
  91         /* read "metadata" */
  92         if (zip_stat(archive, "metadata", 0, &zs) == -1) {
  93                 sr_dbg("Not a valid sigrok session file.");
  94                 return SR_ERR;
  95         }
  96
  97         return SR_OK;
  98 }
  99
 100 /**
 101  * Load the session from the specified filename.
 102  *
 103  * @param filename The name of the session file to load. Must not be NULL.
 104  * @param session The session to load the file into. Must not be NULL.
 105  *
 106  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
 107  *         SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
 108  *         other errors.
 109  */
 110 SR_API int sr_session_load(const char *filename, struct sr_session **session)
 111 {
 112         GKeyFile *kf;
 113         GPtrArray *capturefiles;
 114         struct zip *archive;
 115         struct zip_file *zf;
 116         struct zip_stat zs;
 117         struct sr_dev_inst *sdi;
 118         struct sr_channel *ch;
 119         int devcnt, ret, i, j;
 120         uint64_t tmp_u64, total_channels, enabled_channels, p;
 121         char **sections, **keys, *metafile, *val;
 122         char channelname[SR_MAX_CHANNELNAME_LEN + 1];
 123
 124         if ((ret = sr_sessionfile_check(filename)) != SR_OK)
 125                 return ret;
 126
 127         if (!(archive = zip_open(filename, 0, &ret)))
 128                 return SR_ERR;
 129
 130         if (zip_stat(archive, "metadata", 0, &zs) == -1)
 131                 return SR_ERR;
 132
 133         if (!(metafile = g_try_malloc(zs.size))) {
 134                 sr_err("%s: metafile malloc failed", __func__);
 135                 return SR_ERR_MALLOC;
 136         }
 137
 138         zf = zip_fopen_index(archive, zs.index, 0);
 139         zip_fread(zf, metafile, zs.size);
 140         zip_fclose(zf);
 141
 142         kf = g_key_file_new();
 143         if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, NULL)) {
 144                 sr_dbg("Failed to parse metadata.");
 145                 return SR_ERR;
 146         }
 147
 148         if ((ret = sr_session_new(session)) != SR_OK)
 149                 return ret;
 150
 151         devcnt = 0;
 152         capturefiles = g_ptr_array_new_with_free_func(g_free);
 153         sections = g_key_file_get_groups(kf, NULL);
 154         for (i = 0; sections[i]; i++) {
 155                 if (!strcmp(sections[i], "global"))
 156                         /* nothing really interesting in here yet */
 157                         continue;
 158                 if (!strncmp(sections[i], "device ", 7)) {
 159                         /* device section */
 160                         sdi = NULL;
 161                         enabled_channels = total_channels = 0;
 162                         keys = g_key_file_get_keys(kf, sections[i], NULL, NULL);
 163                         for (j = 0; keys[j]; j++) {
 164                                 val = g_key_file_get_string(kf, sections[i], keys[j], NULL);
 165                                 if (!strcmp(keys[j], "capturefile")) {
 166                                         sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, NULL, NULL, NULL);
 167                                         sdi->driver = &session_driver;
 168                                         if (devcnt == 0)
 169                                                 /* first device, init the driver */
 170                                                 sdi->driver->init(NULL);
 171                                         sr_dev_open(sdi);
 172                                         sr_session_dev_add(*session, sdi);
 173                                         sdi->driver->config_set(SR_CONF_SESSIONFILE,
 174                                                         g_variant_new_string(filename), sdi, NULL);
 175                                         sdi->driver->config_set(SR_CONF_CAPTUREFILE,
 176                                                         g_variant_new_string(val), sdi, NULL);
 177                                         g_ptr_array_add(capturefiles, val);
 178                                 } else if (!strcmp(keys[j], "samplerate")) {
 179                                         sr_parse_sizestring(val, &tmp_u64);
 180                                         sdi->driver->config_set(SR_CONF_SAMPLERATE,
 181                                                         g_variant_new_uint64(tmp_u64), sdi, NULL);
 182                                 } else if (!strcmp(keys[j], "unitsize")) {
 183                                         tmp_u64 = strtoull(val, NULL, 10);
 184                                         sdi->driver->config_set(SR_CONF_CAPTURE_UNITSIZE,
 185                                                         g_variant_new_uint64(tmp_u64), sdi, NULL);
 186                                 } else if (!strcmp(keys[j], "total probes")) {
 187                                         total_channels = strtoull(val, NULL, 10);
 188                                         sdi->driver->config_set(SR_CONF_NUM_LOGIC_CHANNELS,
 189                                                         g_variant_new_uint64(total_channels), sdi, NULL);
 190                                         for (p = 0; p < total_channels; p++) {
 191                                                 snprintf(channelname, SR_MAX_CHANNELNAME_LEN, "%" PRIu64, p);
 192                                                 if (!(ch = sr_channel_new(p, SR_CHANNEL_LOGIC, TRUE,
 193                                                                 channelname)))
 194                                                         return SR_ERR;
 195                                                 sdi->channels = g_slist_append(sdi->channels, ch);
 196                                         }
 197                                 } else if (!strncmp(keys[j], "probe", 5)) {
 198                                         if (!sdi)
 199                                                 continue;
 200                                         enabled_channels++;
 201                                         tmp_u64 = strtoul(keys[j]+5, NULL, 10);
 202                                         /* sr_session_save() */
 203                                         sr_dev_channel_name_set(sdi, tmp_u64 - 1, val);
 204                                 }
 205                         }
 206                         g_strfreev(keys);
 207                         /* Disable channels not specifically listed. */
 208                         if (total_channels)
 209                                 for (p = enabled_channels; p < total_channels; p++)
 210                                         sr_dev_channel_enable(sdi, p, FALSE);
 211                 }
 212                 devcnt++;
 213         }
 214         g_strfreev(sections);
 215         g_key_file_free(kf);
 216
 217         return SR_OK;
 218 }
 219
 220 /**
 221  * Save a session to the specified file.
 222  *
 223  * @param session The session to save to the specified file. Must not be NULL.
 224  * @param filename The name of the filename to save the session as.
 225  *                 Must not be NULL.
 226  * @param sdi The device instance from which the data was captured.
 227  * @param buf The data to be saved.
 228  * @param unitsize The number of bytes per sample.
 229  * @param units The number of samples.
 230  *
 231  * @retval SR_OK Success
 232  * @retval SR_ERR_ARG Invalid arguments
 233  * @retval SR_ERR Other errors
 234  *
 235  * @since 0.2.0
 236  */
 237 SR_API int sr_session_save(struct sr_session *session, const char *filename,
 238                 const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize,
 239                 int units)
 240 {
 241         struct sr_channel *ch;
 242         GSList *l;
 243         GVariant *gvar;
 244         uint64_t samplerate;
 245         int cnt, ret;
 246         char **channel_names;
 247
 248         samplerate = 0;
 249         if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
 250                 if (sr_config_get(sdi->driver, sdi, NULL,
 251                                         SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
 252                         samplerate = g_variant_get_uint64(gvar);
 253                         g_variant_unref(gvar);
 254                 }
 255         }
 256
 257         channel_names = g_malloc0(sizeof(char *) * (g_slist_length(sdi->channels) + 1));
 258         cnt = 0;
 259         for (l = sdi->channels; l; l = l->next) {
 260                 ch = l->data;
 261                 if (ch->type != SR_CHANNEL_LOGIC)
 262                         continue;
 263                 if (ch->enabled != TRUE)
 264                         continue;
 265                 if (!ch->name)
 266                         continue;
 267                 /* Just borrowing the ptr. */
 268                 channel_names[cnt++] = ch->name;
 269         }
 270
 271         if ((ret = sr_session_save_init(session, filename, samplerate,
 272                         channel_names)) != SR_OK)
 273                 return ret;
 274
 275         ret = sr_session_append(session, filename, buf, unitsize, units);
 276
 277         return ret;
 278 }
 279
 280 /**
 281  * Initialize a saved session file.
 282  *
 283  * @param session The session to use. Must not be NULL.
 284  * @param filename The name of the filename to save the session as.
 285  *                 Must not be NULL.
 286  * @param samplerate The samplerate to store for this session.
 287  * @param channels A NULL-terminated array of strings containing the names
 288  * of all the channels active in this session.
 289  *
 290  * @retval SR_OK Success
 291  * @retval SR_ERR_ARG Invalid arguments
 292  * @retval SR_ERR Other errors
 293  *
 294  * @since 0.3.0
 295  */
 296 SR_API int sr_session_save_init(struct sr_session *session,
 297                 const char *filename, uint64_t samplerate, char **channels)
 298 {
 299         FILE *meta;
 300         struct zip *zipfile;
 301         struct zip_source *versrc, *metasrc;
 302         int tmpfile, cnt, ret, i;
 303         char version[1], metafile[32], *s;
 304
 305         (void)session;
 306
 307         if (!filename) {
 308                 sr_err("%s: filename was NULL", __func__);
 309                 return SR_ERR_ARG;
 310         }
 311
 312         /* Quietly delete it first, libzip wants replace ops otherwise. */
 313         unlink(filename);
 314         if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
 315                 return SR_ERR;
 316
 317         /* "version" */
 318         version[0] = '2';
 319         if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
 320                 return SR_ERR;
 321         if (zip_add(zipfile, "version", versrc) == -1) {
 322                 sr_info("error saving version into zipfile: %s",
 323                         zip_strerror(zipfile));
 324                 return SR_ERR;
 325         }
 326
 327         /* init "metadata" */
 328         strcpy(metafile, "sigrok-meta-XXXXXX");
 329         if ((tmpfile = g_mkstemp(metafile)) == -1)
 330                 return SR_ERR;
 331         close(tmpfile);
 332         meta = g_fopen(metafile, "wb");
 333         fprintf(meta, "[global]\n");
 334         fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
 335
 336         /* metadata */
 337         fprintf(meta, "[device 1]\n");
 338
 339         /* metadata */
 340         fprintf(meta, "capturefile = logic-1\n");
 341         cnt = 0;
 342         for (i = 0; channels[i]; i++)
 343                 cnt++;
 344         fprintf(meta, "total probes = %d\n", cnt);
 345         s = sr_samplerate_string(samplerate);
 346         fprintf(meta, "samplerate = %s\n", s);
 347         g_free(s);
 348
 349         for (i = 0; channels[i]; i++)
 350                 fprintf(meta, "probe%d = %s\n", i + 1, channels[i]);
 351
 352         fclose(meta);
 353
 354         if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
 355                 unlink(metafile);
 356                 return SR_ERR;
 357         }
 358         if (zip_add(zipfile, "metadata", metasrc) == -1) {
 359                 unlink(metafile);
 360                 return SR_ERR;
 361         }
 362
 363         if ((ret = zip_close(zipfile)) == -1) {
 364                 sr_info("error saving zipfile: %s", zip_strerror(zipfile));
 365                 unlink(metafile);
 366                 return SR_ERR;
 367         }
 368
 369         unlink(metafile);
 370
 371         return SR_OK;
 372 }
 373
 374 /**
 375  * Append data to an existing session file.
 376  *
 377  * The session file must have been created with sr_session_save_init()
 378  * or sr_session_save() beforehand.
 379  *
 380  * @param session The session to use. Must not be NULL.
 381  * @param filename The name of the filename to append to. Must not be NULL.
 382  * @param buf The data to be appended.
 383  * @param unitsize The number of bytes per sample.
 384  * @param units The number of samples.
 385  *
 386  * @retval SR_OK Success
 387  * @retval SR_ERR_ARG Invalid arguments
 388  * @retval SR_ERR Other errors
 389  *
 390  * @since 0.3.0
 391  */
 392 SR_API int sr_session_append(struct sr_session *session, const char *filename,
 393                 unsigned char *buf, int unitsize, int units)
 394 {
 395         struct zip *archive;
 396         struct zip_source *logicsrc;
 397         zip_int64_t num_files;
 398         struct zip_file *zf;
 399         struct zip_stat zs;
 400         struct zip_source *metasrc;
 401         GKeyFile *kf;
 402         GError *error;
 403         gsize len;
 404         int chunk_num, next_chunk_num, tmpfile, ret, i;
 405         const char *entry_name;
 406         char *metafile, tmpname[32], chunkname[16];
 407
 408         (void)session;
 409
 410         if ((ret = sr_sessionfile_check(filename)) != SR_OK)
 411                 return ret;
 412
 413         if (!(archive = zip_open(filename, 0, &ret)))
 414                 return SR_ERR;
 415
 416         if (zip_stat(archive, "metadata", 0, &zs) == -1)
 417                 return SR_ERR;
 418
 419         metafile = g_malloc(zs.size);
 420         zf = zip_fopen_index(archive, zs.index, 0);
 421         zip_fread(zf, metafile, zs.size);
 422         zip_fclose(zf);
 423
 424         /*
 425          * If the file was only initialized but doesn't yet have any
 426          * data it in, it won't have a unitsize field in metadata yet.
 427          */
 428         error = NULL;
 429         kf = g_key_file_new();
 430         if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
 431                 sr_err("Failed to parse metadata: %s.", error->message);
 432                 return SR_ERR;
 433         }
 434         g_free(metafile);
 435         tmpname[0] = '\0';
 436         if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
 437                 if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
 438                         sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
 439                         return SR_ERR;
 440                 }
 441                 /* Add unitsize field. */
 442                 g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
 443                 metafile = g_key_file_to_data(kf, &len, &error);
 444                 strcpy(tmpname, "sigrok-meta-XXXXXX");
 445                 if ((tmpfile = g_mkstemp(tmpname)) == -1)
 446                         return SR_ERR;
 447                 if (write(tmpfile, metafile, len) < 0) {
 448                         sr_dbg("Failed to create new metadata: %s", strerror(errno));
 449                         g_free(metafile);
 450                         unlink(tmpname);
 451                         return SR_ERR;
 452                 }
 453                 close(tmpfile);
 454                 if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
 455                         sr_err("Failed to create zip source for metadata.");
 456                         g_free(metafile);
 457                         unlink(tmpname);
 458                         return SR_ERR;
 459                 }
 460                 if (zip_replace(archive, zs.index, metasrc) == -1) {
 461                         sr_err("Failed to replace metadata file.");
 462                         g_free(metafile);
 463                         unlink(tmpname);
 464                         return SR_ERR;
 465                 }
 466                 g_free(metafile);
 467         }
 468         g_key_file_free(kf);
 469
 470         next_chunk_num = 1;
 471         num_files = zip_get_num_entries(archive, 0);
 472         for (i = 0; i < num_files; i++) {
 473                 entry_name = zip_get_name(archive, i, 0);
 474                 if (strncmp(entry_name, "logic-1", 7))
 475                         continue;
 476                 if (strlen(entry_name) == 7) {
 477                         /* This file has no extra chunks, just a single "logic-1".
 478                          * Rename it to "logic-1-1" * and continue with chunk 2. */
 479                         if (zip_rename(archive, i, "logic-1-1") == -1) {
 480                                 sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
 481                                 unlink(tmpname);
 482                                 return SR_ERR;
 483                         }
 484                         next_chunk_num = 2;
 485                         break;
 486                 } else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
 487                         chunk_num = strtoull(entry_name + 8, NULL, 10);
 488                         if (chunk_num >= next_chunk_num)
 489                                 next_chunk_num = chunk_num + 1;
 490                 }
 491         }
 492         snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
 493         if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE))) {
 494                 unlink(tmpname);
 495                 return SR_ERR;
 496         }
 497         if (zip_add(archive, chunkname, logicsrc) == -1) {
 498                 unlink(tmpname);
 499                 return SR_ERR;
 500         }
 501         if ((ret = zip_close(archive)) == -1) {
 502                 sr_info("error saving session file: %s", zip_strerror(archive));
 503                 unlink(tmpname);
 504                 return SR_ERR;
 505         }
 506         unlink(tmpname);
 507
 508         return SR_OK;
 509 }
 510
 511 /** @} */