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