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