libsigrok  0.3.0
sigrok hardware access and backend library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
session_file.c
Go to the documentation of this file.
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;
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 ret, channelnum, devcnt, 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);
173  g_variant_new_string(filename), sdi, NULL);
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);
180  g_variant_new_uint64(tmp_u64), sdi, NULL);
181  } else if (!strcmp(keys[j], "unitsize")) {
182  tmp_u64 = strtoull(val, NULL, 10);
184  g_variant_new_uint64(tmp_u64), sdi, NULL);
185  } else if (!strcmp(keys[j], "total probes")) {
186  total_channels = strtoull(val, NULL, 10);
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  } else if (!strncmp(keys[j], "trigger", 7)) {
204  channelnum = strtoul(keys[j]+7, NULL, 10);
205  sr_dev_trigger_set(sdi, channelnum, val);
206  }
207  }
208  g_strfreev(keys);
209  /* Disable channels not specifically listed. */
210  if (total_channels)
211  for (p = enabled_channels; p < total_channels; p++)
212  sr_dev_channel_enable(sdi, p, FALSE);
213  }
214  devcnt++;
215  }
216  g_strfreev(sections);
217  g_key_file_free(kf);
218 
219  return SR_OK;
220 }
221 
222 /**
223  * Save the current session to the specified file.
224  *
225  * @param filename The name of the filename to save the current 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(const char *filename, const struct sr_dev_inst *sdi,
239  unsigned char *buf, int unitsize, int units)
240 {
241  struct sr_channel *ch;
242  GSList *l;
243  GVariant *gvar;
244  uint64_t samplerate;
245  int cnt, ret;
246  char **channel_names;
247 
248  samplerate = 0;
250  if (sr_config_get(sdi->driver, sdi, NULL,
251  SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
252  samplerate = g_variant_get_uint64(gvar);
253  g_variant_unref(gvar);
254  }
255  }
256 
257  channel_names = g_malloc0(sizeof(char *) * (g_slist_length(sdi->channels) + 1));
258  cnt = 0;
259  for (l = sdi->channels; l; l = l->next) {
260  ch = l->data;
261  if (ch->type != SR_CHANNEL_LOGIC)
262  continue;
263  if (ch->enabled != TRUE)
264  continue;
265  if (!ch->name)
266  continue;
267  /* Just borrowing the ptr. */
268  channel_names[cnt++] = ch->name;
269  }
270 
271  if ((ret = sr_session_save_init(filename, samplerate, channel_names)) != SR_OK)
272  return ret;
273 
274  ret = sr_session_append(filename, buf, unitsize, units);
275 
276  return ret;
277 }
278 
279 /**
280  * Initialize a saved session file.
281  *
282  * @param filename The name of the filename to save the current session as.
283  * Must not be NULL.
284  * @param samplerate The samplerate to store for this session.
285  * @param channels A NULL-terminated array of strings containing the names
286  * of all the channels active in this session.
287  *
288  * @retval SR_OK Success
289  * @retval SR_ERR_ARG Invalid arguments
290  * @retval SR_ERR Other errors
291  *
292  * @since 0.3.0
293  */
294 SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
295  char **channels)
296 {
297  FILE *meta;
298  struct zip *zipfile;
299  struct zip_source *versrc, *metasrc;
300  int tmpfile, cnt, ret, i;
301  char version[1], metafile[32], *s;
302 
303  if (!filename) {
304  sr_err("%s: filename was NULL", __func__);
305  return SR_ERR_ARG;
306  }
307 
308  /* Quietly delete it first, libzip wants replace ops otherwise. */
309  unlink(filename);
310  if (!(zipfile = zip_open(filename, ZIP_CREATE, &ret)))
311  return SR_ERR;
312 
313  /* "version" */
314  version[0] = '2';
315  if (!(versrc = zip_source_buffer(zipfile, version, 1, 0)))
316  return SR_ERR;
317  if (zip_add(zipfile, "version", versrc) == -1) {
318  sr_info("error saving version into zipfile: %s",
319  zip_strerror(zipfile));
320  return SR_ERR;
321  }
322 
323  /* init "metadata" */
324  strcpy(metafile, "sigrok-meta-XXXXXX");
325  if ((tmpfile = g_mkstemp(metafile)) == -1)
326  return SR_ERR;
327  close(tmpfile);
328  meta = g_fopen(metafile, "wb");
329  fprintf(meta, "[global]\n");
330  fprintf(meta, "sigrok version = %s\n", PACKAGE_VERSION);
331 
332  /* metadata */
333  fprintf(meta, "[device 1]\n");
334 
335  /* metadata */
336  fprintf(meta, "capturefile = logic-1\n");
337  cnt = 0;
338  for (i = 0; channels[i]; i++)
339  cnt++;
340  fprintf(meta, "total probes = %d\n", cnt);
341  s = sr_samplerate_string(samplerate);
342  fprintf(meta, "samplerate = %s\n", s);
343  g_free(s);
344 
345  for (i = 0; channels[i]; i++)
346  fprintf(meta, "probe%d = %s\n", i + 1, channels[i]);
347 
348  fclose(meta);
349 
350  if (!(metasrc = zip_source_file(zipfile, metafile, 0, -1))) {
351  unlink(metafile);
352  return SR_ERR;
353  }
354  if (zip_add(zipfile, "metadata", metasrc) == -1) {
355  unlink(metafile);
356  return SR_ERR;
357  }
358 
359  if ((ret = zip_close(zipfile)) == -1) {
360  sr_info("error saving zipfile: %s", zip_strerror(zipfile));
361  unlink(metafile);
362  return SR_ERR;
363  }
364 
365  unlink(metafile);
366 
367  return SR_OK;
368 }
369 
370 /**
371  * Append data to an existing session file.
372  *
373  * The session file must have been created with sr_session_save_init()
374  * or sr_session_save() beforehand.
375  *
376  * @param filename The name of the filename to append to. Must not be NULL.
377  * @param buf The data to be appended.
378  * @param unitsize The number of bytes per sample.
379  * @param units The number of samples.
380  *
381  * @retval SR_OK Success
382  * @retval SR_ERR_ARG Invalid arguments
383  * @retval SR_ERR Other errors
384  *
385  * @since 0.3.0
386  */
387 SR_API int sr_session_append(const char *filename, unsigned char *buf,
388  int unitsize, int units)
389 {
390  struct zip *archive;
391  struct zip_source *logicsrc;
392  zip_int64_t num_files;
393  struct zip_file *zf;
394  struct zip_stat zs;
395  struct zip_source *metasrc;
396  GKeyFile *kf;
397  GError *error;
398  gsize len;
399  int chunk_num, next_chunk_num, tmpfile, ret, i;
400  const char *entry_name;
401  char *metafile, tmpname[32], chunkname[16];
402 
403  if ((ret = sr_sessionfile_check(filename)) != SR_OK)
404  return ret;
405 
406  if (!(archive = zip_open(filename, 0, &ret)))
407  return SR_ERR;
408 
409  if (zip_stat(archive, "metadata", 0, &zs) == -1)
410  return SR_ERR;
411 
412  metafile = g_malloc(zs.size);
413  zf = zip_fopen_index(archive, zs.index, 0);
414  zip_fread(zf, metafile, zs.size);
415  zip_fclose(zf);
416 
417  /*
418  * If the file was only initialized but doesn't yet have any
419  * data it in, it won't have a unitsize field in metadata yet.
420  */
421  error = NULL;
422  kf = g_key_file_new();
423  if (!g_key_file_load_from_data(kf, metafile, zs.size, 0, &error)) {
424  sr_err("Failed to parse metadata: %s.", error->message);
425  return SR_ERR;
426  }
427  g_free(metafile);
428  tmpname[0] = '\0';
429  if (!g_key_file_has_key(kf, "device 1", "unitsize", &error)) {
430  if (error && error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
431  sr_err("Failed to check unitsize key: %s", error ? error->message : "?");
432  return SR_ERR;
433  }
434  /* Add unitsize field. */
435  g_key_file_set_integer(kf, "device 1", "unitsize", unitsize);
436  metafile = g_key_file_to_data(kf, &len, &error);
437  strcpy(tmpname, "sigrok-meta-XXXXXX");
438  if ((tmpfile = g_mkstemp(tmpname)) == -1)
439  return SR_ERR;
440  if (write(tmpfile, metafile, len) < 0) {
441  sr_dbg("Failed to create new metadata: %s", strerror(errno));
442  g_free(metafile);
443  unlink(tmpname);
444  return SR_ERR;
445  }
446  close(tmpfile);
447  if (!(metasrc = zip_source_file(archive, tmpname, 0, -1))) {
448  sr_err("Failed to create zip source for metadata.");
449  g_free(metafile);
450  unlink(tmpname);
451  return SR_ERR;
452  }
453  if (zip_replace(archive, zs.index, metasrc) == -1) {
454  sr_err("Failed to replace metadata file.");
455  g_free(metafile);
456  unlink(tmpname);
457  return SR_ERR;
458  }
459  g_free(metafile);
460  }
461  g_key_file_free(kf);
462 
463  next_chunk_num = 1;
464  num_files = zip_get_num_entries(archive, 0);
465  for (i = 0; i < num_files; i++) {
466  entry_name = zip_get_name(archive, i, 0);
467  if (strncmp(entry_name, "logic-1", 7))
468  continue;
469  if (strlen(entry_name) == 7) {
470  /* This file has no extra chunks, just a single "logic-1".
471  * Rename it to "logic-1-1" * and continue with chunk 2. */
472  if (zip_rename(archive, i, "logic-1-1") == -1) {
473  sr_err("Failed to rename 'logic-1' to 'logic-1-1'.");
474  unlink(tmpname);
475  return SR_ERR;
476  }
477  next_chunk_num = 2;
478  break;
479  } else if (strlen(entry_name) > 8 && entry_name[7] == '-') {
480  chunk_num = strtoull(entry_name + 8, NULL, 10);
481  if (chunk_num >= next_chunk_num)
482  next_chunk_num = chunk_num + 1;
483  }
484  }
485  snprintf(chunkname, 15, "logic-1-%d", next_chunk_num);
486  if (!(logicsrc = zip_source_buffer(archive, buf, units * unitsize, FALSE))) {
487  unlink(tmpname);
488  return SR_ERR;
489  }
490  if (zip_add(archive, chunkname, logicsrc) == -1) {
491  unlink(tmpname);
492  return SR_ERR;
493  }
494  if ((ret = zip_close(archive)) == -1) {
495  sr_info("error saving session file: %s", zip_strerror(archive));
496  unlink(tmpname);
497  return SR_ERR;
498  }
499  unlink(tmpname);
500 
501  return SR_OK;
502 }
503 
504 /** @} */
Generic/unspecified error.
Definition: libsigrok.h:68
struct sr_session * session
Definition: session.c:64
int sr_dev_channel_name_set(const struct sr_dev_inst *sdi, int channelnum, const char *name)
Set the name of the specified channel in the specified device.
Definition: device.c:88
The device supports setting the number of logic channels.
Definition: libsigrok.h:735
int sr_session_dev_add(const struct sr_dev_inst *sdi)
Add a device instance to the current session.
Definition: session.c:157
SR_PRIV struct sr_dev_driver session_driver
Information on single channel.
Definition: libsigrok.h:537
Channel type is logic channel.
Definition: libsigrok.h:531
No error.
Definition: libsigrok.h:67
gboolean enabled
Is this channel enabled?
Definition: libsigrok.h:543
The public libsigrok header file to be used by frontends.
GSList * channels
List of channels.
Definition: libsigrok.h:857
The device supports specifying a capturefile to inject.
Definition: libsigrok.h:779
The device supports specifying the capturefile unit size.
Definition: libsigrok.h:782
int sr_session_append(const char *filename, unsigned char *buf, int unitsize, int units)
Append data to an existing session file.
Definition: session_file.c:387
gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
Determine whether the specified device instance has the specified capability.
Definition: device.c:233
The device instance is actively in use in a session.
Definition: libsigrok.h:885
Device instance data.
Definition: libsigrok.h:841
Opaque data structure representing a libsigrok session.
int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum, gboolean state)
Enable or disable a channel on the specified device.
Definition: device.c:127
The device supports setting its samplerate, in Hz.
Definition: libsigrok.h:654
int sr_config_get(const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, int key, GVariant **data)
Query value of a configuration key at the given driver or device instance.
Definition: hwdriver.c:609
Malloc/calloc/realloc error.
Definition: libsigrok.h:69
int sr_dev_open(struct sr_dev_inst *sdi)
Open the specified device.
Definition: device.c:497
#define SR_PRIV
Definition: libsigrok.h:129
int sr_session_save_init(const char *filename, uint64_t samplerate, char **channels)
Initialize a saved session file.
Definition: session_file.c:294
int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int channelnum, const char *trigger)
Add a trigger to the specified device (and the specified channel).
Definition: device.c:176
int type
Channel type (SR_CHANNEL_LOGIC, ...)
Definition: libsigrok.h:541
int(* init)(struct sr_context *sr_ctx)
Called when driver is loaded, e.g.
Definition: libsigrok.h:900
Device driver data.
Definition: libsigrok.h:891
#define SR_MAX_CHANNELNAME_LEN
Definition: libsigrok.h:84
Function argument error.
Definition: libsigrok.h:70
char * name
Name of channel.
Definition: libsigrok.h:545
struct sr_dev_driver * driver
Device driver.
Definition: libsigrok.h:843
struct sr_session * sr_session_new(void)
Create a new session.
Definition: session.c:77
int sr_parse_sizestring(const char *sizestring, uint64_t *size)
Convert a "natural" string representation of a size value to uint64_t.
Definition: strutil.c:479
char * sr_samplerate_string(uint64_t samplerate)
Convert a numeric samplerate value to its "natural" string representation.
Definition: strutil.c:276
int(* config_set)(int id, GVariant *data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
Set value of a configuration key in driver or a given device instance.
Definition: libsigrok.h:926
int sr_session_save(const char *filename, const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize, int units)
Save the current session to the specified file.
Definition: session_file.c:238
int sr_session_load(const char *filename)
Load the session from the specified filename.
Definition: session_file.c:110
Session filename.
Definition: libsigrok.h:776
#define SR_API
Definition: libsigrok.h:122