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