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