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