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