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