daemon: More reliable parsing of the output from 'parted print'.
[libguestfs.git] / daemon / parted.c
1 /* libguestfs - the guestfsd daemon
2  * Copyright (C) 2009 Red Hat Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <config.h>
20
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <stdint.h>
24 #include <inttypes.h>
25 #include <string.h>
26 #include <unistd.h>
27
28 #include "daemon.h"
29 #include "actions.h"
30
31 /* Notes:
32  *
33  * Parted 1.9 sends error messages to stdout, hence use of the
34  * COMMAND_FLAG_FOLD_STDOUT_ON_STDERR flag.
35  *
36  * parted occasionally fails to do ioctl(BLKRRPART) on the device,
37  * apparently because of some internal race in the code.  We attempt
38  * to detect and recover from this error if we can.
39  */
40 static int
41 recover_blkrrpart (const char *device, const char *err)
42 {
43   int r;
44
45   if (!strstr (err,
46                "Error informing the kernel about modifications to partition"))
47     return -1;
48
49   r = command (NULL, NULL, "blockdev", "--rereadpt", device, NULL);
50   if (r == -1)
51     return -1;
52
53   udev_settle ();
54
55   return 0;
56 }
57
58 #define RUN_PARTED(error,device,...)                                    \
59   do {                                                                  \
60     int r;                                                              \
61     char *err;                                                          \
62                                                                         \
63     r = commandf (NULL, &err, COMMAND_FLAG_FOLD_STDOUT_ON_STDERR,       \
64                   "parted", "-s", "--", (device), __VA_ARGS__);   \
65     if (r == -1) {                                                      \
66       if (recover_blkrrpart ((device), err) == -1) {                    \
67         reply_with_error ("%s: parted: %s: %s", __func__, (device), err); \
68         free (err);                                                     \
69         error;                                                          \
70       }                                                                 \
71     }                                                                   \
72                                                                         \
73     free (err);                                                         \
74   } while (0)
75
76 static const char *
77 check_parttype (const char *parttype)
78 {
79   /* Check and translate parttype. */
80   if (STREQ (parttype, "aix") ||
81       STREQ (parttype, "amiga") ||
82       STREQ (parttype, "bsd") ||
83       STREQ (parttype, "dasd") ||
84       STREQ (parttype, "dvh") ||
85       STREQ (parttype, "gpt") ||
86       STREQ (parttype, "mac") ||
87       STREQ (parttype, "msdos") ||
88       STREQ (parttype, "pc98") ||
89       STREQ (parttype, "sun"))
90     return parttype;
91   else if (STREQ (parttype, "rdb"))
92     return "amiga";
93   else if (STREQ (parttype, "efi"))
94     return "gpt";
95   else if (STREQ (parttype, "mbr"))
96     return "msdos";
97   else
98     return NULL;
99 }
100
101 int
102 do_part_init (const char *device, const char *parttype)
103 {
104   parttype = check_parttype (parttype);
105   if (!parttype) {
106     reply_with_error ("unknown partition type: common choices are \"gpt\" and \"msdos\"");
107     return -1;
108   }
109
110   RUN_PARTED (return -1, device, "mklabel", parttype, NULL);
111
112   udev_settle ();
113
114   return 0;
115 }
116
117 int
118 do_part_add (const char *device, const char *prlogex,
119              int64_t startsect, int64_t endsect)
120 {
121   char startstr[32];
122   char endstr[32];
123
124   /* Check and translate prlogex. */
125   if (STREQ (prlogex, "primary") ||
126       STREQ (prlogex, "logical") ||
127       STREQ (prlogex, "extended"))
128     ;
129   else if (STREQ (prlogex, "p"))
130     prlogex = "primary";
131   else if (STREQ (prlogex, "l"))
132     prlogex = "logical";
133   else if (STREQ (prlogex, "e"))
134     prlogex = "extended";
135   else {
136     reply_with_error ("unknown partition type: %s: this should be \"primary\", \"logical\" or \"extended\"", prlogex);
137     return -1;
138   }
139
140   if (startsect < 0) {
141     reply_with_error ("startsect cannot be negative");
142     return -1;
143   }
144   /* but endsect can be negative */
145
146   snprintf (startstr, sizeof startstr, "%" PRIi64 "s", startsect);
147   snprintf (endstr, sizeof endstr, "%" PRIi64 "s", endsect);
148
149   /* XXX Bug: If the partition table type (which we don't know in this
150    * function) is GPT, then this parted command sets the _partition
151    * name_ to prlogex, eg. "primary".  I would essentially describe
152    * this as a bug in the parted mkpart command.
153    */
154   RUN_PARTED (return -1, device, "mkpart", prlogex, startstr, endstr, NULL);
155
156   udev_settle ();
157
158   return 0;
159 }
160
161 int
162 do_part_disk (const char *device, const char *parttype)
163 {
164   const char *startstr;
165   const char *endstr;
166
167   parttype = check_parttype (parttype);
168   if (!parttype) {
169     reply_with_error ("unknown partition type: common choices are \"gpt\" and \"msdos\"");
170     return -1;
171   }
172
173   /* Voooooodooooooooo (thanks Jim Meyering for working this out). */
174   if (STREQ (parttype, "msdos")) {
175     startstr = "1s";
176     endstr = "-1s";
177   } else if (STREQ (parttype, "gpt")) {
178     startstr = "34s";
179     endstr = "-34s";
180   } else {
181     /* untested */
182     startstr = "1s";
183     endstr = "-1s";
184   }
185
186   RUN_PARTED (return -1,
187               device,
188               "mklabel", parttype,
189               /* See comment about about the parted mkpart command. */
190               "mkpart", STREQ (parttype, "gpt") ? "p1" : "primary",
191               startstr, endstr, NULL);
192
193   udev_settle ();
194
195   return 0;
196 }
197
198 int
199 do_part_set_bootable (const char *device, int partnum, int bootable)
200 {
201   char partstr[16];
202
203   snprintf (partstr, sizeof partstr, "%d", partnum);
204
205   RUN_PARTED (return -1,
206               device, "set", partstr, "boot", bootable ? "on" : "off", NULL);
207
208   udev_settle ();
209
210   return 0;
211 }
212
213 int
214 do_part_set_name (const char *device, int partnum, const char *name)
215 {
216   char partstr[16];
217
218   snprintf (partstr, sizeof partstr, "%d", partnum);
219
220   RUN_PARTED (return -1, device, "name", partstr, name, NULL);
221
222   udev_settle ();
223
224   return 0;
225 }
226
227 /* Return the nth field from a string of ':'/';'-delimited strings.
228  * Useful for parsing the return value from print_partition_table
229  * function below.
230  */
231 static char *
232 get_table_field (const char *line, int n)
233 {
234   const char *p = line;
235
236   while (*p && n > 0) {
237     p += strcspn (p, ":;") + 1;
238     n--;
239   }
240
241   if (n > 0) {
242     reply_with_error ("not enough fields in output of parted print command: %s",
243                       line);
244     return NULL;
245   }
246
247   size_t len = strcspn (p, ":;");
248   char *q = strndup (p, len);
249   if (q == NULL) {
250     reply_with_perror ("strndup");
251     return NULL;
252   }
253
254   return q;
255 }
256
257 static char **
258 print_partition_table (const char *device)
259 {
260   char *out, *err;
261   int r;
262   char **lines;
263
264   r = command (&out, &err, "parted", "-m", "--", device,
265                "unit", "b",
266                "print", NULL);
267   if (r == -1) {
268     reply_with_error ("parted print: %s: %s", device,
269                       /* Hack for parted 1.x which sends errors to stdout. */
270                       *err ? err : out);
271     free (out);
272     free (err);
273     return NULL;
274   }
275   free (err);
276
277   lines = split_lines (out);
278   free (out);
279
280   if (!lines)
281     return NULL;
282
283   if (lines[0] == NULL || STRNEQ (lines[0], "BYT;")) {
284     reply_with_error ("unknown signature, expected \"BYT;\" as first line of the output: %s",
285                       lines[0] ? lines[0] : "(signature was null)");
286     free_strings (lines);
287     return NULL;
288   }
289
290   if (lines[1] == NULL) {
291     reply_with_error ("parted didn't return a line describing the device");
292     free_strings (lines);
293     return NULL;
294   }
295
296   return lines;
297 }
298
299 char *
300 do_part_get_parttype (const char *device)
301 {
302   char **lines = print_partition_table (device);
303   if (!lines)
304     return NULL;
305
306   /* lines[1] is something like:
307    * "/dev/sda:1953525168s:scsi:512:512:msdos:ATA Hitachi HDT72101;"
308    */
309   char *r = get_table_field (lines[1], 5);
310   if (r == NULL) {
311     free_strings (lines);
312     return NULL;
313   }
314
315   free_strings (lines);
316
317   return r;
318 }
319
320 guestfs_int_partition_list *
321 do_part_list (const char *device)
322 {
323   char **lines;
324   size_t row, nr_rows, i;
325   guestfs_int_partition_list *r;
326
327   lines = print_partition_table (device);
328   if (!lines)
329     return NULL;
330
331   /* lines[0] is "BYT;", lines[1] is the device line which we ignore,
332    * lines[2..] are the partitions themselves.  Count how many.
333    */
334   nr_rows = 0;
335   for (row = 2; lines[row] != NULL; ++row)
336     ++nr_rows;
337
338   r = malloc (sizeof *r);
339   if (r == NULL) {
340     reply_with_perror ("malloc");
341     goto error1;
342   }
343   r->guestfs_int_partition_list_len = nr_rows;
344   r->guestfs_int_partition_list_val =
345     malloc (nr_rows * sizeof (guestfs_int_partition));
346   if (r->guestfs_int_partition_list_val == NULL) {
347     reply_with_perror ("malloc");
348     goto error2;
349   }
350
351   /* Now parse the lines. */
352   for (i = 0, row = 2; lines[row] != NULL; ++i, ++row) {
353     if (sscanf (lines[row], "%d:%" SCNi64 "B:%" SCNi64 "B:%" SCNi64 "B",
354                 &r->guestfs_int_partition_list_val[i].part_num,
355                 &r->guestfs_int_partition_list_val[i].part_start,
356                 &r->guestfs_int_partition_list_val[i].part_end,
357                 &r->guestfs_int_partition_list_val[i].part_size) != 4) {
358       reply_with_error ("could not parse row from output of parted print command: %s", lines[row]);
359       goto error3;
360     }
361   }
362
363   free_strings (lines);
364   return r;
365
366  error3:
367   free (r->guestfs_int_partition_list_val);
368  error2:
369   free (r);
370  error1:
371   free_strings (lines);
372   return NULL;
373 }