]> git.ipfire.org Git - thirdparty/util-linux.git/blob - libfdisk/src/script.c
libfdisk: fix ref.counting in fdisk_apply_script() [clang analyze]
[thirdparty/util-linux.git] / libfdisk / src / script.c
1
2 #include "fdiskP.h"
3 #include "strutils.h"
4 #include "carefulputc.h"
5
6 /**
7 * SECTION: script
8 * @title: Script
9 * @short_description: text based sfdisk compatible description of partition table
10 *
11 * The libfdisk scripts are based on original sfdisk script (dumps). Each
12 * script has two parts: script headers and partition table entries
13 * (partitions).
14 *
15 * For more details about script format see sfdisk man page.
16 */
17
18 /* script header (e.g. unit: sectors) */
19 struct fdisk_scriptheader {
20 struct list_head headers;
21 char *name;
22 char *data;
23 };
24
25 /* script control struct */
26 struct fdisk_script {
27 struct fdisk_table *table;
28 struct list_head headers;
29 struct fdisk_context *cxt;
30
31 int refcount;
32 char *(*fn_fgets)(struct fdisk_script *, char *, size_t, FILE *);
33 void *userdata;
34
35 /* parser's state */
36 size_t nlines;
37 struct fdisk_label *label;
38
39 unsigned int json : 1; /* JSON output */
40 };
41
42
43 static void fdisk_script_free_header(struct fdisk_scriptheader *fi)
44 {
45 if (!fi)
46 return;
47
48 DBG(SCRIPT, ul_debugobj(fi, "free header %s", fi->name));
49 free(fi->name);
50 free(fi->data);
51 list_del(&fi->headers);
52 free(fi);
53 }
54
55 /**
56 * fdisk_new_script:
57 * @cxt: context
58 *
59 * The script hold fdisk_table and additional information to read/write
60 * script to the file.
61 *
62 * Returns: newly allocated script struct.
63 */
64 struct fdisk_script *fdisk_new_script(struct fdisk_context *cxt)
65 {
66 struct fdisk_script *dp = NULL;
67
68 dp = calloc(1, sizeof(*dp));
69 if (!dp)
70 return NULL;
71
72 DBG(SCRIPT, ul_debugobj(dp, "alloc"));
73 dp->refcount = 1;
74 dp->cxt = cxt;
75 fdisk_ref_context(cxt);
76
77 dp->table = fdisk_new_table();
78 if (!dp->table) {
79 fdisk_unref_script(dp);
80 return NULL;
81 }
82
83 INIT_LIST_HEAD(&dp->headers);
84 return dp;
85 }
86
87 /**
88 * fdisk_new_script_from_file:
89 * @cxt: context
90 * @filename: path to the script file
91 *
92 * Allocates a new script and reads script from @filename.
93 *
94 * Returns: new script instance or NULL in case of error (check errno for more details).
95 */
96 struct fdisk_script *fdisk_new_script_from_file(struct fdisk_context *cxt,
97 const char *filename)
98 {
99 int rc;
100 FILE *f;
101 struct fdisk_script *dp, *res = NULL;
102
103 assert(cxt);
104 assert(filename);
105
106 DBG(SCRIPT, ul_debug("opening %s", filename));
107 f = fopen(filename, "r");
108 if (!f)
109 return NULL;
110
111 dp = fdisk_new_script(cxt);
112 if (!dp)
113 goto done;
114
115 rc = fdisk_script_read_file(dp, f);
116 if (rc) {
117 errno = -rc;
118 goto done;
119 }
120
121 res = dp;
122 done:
123 fclose(f);
124 if (!res)
125 fdisk_unref_script(dp);
126 else
127 errno = 0;
128
129 return res;
130 }
131
132 /**
133 * fdisk_ref_script:
134 * @dp: script pointer
135 *
136 * Incremparts reference counter.
137 */
138 void fdisk_ref_script(struct fdisk_script *dp)
139 {
140 if (dp)
141 dp->refcount++;
142 }
143
144 static void fdisk_reset_script(struct fdisk_script *dp)
145 {
146 assert(dp);
147
148 DBG(SCRIPT, ul_debugobj(dp, "reset"));
149 fdisk_unref_table(dp->table);
150 dp->table = NULL;
151
152 while (!list_empty(&dp->headers)) {
153 struct fdisk_scriptheader *fi = list_entry(dp->headers.next,
154 struct fdisk_scriptheader, headers);
155 fdisk_script_free_header(fi);
156 }
157 INIT_LIST_HEAD(&dp->headers);
158 }
159
160 /**
161 * fdisk_unref_script:
162 * @dp: script pointer
163 *
164 * De-incremparts reference counter, on zero the @dp is automatically
165 * deallocated.
166 */
167 void fdisk_unref_script(struct fdisk_script *dp)
168 {
169 if (!dp)
170 return;
171
172 dp->refcount--;
173 if (dp->refcount <= 0) {
174 fdisk_reset_script(dp);
175 fdisk_unref_context(dp->cxt);
176 DBG(SCRIPT, ul_debugobj(dp, "free script"));
177 free(dp);
178 }
179 }
180
181 /**
182 * fdisk_script_set_userdata
183 * @dp: script
184 * @data: your data
185 *
186 * Sets data usable for example in callbacks (e.g fdisk_script_set_fgets()).
187 *
188 * Returns: 0 on success, <0 on error.
189 */
190 int fdisk_script_set_userdata(struct fdisk_script *dp, void *data)
191 {
192 assert(dp);
193 dp->userdata = data;
194 return 0;
195 }
196
197 /**
198 * fdisk_script_get_userdata
199 * @dp: script
200 *
201 * Returns: user data or NULL.
202 */
203 void *fdisk_script_get_userdata(struct fdisk_script *dp)
204 {
205 assert(dp);
206 return dp->userdata;
207 }
208
209 static struct fdisk_scriptheader *script_get_header(struct fdisk_script *dp,
210 const char *name)
211 {
212 struct list_head *p;
213
214 list_for_each(p, &dp->headers) {
215 struct fdisk_scriptheader *fi = list_entry(p, struct fdisk_scriptheader, headers);
216
217 if (strcasecmp(fi->name, name) == 0)
218 return fi;
219 }
220
221 return NULL;
222 }
223
224 /**
225 * fdisk_script_get_header:
226 * @dp: script instance
227 * @name: header name
228 *
229 * Returns: pointer to header data or NULL.
230 */
231 const char *fdisk_script_get_header(struct fdisk_script *dp, const char *name)
232 {
233 struct fdisk_scriptheader *fi;
234
235 assert(dp);
236 assert(name);
237
238 fi = script_get_header(dp, name);
239 return fi ? fi->data : NULL;
240 }
241
242
243 /**
244 * fdisk_script_set_header:
245 * @dp: script instance
246 * @name: header name
247 * @data: header data (or NULL)
248 *
249 * The headers are used as global options for whole partition
250 * table, always one header per line.
251 *
252 * If no @data is specified then the header is removed. If header does not exist
253 * and @data is specified then a new header is added.
254 *
255 * Note that libfdisk allows to specify arbitrary custom header, the default
256 * build-in headers are "unit" and "label", and some label specific headers
257 * (for example "uuid" and "name" for GPT).
258 *
259 * Returns: 0 on success, <0 on error
260 */
261 int fdisk_script_set_header(struct fdisk_script *dp,
262 const char *name,
263 const char *data)
264 {
265 struct fdisk_scriptheader *fi;
266
267 if (!dp || !name)
268 return -EINVAL;
269
270 fi = script_get_header(dp, name);
271 if (!fi && !data)
272 return 0; /* want to remove header that does not exist, success */
273
274 if (!data) {
275 DBG(SCRIPT, ul_debugobj(dp, "freeing header %s", name));
276
277 /* no data, remove the header */
278 fdisk_script_free_header(fi);
279 return 0;
280 }
281
282 if (!fi) {
283 DBG(SCRIPT, ul_debugobj(dp, "setting new header %s='%s'", name, data));
284
285 /* new header */
286 fi = calloc(1, sizeof(*fi));
287 if (!fi)
288 return -ENOMEM;
289 INIT_LIST_HEAD(&fi->headers);
290 fi->name = strdup(name);
291 fi->data = strdup(data);
292 if (!fi->data || !fi->name) {
293 fdisk_script_free_header(fi);
294 return -ENOMEM;
295 }
296 list_add_tail(&fi->headers, &dp->headers);
297 } else {
298 /* update existing */
299 char *x = strdup(data);
300
301 DBG(SCRIPT, ul_debugobj(dp, "update '%s' header '%s' -> '%s'", name, fi->data, data));
302
303 if (!x)
304 return -ENOMEM;
305 free(fi->data);
306 fi->data = x;
307 }
308
309 if (strcmp(name, "label") == 0)
310 dp->label = NULL;
311
312 return 0;
313 }
314
315 /**
316 * fdisk_script_get_table:
317 * @dp: script
318 *
319 * The table (container with partitions) is possible to create by
320 * fdisk_script_read_context() or fdisk_script_read_file(), otherwise
321 * this function returns NULL.
322 *
323 * Returns: NULL or script.
324 */
325 struct fdisk_table *fdisk_script_get_table(struct fdisk_script *dp)
326 {
327 assert(dp);
328 return dp ? dp->table : NULL;
329 }
330
331 static struct fdisk_label *script_get_label(struct fdisk_script *dp)
332 {
333 assert(dp);
334 assert(dp->cxt);
335
336 if (!dp->label) {
337 dp->label = fdisk_get_label(dp->cxt,
338 fdisk_script_get_header(dp, "label"));
339 DBG(SCRIPT, ul_debugobj(dp, "label '%s'", dp->label ? dp->label->name : ""));
340 }
341 return dp->label;
342 }
343
344 /**
345 * fdisk_script_get_nlines:
346 * @dp: script
347 *
348 * Returns: number of parsed lines or <0 on error.
349 */
350 int fdisk_script_get_nlines(struct fdisk_script *dp)
351 {
352 assert(dp);
353 return dp->nlines;
354 }
355
356 /**
357 * fdisk_script_read_context:
358 * @dp: script
359 * @cxt: context
360 *
361 * Reads data from the @cxt context (on disk partition table) into the script.
362 * If the context is no specified than defaults to context used for fdisk_new_script().
363 *
364 * Return: 0 on success, <0 on error.
365 */
366 int fdisk_script_read_context(struct fdisk_script *dp, struct fdisk_context *cxt)
367 {
368 struct fdisk_label *lb;
369 int rc;
370 char *p = NULL;
371
372 if (!dp || (!cxt && !dp->cxt))
373 return -EINVAL;
374
375 if (!cxt)
376 cxt = dp->cxt;
377
378 DBG(SCRIPT, ul_debugobj(dp, "reading context into script"));
379 fdisk_reset_script(dp);
380
381 lb = fdisk_get_label(cxt, NULL);
382 if (!lb)
383 return -EINVAL;
384
385 /* allocate and fill new table */
386 rc = fdisk_get_partitions(cxt, &dp->table);
387 if (rc)
388 return rc;
389
390 /* generate headers */
391 rc = fdisk_script_set_header(dp, "label", fdisk_label_get_name(lb));
392
393 if (!rc && fdisk_get_disklabel_id(cxt, &p) == 0 && p) {
394 rc = fdisk_script_set_header(dp, "label-id", p);
395 free(p);
396 }
397 if (!rc && cxt->dev_path)
398 rc = fdisk_script_set_header(dp, "device", cxt->dev_path);
399 if (!rc)
400 rc = fdisk_script_set_header(dp, "unit", "sectors");
401
402 if (!rc && fdisk_is_label(cxt, GPT)) {
403 struct fdisk_labelitem item;
404 char buf[64];
405
406 rc = fdisk_get_disklabel_item(cxt, GPT_LABELITEM_FIRSTLBA, &item);
407 if (rc == 0) {
408 snprintf(buf, sizeof(buf), "%"PRIu64, item.data.num64);
409 rc = fdisk_script_set_header(dp, "first-lba", buf);
410 }
411 if (rc < 0)
412 goto done;
413
414 rc = fdisk_get_disklabel_item(cxt, GPT_LABELITEM_LASTLBA, &item);
415 if (rc == 0) {
416 snprintf(buf, sizeof(buf), "%"PRIu64, item.data.num64);
417 rc = fdisk_script_set_header(dp, "last-lba", buf);
418 }
419 if (rc < 0)
420 goto done;
421 }
422
423 done:
424 DBG(SCRIPT, ul_debugobj(dp, "read context done [rc=%d]", rc));
425 return rc;
426 }
427
428 /**
429 * fdisk_script_enable_json:
430 * @dp: script
431 * @json: 0 or 1
432 *
433 * Disable/Enable JSON output format.
434 *
435 * Returns: 0 on success, <0 on error.
436 */
437 int fdisk_script_enable_json(struct fdisk_script *dp, int json)
438 {
439 assert(dp);
440
441 dp->json = json;
442 return 0;
443 }
444
445 static void fput_indent(int indent, FILE *f)
446 {
447 int i;
448
449 for (i = 0; i <= indent; i++)
450 fputs(" ", f);
451 }
452
453 static int write_file_json(struct fdisk_script *dp, FILE *f)
454 {
455 struct list_head *h;
456 struct fdisk_partition *pa;
457 struct fdisk_iter itr;
458 const char *devname = NULL;
459 int ct = 0, indent = 0;
460
461 assert(dp);
462 assert(f);
463
464 DBG(SCRIPT, ul_debugobj(dp, "writing json dump to file"));
465
466 fputs("{\n", f);
467
468 fput_indent(indent, f);
469 fputs("\"partitiontable\": {\n", f);
470 indent++;
471
472 /* script headers */
473 list_for_each(h, &dp->headers) {
474 struct fdisk_scriptheader *fi = list_entry(h, struct fdisk_scriptheader, headers);
475 const char *name = fi->name;
476 int num = 0;
477
478 if (strcmp(name, "first-lba") == 0) {
479 name = "firstlba";
480 num = 1;
481 } else if (strcmp(name, "last-lba") == 0) {
482 name = "lastlba";
483 num = 1;
484 } else if (strcmp(name, "label-id") == 0)
485 name = "id";
486
487 fput_indent(indent, f);
488 fputs_quoted_lower(name, f);
489 fputs(": ", f);
490 if (!num)
491 fputs_quoted(fi->data, f);
492 else
493 fputs(fi->data, f);
494 if (!dp->table && fi == list_last_entry(&dp->headers, struct fdisk_scriptheader, headers))
495 fputc('\n', f);
496 else
497 fputs(",\n", f);
498
499 if (strcmp(name, "device") == 0)
500 devname = fi->data;
501 }
502
503
504 if (!dp->table) {
505 DBG(SCRIPT, ul_debugobj(dp, "script table empty"));
506 goto done;
507 }
508
509 DBG(SCRIPT, ul_debugobj(dp, "%zu entries", fdisk_table_get_nents(dp->table)));
510
511 fput_indent(indent, f);
512 fputs("\"partitions\": [\n", f);
513 indent++;
514
515 fdisk_reset_iter(&itr, FDISK_ITER_FORWARD);
516 while (fdisk_table_next_partition(dp->table, &itr, &pa) == 0) {
517 char *p = NULL;
518
519 ct++;
520 fput_indent(indent, f);
521 fputc('{', f);
522 if (devname)
523 p = fdisk_partname(devname, pa->partno + 1);
524 if (p) {
525 DBG(SCRIPT, ul_debugobj(dp, "write %s entry", p));
526 fputs("\"node\": ", f);
527 fputs_quoted(p, f);
528 }
529
530 if (fdisk_partition_has_start(pa))
531 fprintf(f, ", \"start\": %ju", (uintmax_t)pa->start);
532 if (fdisk_partition_has_size(pa))
533 fprintf(f, ", \"size\": %ju", (uintmax_t)pa->size);
534
535 if (pa->type && fdisk_parttype_get_string(pa->type))
536 fprintf(f, ", \"type\": \"%s\"", fdisk_parttype_get_string(pa->type));
537 else if (pa->type)
538 fprintf(f, ", \"type\": \"%x\"", fdisk_parttype_get_code(pa->type));
539
540 if (pa->uuid)
541 fprintf(f, ", \"uuid\": \"%s\"", pa->uuid);
542 if (pa->name && *pa->name) {
543 fputs(", \"name\": ", f),
544 fputs_quoted(pa->name, f);
545 }
546
547 /* for MBR attr=80 means bootable */
548 if (pa->attrs) {
549 struct fdisk_label *lb = script_get_label(dp);
550
551 if (!lb || fdisk_label_get_type(lb) != FDISK_DISKLABEL_DOS)
552 fprintf(f, ", \"attrs\": \"%s\"", pa->attrs);
553 }
554 if (fdisk_partition_is_bootable(pa))
555 fprintf(f, ", \"bootable\": true");
556
557 if ((size_t)ct < fdisk_table_get_nents(dp->table))
558 fputs("},\n", f);
559 else
560 fputs("}\n", f);
561 }
562
563 indent--;
564 fput_indent(indent, f);
565 fputs("]\n", f);
566 done:
567 indent--;
568 fput_indent(indent, f);
569 fputs("}\n}\n", f);
570
571 DBG(SCRIPT, ul_debugobj(dp, "write script done"));
572 return 0;
573 }
574
575 static int write_file_sfdisk(struct fdisk_script *dp, FILE *f)
576 {
577 struct list_head *h;
578 struct fdisk_partition *pa;
579 struct fdisk_iter itr;
580 const char *devname = NULL;
581
582 assert(dp);
583 assert(f);
584
585 DBG(SCRIPT, ul_debugobj(dp, "writing sfdisk-like script to file"));
586
587 /* script headers */
588 list_for_each(h, &dp->headers) {
589 struct fdisk_scriptheader *fi = list_entry(h, struct fdisk_scriptheader, headers);
590 fprintf(f, "%s: %s\n", fi->name, fi->data);
591 if (strcmp(fi->name, "device") == 0)
592 devname = fi->data;
593 }
594
595 if (!dp->table) {
596 DBG(SCRIPT, ul_debugobj(dp, "script table empty"));
597 return 0;
598 }
599
600 DBG(SCRIPT, ul_debugobj(dp, "%zu entries", fdisk_table_get_nents(dp->table)));
601
602 fputc('\n', f);
603
604 fdisk_reset_iter(&itr, FDISK_ITER_FORWARD);
605 while (fdisk_table_next_partition(dp->table, &itr, &pa) == 0) {
606 char *p = NULL;
607
608 if (devname)
609 p = fdisk_partname(devname, pa->partno + 1);
610 if (p) {
611 DBG(SCRIPT, ul_debugobj(dp, "write %s entry", p));
612 fprintf(f, "%s :", p);
613 } else
614 fprintf(f, "%zu :", pa->partno + 1);
615
616 if (fdisk_partition_has_start(pa))
617 fprintf(f, " start=%12ju", (uintmax_t)pa->start);
618 if (fdisk_partition_has_size(pa))
619 fprintf(f, ", size=%12ju", (uintmax_t)pa->size);
620
621 if (pa->type && fdisk_parttype_get_string(pa->type))
622 fprintf(f, ", type=%s", fdisk_parttype_get_string(pa->type));
623 else if (pa->type)
624 fprintf(f, ", type=%x", fdisk_parttype_get_code(pa->type));
625
626 if (pa->uuid)
627 fprintf(f, ", uuid=%s", pa->uuid);
628 if (pa->name && *pa->name)
629 fprintf(f, ", name=\"%s\"", pa->name);
630
631 /* for MBR attr=80 means bootable */
632 if (pa->attrs) {
633 struct fdisk_label *lb = script_get_label(dp);
634
635 if (!lb || fdisk_label_get_type(lb) != FDISK_DISKLABEL_DOS)
636 fprintf(f, ", attrs=\"%s\"", pa->attrs);
637 }
638 if (fdisk_partition_is_bootable(pa))
639 fprintf(f, ", bootable");
640 fputc('\n', f);
641 }
642
643 DBG(SCRIPT, ul_debugobj(dp, "write script done"));
644 return 0;
645 }
646
647 /**
648 * fdisk_script_write_file:
649 * @dp: script
650 * @f: output file
651 *
652 * Writes script @dp to the ile @f.
653 *
654 * Returns: 0 on success, <0 on error.
655 */
656 int fdisk_script_write_file(struct fdisk_script *dp, FILE *f)
657 {
658 assert(dp);
659
660 if (dp->json)
661 return write_file_json(dp, f);
662
663 return write_file_sfdisk(dp, f);
664 }
665
666 static inline int is_header_line(const char *s)
667 {
668 const char *p = strchr(s, ':');
669
670 if (!p || p == s || !*(p + 1) || strchr(s, '='))
671 return 0;
672
673 return 1;
674 }
675
676 /* parses "<name>: value", note modifies @s*/
677 static int parse_line_header(struct fdisk_script *dp, char *s)
678 {
679 int rc = -EINVAL;
680 char *name, *value;
681
682 DBG(SCRIPT, ul_debugobj(dp, " parse header '%s'", s));
683
684 if (!s || !*s)
685 return -EINVAL;
686
687 name = s;
688 value = strchr(s, ':');
689 if (!value)
690 goto done;
691 *value = '\0';
692 value++;
693
694 ltrim_whitespace((unsigned char *) name);
695 rtrim_whitespace((unsigned char *) name);
696 ltrim_whitespace((unsigned char *) value);
697 rtrim_whitespace((unsigned char *) value);
698
699 if (strcmp(name, "label") == 0) {
700 if (dp->cxt && !fdisk_get_label(dp->cxt, value))
701 goto done; /* unknown label name */
702 } else if (strcmp(name, "unit") == 0) {
703 if (strcmp(value, "sectors") != 0)
704 goto done; /* only "sectors" supported */
705 } else if (strcmp(name, "label-id") == 0
706 || strcmp(name, "device") == 0
707 || strcmp(name, "first-lba") == 0
708 || strcmp(name, "last-lba") == 0) {
709 ; /* whatever is posssible */
710 } else
711 goto done; /* unknown header */
712
713 if (*name && *value)
714 rc = fdisk_script_set_header(dp, name, value);
715 done:
716 if (rc)
717 DBG(SCRIPT, ul_debugobj(dp, "header parse error: "
718 "[rc=%d, name='%s', value='%s']",
719 rc, name, value));
720 return rc;
721
722 }
723
724 /* returns zero terminated string with next token and @str is updated */
725 static char *next_token(char **str)
726 {
727 char *tk_begin = NULL,
728 *tk_end = NULL,
729 *end = NULL,
730 *p;
731 int open_quote = 0;
732
733 for (p = *str; p && *p; p++) {
734 if (!tk_begin) {
735 if (isblank(*p))
736 continue;
737 tk_begin = *p == '"' ? p + 1 : p;
738 }
739 if (*p == '"')
740 open_quote ^= 1;
741 if (open_quote)
742 continue;
743 if (isblank(*p) || *p == ',' || *p == ';' || *p == '"' )
744 tk_end = p;
745 else if (*(p + 1) == '\0')
746 tk_end = p + 1;
747 if (tk_begin && tk_end)
748 break;
749 }
750
751 if (!tk_end)
752 return NULL;
753 end = isblank(*tk_end) ? (char *) skip_blank(tk_end) : tk_end;
754 if (*end == ',' || *end == ';')
755 end++;
756
757 *tk_end = '\0';
758 *str = end;
759 return tk_begin;
760 }
761
762 static int next_number(char **s, uint64_t *num, int *power)
763 {
764 char *tk;
765 int rc = -EINVAL;
766
767 assert(num);
768 assert(s);
769
770 tk = next_token(s);
771 if (tk)
772 rc = parse_size(tk, (uintmax_t *) num, power);
773 return rc;
774 }
775
776 static int next_string(char **s, char **str)
777 {
778 char *tk;
779 int rc = -EINVAL;
780
781 assert(s);
782 assert(str);
783
784 tk = next_token(s);
785 if (tk) {
786 *str = strdup(tk);
787 rc = !*str ? -ENOMEM : 0;
788 }
789 return rc;
790 }
791
792 static int partno_from_devname(char *s)
793 {
794 int pno;
795 size_t sz;
796 char *end, *p;
797
798 sz = rtrim_whitespace((unsigned char *)s);
799 p = s + sz - 1;
800
801 while (p > s && isdigit(*(p - 1)))
802 p--;
803
804 errno = 0;
805 pno = strtol(p, &end, 10);
806 if (errno || !end || p == end)
807 return -1;
808 return pno - 1;
809 }
810
811 /* dump format
812 * <device>: start=<num>, size=<num>, type=<string>, ...
813 */
814 static int parse_line_nameval(struct fdisk_script *dp, char *s)
815 {
816 char *p, *x;
817 struct fdisk_partition *pa;
818 int rc = 0;
819 uint64_t num;
820 int pno;
821
822 assert(dp);
823 assert(s);
824
825 DBG(SCRIPT, ul_debugobj(dp, " parse script line: '%s'", s));
826
827 pa = fdisk_new_partition();
828 if (!pa)
829 return -ENOMEM;
830
831 fdisk_partition_start_follow_default(pa, 1);
832 fdisk_partition_end_follow_default(pa, 1);
833 fdisk_partition_partno_follow_default(pa, 1);
834
835 /* set partno */
836 p = strchr(s, ':');
837 x = strchr(s, '=');
838 if (p && (!x || p < x)) {
839 *p = '\0';
840 p++;
841
842 pno = partno_from_devname(s);
843 if (pno >= 0) {
844 fdisk_partition_partno_follow_default(pa, 0);
845 fdisk_partition_set_partno(pa, pno);
846 }
847 } else
848 p = s;
849
850 while (rc == 0 && p && *p) {
851
852 DBG(SCRIPT, ul_debugobj(dp, " parsing '%s'", p));
853 p = (char *) skip_blank(p);
854
855 if (!strncasecmp(p, "start=", 6)) {
856 int pow = 0;
857 p += 6;
858 rc = next_number(&p, &num, &pow);
859 if (!rc) {
860 if (pow) /* specified as <num><suffix> */
861 num /= dp->cxt->sector_size;
862 fdisk_partition_set_start(pa, num);
863 fdisk_partition_start_follow_default(pa, 0);
864 }
865 } else if (!strncasecmp(p, "size=", 5)) {
866 int pow = 0;
867
868 p += 5;
869 rc = next_number(&p, &num, &pow);
870 if (!rc) {
871 if (pow) /* specified as <num><suffix> */
872 num /= dp->cxt->sector_size;
873 else /* specified as number of sectors */
874 fdisk_partition_size_explicit(pa, 1);
875 fdisk_partition_set_size(pa, num);
876 fdisk_partition_end_follow_default(pa, 0);
877 }
878
879 } else if (!strncasecmp(p, "bootable", 8)) {
880 char *tk = next_token(&p);
881 if (strcmp(tk, "bootable") == 0)
882 pa->boot = 1;
883 else
884 rc = -EINVAL;
885
886 } else if (!strncasecmp(p, "attrs=", 6)) {
887 p += 6;
888 rc = next_string(&p, &pa->attrs);
889
890 } else if (!strncasecmp(p, "uuid=", 5)) {
891 p += 5;
892 rc = next_string(&p, &pa->uuid);
893
894 } else if (!strncasecmp(p, "name=", 5)) {
895 p += 5;
896 rc = next_string(&p, &pa->name);
897
898 } else if (!strncasecmp(p, "type=", 5) ||
899
900 !strncasecmp(p, "Id=", 3)) { /* backward compatiility */
901 char *type;
902
903 p += (*p == 'I' ? 3 : 5); /* "Id=" or "type=" */
904
905 rc = next_string(&p, &type);
906 if (rc)
907 break;
908 pa->type = fdisk_label_parse_parttype(
909 script_get_label(dp), type);
910 free(type);
911
912 if (!pa->type) {
913 rc = -EINVAL;
914 fdisk_unref_parttype(pa->type);
915 pa->type = NULL;
916 break;
917 }
918
919 } else {
920 DBG(SCRIPT, ul_debugobj(dp, "script parse error: unknown field '%s'", p));
921 rc = -EINVAL;
922 break;
923 }
924 }
925
926 if (!rc)
927 rc = fdisk_table_add_partition(dp->table, pa);
928 if (rc)
929 DBG(SCRIPT, ul_debugobj(dp, "script parse error: [rc=%d]", rc));
930
931 fdisk_unref_partition(pa);
932 return rc;
933 }
934
935 /* original sfdisk supports partition types shortcuts like 'L' = Linux native
936 */
937 static struct fdisk_parttype *translate_type_shortcuts(struct fdisk_script *dp, char *str)
938 {
939 struct fdisk_label *lb;
940 const char *type = NULL;
941
942 if (strlen(str) != 1)
943 return NULL;
944
945 lb = script_get_label(dp);
946 if (!lb)
947 return NULL;
948
949 if (lb->id == FDISK_DISKLABEL_DOS) {
950 switch (*str) {
951 case 'L': /* Linux */
952 type = "83";
953 break;
954 case 'S': /* Swap */
955 type = "82";
956 break;
957 case 'E': /* Dos extended */
958 type = "05";
959 break;
960 case 'X': /* Linux extended */
961 type = "85";
962 break;
963 case 'U': /* UEFI system */
964 type = "EF";
965 break;
966 }
967 } else if (lb->id == FDISK_DISKLABEL_GPT) {
968 switch (*str) {
969 case 'L': /* Linux */
970 type = "0FC63DAF-8483-4772-8E79-3D69D8477DE4";
971 break;
972 case 'S': /* Swap */
973 type = "0657FD6D-A4AB-43C4-84E5-0933C84B4F4F";
974 break;
975 case 'H': /* Home */
976 type = "933AC7E1-2EB4-4F13-B844-0E14E2AEF915";
977 break;
978 case 'U': /* UEFI system */
979 type = "C12A7328-F81F-11D2-BA4B-00A0C93EC93B";
980 break;
981 }
982 }
983
984 return type ? fdisk_label_parse_parttype(lb, type) : NULL;
985 }
986
987 #define TK_PLUS 1
988 #define TK_MINUS -1
989
990 #define alone_sign(_sign, _p) (_sign && (*_p == '\0' || isblank(*_p)))
991
992 /* simple format:
993 * <start>, <size>, <type>, <bootable>, ...
994 */
995 static int parse_line_valcommas(struct fdisk_script *dp, char *s)
996 {
997 int rc = 0;
998 char *p = s, *str;
999 struct fdisk_partition *pa;
1000 enum { ITEM_START, ITEM_SIZE, ITEM_TYPE, ITEM_BOOTABLE };
1001 int item = -1;
1002
1003 assert(dp);
1004 assert(s);
1005
1006 pa = fdisk_new_partition();
1007 if (!pa)
1008 return -ENOMEM;
1009
1010 fdisk_partition_start_follow_default(pa, 1);
1011 fdisk_partition_end_follow_default(pa, 1);
1012 fdisk_partition_partno_follow_default(pa, 1);
1013
1014 while (rc == 0 && p && *p) {
1015 uint64_t num;
1016 char *begin;
1017 int sign = 0;
1018
1019 p = (char *) skip_blank(p);
1020 item++;
1021
1022 if (item != ITEM_BOOTABLE) {
1023 sign = *p == '-' ? TK_MINUS : *p == '+' ? TK_PLUS : 0;
1024 if (sign)
1025 p++;
1026 }
1027
1028 DBG(SCRIPT, ul_debugobj(dp, " parsing item %d ('%s')", item, p));
1029 begin = p;
1030
1031 switch (item) {
1032 case ITEM_START:
1033 if (*p == ',' || *p == ';' || alone_sign(sign, p))
1034 fdisk_partition_start_follow_default(pa, 1);
1035 else {
1036 int pow = 0;
1037
1038 rc = next_number(&p, &num, &pow);
1039 if (!rc) {
1040 if (pow) /* specified as <num><suffix> */
1041 num /= dp->cxt->sector_size;
1042 fdisk_partition_set_start(pa, num);
1043 pa->movestart = sign == TK_MINUS ? FDISK_MOVE_DOWN :
1044 sign == TK_PLUS ? FDISK_MOVE_UP :
1045 FDISK_MOVE_NONE;
1046 }
1047 fdisk_partition_start_follow_default(pa, 0);
1048 }
1049 break;
1050 case ITEM_SIZE:
1051 if (*p == ',' || *p == ';' || alone_sign(sign, p)) {
1052 fdisk_partition_end_follow_default(pa, 1);
1053 if (sign == TK_PLUS)
1054 /* alone '+' means use all possible space, elone '-' means nothing */
1055 pa->resize = FDISK_RESIZE_ENLARGE;
1056 } else {
1057 int pow = 0;
1058 rc = next_number(&p, &num, &pow);
1059 if (!rc) {
1060 if (pow) /* specified as <size><suffix> */
1061 num /= dp->cxt->sector_size;
1062 else /* specified as number of sectors */
1063 fdisk_partition_size_explicit(pa, 1);
1064 fdisk_partition_set_size(pa, num);
1065 pa->resize = sign == TK_MINUS ? FDISK_RESIZE_REDUCE :
1066 sign == TK_PLUS ? FDISK_RESIZE_ENLARGE :
1067 FDISK_RESIZE_NONE;
1068 }
1069 fdisk_partition_end_follow_default(pa, 0);
1070 }
1071 break;
1072 case ITEM_TYPE:
1073 if (*p == ',' || *p == ';' || alone_sign(sign, p))
1074 break; /* use default type */
1075
1076 rc = next_string(&p, &str);
1077 if (rc)
1078 break;
1079
1080 pa->type = translate_type_shortcuts(dp, str);
1081 if (!pa->type)
1082 pa->type = fdisk_label_parse_parttype(
1083 script_get_label(dp), str);
1084 free(str);
1085
1086 if (!pa->type) {
1087 rc = -EINVAL;
1088 fdisk_unref_parttype(pa->type);
1089 pa->type = NULL;
1090 break;
1091 }
1092 break;
1093 case ITEM_BOOTABLE:
1094 if (*p == ',' || *p == ';')
1095 break;
1096 else {
1097 char *tk = next_token(&p);
1098 if (tk && *tk == '*' && *(tk + 1) == '\0')
1099 pa->boot = 1;
1100 else if (tk && *tk == '-' && *(tk + 1) == '\0')
1101 pa->boot = 0;
1102 else if (tk && *tk == '+' && *(tk + 1) == '\0')
1103 pa->boot = 1;
1104 else
1105 rc = -EINVAL;
1106 }
1107 break;
1108 default:
1109 break;
1110 }
1111
1112 if (begin == p)
1113 p++;
1114 }
1115
1116 if (!rc)
1117 rc = fdisk_table_add_partition(dp->table, pa);
1118 if (rc)
1119 DBG(SCRIPT, ul_debugobj(dp, "script parse error: [rc=%d]", rc));
1120
1121 fdisk_unref_partition(pa);
1122 return rc;
1123 }
1124
1125 /* modifies @s ! */
1126 static int fdisk_script_read_buffer(struct fdisk_script *dp, char *s)
1127 {
1128 int rc = 0;
1129
1130 assert(dp);
1131 assert(s);
1132
1133 DBG(SCRIPT, ul_debugobj(dp, " parsing buffer"));
1134
1135 s = (char *) skip_blank(s);
1136 if (!s || !*s)
1137 return 0; /* nothing baby, ignore */
1138
1139 if (!dp->table) {
1140 dp->table = fdisk_new_table();
1141 if (!dp->table)
1142 return -ENOMEM;
1143 }
1144
1145 /* parse header lines only if no partition specified yet */
1146 if (fdisk_table_is_empty(dp->table) && is_header_line(s))
1147 rc = parse_line_header(dp, s);
1148
1149 /* parse script format */
1150 else if (strchr(s, '='))
1151 rc = parse_line_nameval(dp, s);
1152
1153 /* parse simple <value>, ... format */
1154 else
1155 rc = parse_line_valcommas(dp, s);
1156
1157 if (rc)
1158 DBG(SCRIPT, ul_debugobj(dp, "%zu: parse error [rc=%d]",
1159 dp->nlines, rc));
1160 return rc;
1161 }
1162
1163 /**
1164 * fdisk_script_set_fgets:
1165 * @dp: script
1166 * @fn_fgets: callback function
1167 *
1168 * The library uses fgets() function to read the next line from the script.
1169 * This default maybe overrided to another function. Note that the function has
1170 * to return the line terminated by \n (for example readline(3) removes \n).
1171 *
1172 * Return: 0 on success, <0 on error
1173 */
1174 int fdisk_script_set_fgets(struct fdisk_script *dp,
1175 char *(*fn_fgets)(struct fdisk_script *, char *, size_t, FILE *))
1176 {
1177 assert(dp);
1178
1179 dp->fn_fgets = fn_fgets;
1180 return 0;
1181 }
1182
1183 /**
1184 * fdisk_script_read_line:
1185 * @dp: script
1186 * @f: file
1187 * @buf: buffer to store one line of the file
1188 * @bufsz: buffer size
1189 *
1190 * Reads next line into dump.
1191 *
1192 * Returns: 0 on success, <0 on error, 1 when nothing to read.
1193 */
1194 int fdisk_script_read_line(struct fdisk_script *dp, FILE *f, char *buf, size_t bufsz)
1195 {
1196 char *s;
1197
1198 assert(dp);
1199 assert(f);
1200
1201 DBG(SCRIPT, ul_debugobj(dp, " parsing line %zu", dp->nlines));
1202
1203 /* read the next non-blank non-comment line */
1204 do {
1205 if (dp->fn_fgets) {
1206 if (dp->fn_fgets(dp, buf, bufsz, f) == NULL)
1207 return 1;
1208 } else if (fgets(buf, bufsz, f) == NULL)
1209 return 1;
1210
1211 dp->nlines++;
1212 s = strchr(buf, '\n');
1213 if (!s) {
1214 /* Missing final newline? Otherwise an extremely */
1215 /* long line - assume file was corrupted */
1216 if (feof(f)) {
1217 DBG(SCRIPT, ul_debugobj(dp, "no final newline"));
1218 s = strchr(buf, '\0');
1219 } else {
1220 DBG(SCRIPT, ul_debugobj(dp,
1221 "%zu: missing newline at line", dp->nlines));
1222 return -EINVAL;
1223 }
1224 }
1225
1226 *s = '\0';
1227 if (--s >= buf && *s == '\r')
1228 *s = '\0';
1229 s = (char *) skip_blank(buf);
1230 } while (*s == '\0' || *s == '#');
1231
1232 return fdisk_script_read_buffer(dp, s);
1233 }
1234
1235
1236 /**
1237 * fdisk_script_read_file:
1238 * @dp: script
1239 * @f: input file
1240 *
1241 * Reads file @f into script @dp.
1242 *
1243 * Returns: 0 on success, <0 on error.
1244 */
1245 int fdisk_script_read_file(struct fdisk_script *dp, FILE *f)
1246 {
1247 char buf[BUFSIZ];
1248 int rc = 1;
1249
1250 assert(dp);
1251 assert(f);
1252
1253 DBG(SCRIPT, ul_debugobj(dp, "parsing file"));
1254
1255 while (!feof(f)) {
1256 rc = fdisk_script_read_line(dp, f, buf, sizeof(buf));
1257 if (rc)
1258 break;
1259 }
1260
1261 if (rc == 1)
1262 rc = 0; /* end of file */
1263
1264 DBG(SCRIPT, ul_debugobj(dp, "parsing file done [rc=%d]", rc));
1265 return rc;
1266 }
1267
1268 /**
1269 * fdisk_set_script:
1270 * @cxt: context
1271 * @dp: script (or NULL to remove previous reference)
1272 *
1273 * Sets reference to the @dp script and remove reference to the previously used
1274 * script.
1275 *
1276 * The script headers might be used by label drivers to overwrite
1277 * built-in defaults (for example disk label Id) and label driver might
1278 * optimize the default semantic to be more usable for scripts (for example to
1279 * not ask for primary/logical/extended partition type).
1280 *
1281 * Note that script also contains reference to the fdisk context (see
1282 * fdisk_new_script()). This context may be completely independent on
1283 * context used for fdisk_set_script().
1284 *
1285 * Returns: <0 on error, 0 on success.
1286 */
1287 int fdisk_set_script(struct fdisk_context *cxt, struct fdisk_script *dp)
1288 {
1289 assert(cxt);
1290
1291 /* unref old */
1292 if (cxt->script)
1293 fdisk_unref_script(cxt->script);
1294
1295 /* ref new */
1296 cxt->script = dp;
1297 if (cxt->script) {
1298 DBG(CXT, ul_debugobj(cxt, "setting reference to script %p", cxt->script));
1299 fdisk_ref_script(cxt->script);
1300 }
1301
1302 return 0;
1303 }
1304
1305 /**
1306 * fdisk_get_script:
1307 * @cxt: context
1308 *
1309 * Returns: the current script or NULL.
1310 */
1311 struct fdisk_script *fdisk_get_script(struct fdisk_context *cxt)
1312 {
1313 assert(cxt);
1314 return cxt->script;
1315 }
1316
1317 /**
1318 * fdisk_apply_script_headers:
1319 * @cxt: context
1320 * @dp: script
1321 *
1322 * Associte context @cxt with script @dp and creates a new empty disklabel.
1323 *
1324 * Returns: 0 on success, <0 on error.
1325 */
1326 int fdisk_apply_script_headers(struct fdisk_context *cxt, struct fdisk_script *dp)
1327 {
1328 const char *name;
1329
1330 assert(cxt);
1331 assert(dp);
1332
1333 DBG(SCRIPT, ul_debugobj(dp, "applying script headers"));
1334 fdisk_set_script(cxt, dp);
1335
1336 /* create empty label */
1337 name = fdisk_script_get_header(dp, "label");
1338 if (!name)
1339 return -EINVAL;
1340
1341 return fdisk_create_disklabel(cxt, name);
1342 }
1343
1344 /**
1345 * fdisk_apply_script:
1346 * @cxt: context
1347 * @dp: script
1348 *
1349 * This function creates a new disklabel and partition within context @cxt. You
1350 * have to call fdisk_write_disklabel() to apply changes to the device.
1351 *
1352 * Returns: 0 on error, <0 on error.
1353 */
1354 int fdisk_apply_script(struct fdisk_context *cxt, struct fdisk_script *dp)
1355 {
1356 int rc;
1357 struct fdisk_script *old;
1358
1359 assert(dp);
1360 assert(cxt);
1361
1362 DBG(CXT, ul_debugobj(cxt, "applying script %p", dp));
1363
1364 old = fdisk_get_script(cxt);
1365 fdisk_ref_script(old);
1366
1367 /* create empty disk label */
1368 rc = fdisk_apply_script_headers(cxt, dp);
1369
1370 /* create partitions */
1371 if (!rc && dp->table)
1372 rc = fdisk_apply_table(cxt, dp->table);
1373
1374 fdisk_set_script(cxt, old);
1375 fdisk_unref_script(old);
1376
1377 DBG(CXT, ul_debugobj(cxt, "script done [rc=%d]", rc));
1378 return rc;
1379 }
1380
1381 #ifdef TEST_PROGRAM
1382 static int test_dump(struct fdisk_test *ts, int argc, char *argv[])
1383 {
1384 char *devname = argv[1];
1385 struct fdisk_context *cxt;
1386 struct fdisk_script *dp;
1387
1388 cxt = fdisk_new_context();
1389 fdisk_assign_device(cxt, devname, 1);
1390
1391 dp = fdisk_new_script(cxt);
1392 fdisk_script_read_context(dp, NULL);
1393
1394 fdisk_script_write_file(dp, stdout);
1395 fdisk_unref_script(dp);
1396 fdisk_unref_context(cxt);
1397
1398 return 0;
1399 }
1400
1401 static int test_read(struct fdisk_test *ts, int argc, char *argv[])
1402 {
1403 char *filename = argv[1];
1404 struct fdisk_script *dp;
1405 struct fdisk_context *cxt;
1406 FILE *f;
1407
1408 if (!(f = fopen(filename, "r")))
1409 err(EXIT_FAILURE, "%s: cannot open", filename);
1410
1411 cxt = fdisk_new_context();
1412 dp = fdisk_new_script(cxt);
1413
1414 fdisk_script_read_file(dp, f);
1415 fclose(f);
1416
1417 fdisk_script_write_file(dp, stdout);
1418 fdisk_unref_script(dp);
1419 fdisk_unref_context(cxt);
1420
1421 return 0;
1422 }
1423
1424 static int test_stdin(struct fdisk_test *ts, int argc, char *argv[])
1425 {
1426 char buf[BUFSIZ];
1427 struct fdisk_script *dp;
1428 struct fdisk_context *cxt;
1429 int rc = 0;
1430
1431 cxt = fdisk_new_context();
1432 dp = fdisk_new_script(cxt);
1433 fdisk_script_set_header(dp, "label", "dos");
1434
1435 printf("<start>, <size>, <type>, <bootable: *|->\n");
1436 do {
1437 struct fdisk_partition *pa;
1438 size_t n = fdisk_table_get_nents(dp->table);
1439
1440 printf(" #%zu :\n", n + 1);
1441 rc = fdisk_script_read_line(dp, stdin, buf, sizeof(buf));
1442
1443 if (rc == 0) {
1444 pa = fdisk_table_get_partition(dp->table, n);
1445 printf(" #%zu %12ju %12ju\n", n + 1,
1446 (uintmax_t)fdisk_partition_get_start(pa),
1447 (uintmax_t)fdisk_partition_get_size(pa));
1448 }
1449 } while (rc == 0);
1450
1451 if (!rc)
1452 fdisk_script_write_file(dp, stdout);
1453 fdisk_unref_script(dp);
1454 fdisk_unref_context(cxt);
1455
1456 return rc;
1457 }
1458
1459 static int test_apply(struct fdisk_test *ts, int argc, char *argv[])
1460 {
1461 char *devname = argv[1], *scriptname = argv[2];
1462 struct fdisk_context *cxt;
1463 struct fdisk_script *dp = NULL;
1464 struct fdisk_table *tb = NULL;
1465 struct fdisk_iter *itr = NULL;
1466 struct fdisk_partition *pa = NULL;
1467 int rc;
1468
1469 cxt = fdisk_new_context();
1470 fdisk_assign_device(cxt, devname, 0);
1471
1472 dp = fdisk_new_script_from_file(cxt, scriptname);
1473 if (!dp)
1474 return -errno;
1475
1476 rc = fdisk_apply_script(cxt, dp);
1477 if (rc)
1478 goto done;
1479 fdisk_unref_script(dp);
1480
1481 /* list result */
1482 fdisk_list_disklabel(cxt);
1483 fdisk_get_partitions(cxt, &tb);
1484
1485 itr = fdisk_new_iter(FDISK_ITER_FORWARD);
1486 while (fdisk_table_next_partition(tb, itr, &pa) == 0) {
1487 printf(" #%zu %12ju %12ju\n", fdisk_partition_get_partno(pa),
1488 (uintmax_t)fdisk_partition_get_start(pa),
1489 (uintmax_t)fdisk_partition_get_size(pa));
1490 }
1491
1492 done:
1493 fdisk_free_iter(itr);
1494 fdisk_unref_table(tb);
1495
1496 /*fdisk_write_disklabel(cxt);*/
1497 fdisk_unref_context(cxt);
1498 return 0;
1499 }
1500
1501 int main(int argc, char *argv[])
1502 {
1503 struct fdisk_test tss[] = {
1504 { "--dump", test_dump, "<device> dump PT as script" },
1505 { "--read", test_read, "<file> read PT script from file" },
1506 { "--apply", test_apply, "<device> <file> try apply script from file to device" },
1507 { "--stdin", test_stdin, " read input like sfdisk" },
1508 { NULL }
1509 };
1510
1511 return fdisk_run_test(tss, argc, argv);
1512 }
1513
1514 #endif