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