libfdisk/src/libfdisk.h

   1 /*
   2  * libfdisk.h - libfdisk API
   3  *
   4  * Copyright (C) 2012 Karel Zak <kzak@redhat.com>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library 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 GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 #ifndef _LIBFDISK_FDISK_H
  22 #define _LIBFDISK_FDISK_H
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 #include <stdarg.h>
  29 #include <stdint.h>
  30
  31 struct fdisk_context;
  32 struct fdisk_label;
  33 struct fdisk_parttype;
  34 struct fdisk_partition;
  35 struct fdisk_ask;
  36 struct fdisk_iter;
  37 struct fdisk_table;
  38 struct fdisk_field;
  39
  40 /*
  41  * Supported partition table types (labels)
  42  */
  43 enum fdisk_labeltype {
  44         FDISK_DISKLABEL_DOS = (1 << 1),
  45         FDISK_DISKLABEL_SUN = (1 << 2),
  46         FDISK_DISKLABEL_SGI = (1 << 3),
  47         FDISK_DISKLABEL_BSD = (1 << 4),
  48         FDISK_DISKLABEL_GPT = (1 << 5)
  49 };
  50
  51 enum {
  52         FDISK_ASKTYPE_NONE = 0,
  53         FDISK_ASKTYPE_NUMBER,
  54         FDISK_ASKTYPE_OFFSET,
  55         FDISK_ASKTYPE_WARN,
  56         FDISK_ASKTYPE_WARNX,
  57         FDISK_ASKTYPE_INFO,
  58         FDISK_ASKTYPE_YESNO,
  59         FDISK_ASKTYPE_STRING,
  60         FDISK_ASKTYPE_MENU
  61 };
  62
  63 /* extra flags for info massages (see fdisk_sinfo() */
  64 enum {
  65         FDISK_INFO_SUCCESS      /* info after successful action */
  66 };
  67
  68 /* init.c */
  69 extern void fdisk_init_debug(int mask);
  70
  71 /* context.h */
  72
  73 #define PLURAL  0
  74 #define SINGULAR 1
  75
  76
  77 struct fdisk_context *fdisk_new_context(void);
  78 struct fdisk_context *fdisk_new_nested_context(struct fdisk_context *parent, const char *name);
  79 void fdisk_free_context(struct fdisk_context *cxt);
  80
  81 struct fdisk_label *fdisk_get_label(struct fdisk_context *cxt, const char *name);
  82 int fdisk_next_label(struct fdisk_context *cxt, struct fdisk_label **lb);
  83 size_t fdisk_get_nlabels(struct fdisk_context *cxt);
  84 int fdisk_switch_label(struct fdisk_context *cxt, const char *name);
  85
  86 int fdisk_assign_device(struct fdisk_context *cxt,
  87                         const char *fname, int readonly);
  88 int fdisk_deassign_device(struct fdisk_context *cxt, int nosync);
  89 int fdisk_is_readonly(struct fdisk_context *cxt);
  90
  91 int fdisk_set_ask(struct fdisk_context *cxt,
  92                 int (*ask_cb)(struct fdisk_context *, struct fdisk_ask *, void *),
  93                 void *data);
  94
  95 int fdisk_enable_details(struct fdisk_context *cxt, int enable);
  96 int fdisk_is_details(struct fdisk_context *cxt);
  97
  98 int fdisk_enable_listonly(struct fdisk_context *cxt, int enable);
  99 int fdisk_is_listonly(struct fdisk_context *cxt);
 100
 101 int fdisk_set_unit(struct fdisk_context *cxt, const char *str);
 102 const char *fdisk_get_unit(struct fdisk_context *cxt, int n);
 103 int fdisk_use_cylinders(struct fdisk_context *cxt);
 104 unsigned int fdisk_get_units_per_sector(struct fdisk_context *cxt);
 105
 106 unsigned long fdisk_get_optimal_iosize(struct fdisk_context *cxt);
 107 unsigned long fdisk_get_minimal_size(struct fdisk_context *cxt);
 108 unsigned long fdisk_get_physector_size(struct fdisk_context *cxt);
 109 unsigned long fdisk_get_sector_size(struct fdisk_context *cxt);
 110 unsigned long fdisk_get_alignment_offset(struct fdisk_context *cxt);
 111 unsigned long fdisk_get_grain_size(struct fdisk_context *cxt);
 112 unsigned long fdisk_get_first_lba(struct fdisk_context *cxt);
 113 unsigned long fdisk_get_nsectors(struct fdisk_context *cxt);
 114 const char *fdisk_get_devname(struct fdisk_context *cxt);
 115
 116 /* parttype.c */
 117 extern struct fdisk_parttype *fdisk_get_parttype_from_code(struct fdisk_context *cxt,
 118                                 unsigned int code);
 119 extern struct fdisk_parttype *fdisk_get_parttype_from_string(struct fdisk_context *cxt,
 120                                 const char *str);
 121 extern struct fdisk_parttype *fdisk_parse_parttype(struct fdisk_context *cxt, const char *str);
 122
 123 extern struct fdisk_parttype *fdisk_new_unknown_parttype(unsigned int type, const char *typestr);
 124 extern void fdisk_free_parttype(struct fdisk_parttype *type);
 125 extern size_t fdisk_get_nparttypes(struct fdisk_context *cxt);
 126
 127 extern int fdisk_is_parttype_string(struct fdisk_context *cxt);
 128
 129 /* label.c */
 130 enum {
 131         FDISK_FIELD_NONE = 0,
 132
 133         /* generic */
 134         FDISK_FIELD_DEVICE,
 135         FDISK_FIELD_START,
 136         FDISK_FIELD_END,
 137         FDISK_FIELD_SECTORS,
 138         FDISK_FIELD_CYLINDERS,
 139         FDISK_FIELD_SIZE,
 140         FDISK_FIELD_TYPE,
 141         FDISK_FIELD_TYPEID,
 142
 143         /* label specific */
 144         FDISK_FIELD_ATTR,
 145         FDISK_FIELD_BOOT,
 146         FDISK_FIELD_BSIZE,
 147         FDISK_FIELD_CPG,
 148         FDISK_FIELD_EADDR,
 149         FDISK_FIELD_FSIZE,
 150         FDISK_FIELD_NAME,
 151         FDISK_FIELD_SADDR,
 152         FDISK_FIELD_UUID,
 153 };
 154
 155 extern int fdisk_require_geometry(struct fdisk_context *cxt);
 156 extern int fdisk_missing_geometry(struct fdisk_context *cxt);
 157
 158 extern int fdisk_dev_has_disklabel(struct fdisk_context *cxt);
 159
 160 extern int fdisk_dev_is_disklabel(struct fdisk_context *cxt, enum fdisk_labeltype l);
 161 #define fdisk_is_disklabel(c, x) fdisk_dev_is_disklabel(c, FDISK_DISKLABEL_ ## x)
 162
 163 extern int fdisk_write_disklabel(struct fdisk_context *cxt);
 164 extern int fdisk_verify_disklabel(struct fdisk_context *cxt);
 165 extern int fdisk_create_disklabel(struct fdisk_context *cxt, const char *name);
 166 extern int fdisk_list_disklabel(struct fdisk_context *cxt);
 167 extern int fdisk_locate_disklabel(struct fdisk_context *cxt, int n, const char **name, off_t *offset, size_t *size);
 168
 169 extern int fdisk_get_disklabel_id(struct fdisk_context *cxt, char **id);
 170 extern int fdisk_set_disklabel_id(struct fdisk_context *cxt);
 171
 172 extern int fdisk_get_partition(struct fdisk_context *cxt, size_t partno, struct fdisk_partition **pa);
 173
 174 extern int fdisk_add_partition(struct fdisk_context *cxt, struct fdisk_partition *pa);
 175 extern int fdisk_delete_partition(struct fdisk_context *cxt, size_t partnum);
 176
 177 extern int fdisk_set_partition_type(struct fdisk_context *cxt, size_t partnum,
 178                              struct fdisk_parttype *t);
 179
 180
 181 extern int fdisk_get_fields_ids(struct fdisk_context *cxt, int all,
 182                                 int **ids, size_t *nids);
 183 extern const struct fdisk_field *fdisk_label_get_field(struct fdisk_label *lb, int id);
 184
 185 extern int fdisk_field_get_id(const struct fdisk_field *fl);
 186 extern const char *fdisk_field_get_name(const struct fdisk_field *fl);
 187 extern double fdisk_field_get_width(const struct fdisk_field *fl);
 188 extern int fdisk_field_is_number(const struct fdisk_field *fl);
 189
 190
 191 extern void fdisk_label_set_changed(struct fdisk_label *lb, int changed);
 192 extern int fdisk_label_is_changed(struct fdisk_label *lb);
 193
 194 extern void fdisk_label_set_disabled(struct fdisk_label *lb, int disabled);
 195 extern int fdisk_label_is_disabled(struct fdisk_label *lb);
 196
 197 extern int fdisk_is_partition_used(struct fdisk_context *cxt, size_t n);
 198
 199 extern int fdisk_partition_toggle_flag(struct fdisk_context *cxt, size_t partnum, unsigned long flag);
 200
 201 extern struct fdisk_partition *fdisk_new_partition(void);
 202 extern void fdisk_reset_partition(struct fdisk_partition *pa);
 203 extern void fdisk_ref_partition(struct fdisk_partition *pa);
 204 extern void fdisk_unref_partition(struct fdisk_partition *pa);
 205 extern int fdisk_partition_is_freespace(struct fdisk_partition *pa);
 206
 207 extern int fdisk_partition_set_start(struct fdisk_partition *pa, uint64_t off);
 208 extern uint64_t fdisk_partition_get_start(struct fdisk_partition *pa);
 209 extern int fdisk_partition_cmp_start(struct fdisk_partition *a,
 210                               struct fdisk_partition *b);
 211
 212 extern int fdisk_partition_set_end(struct fdisk_partition *pa, uint64_t off);
 213 extern uint64_t fdisk_partition_get_end(struct fdisk_partition *pa);
 214 extern int fdisk_partition_set_size(struct fdisk_partition *pa, uint64_t size);
 215 extern uint64_t fdisk_partition_get_size(struct fdisk_partition *pa);
 216
 217 extern int fdisk_partition_set_partno(struct fdisk_partition *pa, size_t n);
 218 extern size_t fdisk_partition_get_partno(struct fdisk_partition *pa);
 219 extern int fdisk_partition_cmp_partno(struct fdisk_partition *a,
 220                               struct fdisk_partition *b);
 221
 222 extern int fdisk_partition_set_type(struct fdisk_partition *pa, struct fdisk_parttype *type);
 223 extern const struct fdisk_parttype *fdisk_partition_get_type(struct fdisk_partition *pa);
 224 extern int fdisk_partition_set_name(struct fdisk_partition *pa, const char *name);
 225 extern const char *fdisk_partition_get_name(struct fdisk_partition *pa);
 226 extern int fdisk_partition_set_uuid(struct fdisk_partition *pa, const char *uuid);
 227 extern const char *fdisk_partition_get_uuid(struct fdisk_partition *pa);
 228 extern const char *fdisk_partition_get_attrs(struct fdisk_partition *pa);
 229 extern int fdisk_partition_is_nested(struct fdisk_partition *pa);
 230 extern int fdisk_partition_is_container(struct fdisk_partition *pa);
 231 extern int fdisk_partition_get_parent(struct fdisk_partition *pa, size_t *parent);
 232 extern int fdisk_partition_is_used(struct fdisk_partition *pa);
 233 extern int fdisk_partition_to_string(struct fdisk_partition *pa,
 234                                      struct fdisk_context *cxt,
 235                                      int id, char **data);
 236
 237 extern int fdisk_partition_next_partno(struct fdisk_partition *pa,
 238                                        struct fdisk_context *cxt,
 239                                        size_t *n);
 240
 241 extern int fdisk_partition_partno_follow_default(struct fdisk_partition *pa, int enable);
 242 extern int fdisk_partition_start_follow_default(struct fdisk_partition *pa, int enable);
 243 extern int fdisk_partition_end_follow_default(struct fdisk_partition *pa, int enable);
 244
 245 extern int fdisk_dump_partition(struct fdisk_partition *pa, FILE *f);
 246
 247 extern int fdisk_reorder_partitions(struct fdisk_context *cxt);
 248
 249 /* table.c */
 250 extern struct fdisk_table *fdisk_new_table(void);
 251 extern int fdisk_reset_table(struct fdisk_table *tb);
 252 extern void fdisk_ref_table(struct fdisk_table *tb);
 253 extern void fdisk_unref_table(struct fdisk_table *tb);
 254 extern int fdisk_dump_table(struct fdisk_table *b, FILE *f);
 255 extern int fdisk_table_get_nents(struct fdisk_table *tb);
 256 extern int fdisk_table_is_empty(struct fdisk_table *tb);
 257 extern int fdisk_table_add_partition(struct fdisk_table *tb, struct fdisk_partition *pa);
 258 extern int fdisk_table_remove_partition(struct fdisk_table *tb, struct fdisk_partition *pa);
 259
 260 extern int fdisk_get_partitions(struct fdisk_context *cxt, struct fdisk_table **tb);
 261 extern int fdisk_get_freespaces(struct fdisk_context *cxt, struct fdisk_table **tb);
 262
 263 extern int fdisk_table_wrong_order(struct fdisk_table *tb);
 264 extern int fdisk_table_sort_partitions(struct fdisk_table *tb,
 265                         int (*cmp)(struct fdisk_partition *,
 266                                    struct fdisk_partition *));
 267
 268 extern int fdisk_table_next_partition(
 269                         struct fdisk_table *tb,
 270                         struct fdisk_iter *itr,
 271                         struct fdisk_partition **pa);
 272
 273 extern struct fdisk_partition *fdisk_table_get_partition(
 274                         struct fdisk_table *tb,
 275                         size_t n);
 276
 277 /* alignment.c */
 278 extern int fdisk_reset_alignment(struct fdisk_context *cxt);
 279 extern int fdisk_reset_device_properties(struct fdisk_context *cxt);
 280
 281 extern int fdisk_save_user_geometry(struct fdisk_context *cxt,
 282                             unsigned int cylinders,
 283                             unsigned int heads,
 284                             unsigned int sectors);
 285
 286 extern int fdisk_save_user_sector_size(struct fdisk_context *cxt,
 287                                 unsigned int phy,
 288                                 unsigned int log);
 289
 290 extern int fdisk_has_user_device_properties(struct fdisk_context *cxt);
 291
 292 extern int fdisk_reread_partition_table(struct fdisk_context *cxt);
 293
 294 /* iter.c */
 295 enum {
 296
 297         FDISK_ITER_FORWARD = 0,
 298         FDISK_ITER_BACKWARD
 299 };
 300 extern struct fdisk_iter *fdisk_new_iter(int direction);
 301 extern void fdisk_free_iter(struct fdisk_iter *itr);
 302 extern void fdisk_reset_iter(struct fdisk_iter *itr, int direction);
 303 extern int fdisk_iter_get_direction(struct fdisk_iter *itr);
 304
 305
 306 /* dos.c */
 307 extern int fdisk_dos_enable_compatible(struct fdisk_label *lb, int enable);
 308 extern int fdisk_dos_is_compatible(struct fdisk_label *lb);
 309
 310 /* sun.h */
 311 extern int fdisk_sun_set_alt_cyl(struct fdisk_context *cxt);
 312 extern int fdisk_sun_set_xcyl(struct fdisk_context *cxt);
 313 extern int fdisk_sun_set_ilfact(struct fdisk_context *cxt);
 314 extern int fdisk_sun_set_rspeed(struct fdisk_context *cxt);
 315 extern int fdisk_sun_set_pcylcount(struct fdisk_context *cxt);
 316
 317 /* bsd.c */
 318 extern int fdisk_bsd_edit_disklabel(struct fdisk_context *cxt);
 319 extern int fdisk_bsd_write_bootstrap(struct fdisk_context *cxt);
 320 extern int fdisk_bsd_link_partition(struct fdisk_context *cxt);
 321
 322 /* sgi.h */
 323 #define SGI_FLAG_BOOT   1
 324 #define SGI_FLAG_SWAP   2
 325 extern int fdisk_sgi_set_bootfile(struct fdisk_context *cxt);
 326 extern int fdisk_sgi_create_info(struct fdisk_context *cxt);
 327
 328 /* gpt */
 329 enum {
 330         GPT_FLAG_REQUIRED = 1,
 331         GPT_FLAG_NOBLOCK,
 332         GPT_FLAG_LEGACYBOOT,
 333         GPT_FLAG_GUIDSPECIFIC
 334 };
 335
 336 extern int fdisk_gpt_partition_set_uuid(struct fdisk_context *cxt, size_t i);
 337 extern int fdisk_gpt_partition_set_name(struct fdisk_context *cxt, size_t i);
 338 extern int fdisk_gpt_is_hybrid(struct fdisk_context *cxt);
 339
 340 /* dos.c */
 341 extern struct dos_partition *fdisk_dos_get_partition(
 342                                 struct fdisk_context *cxt,
 343                                 size_t i);
 344
 345 extern int fdisk_dos_move_begin(struct fdisk_context *cxt, size_t i);
 346
 347 #define DOS_FLAG_ACTIVE 1
 348
 349 /* ask.c */
 350 #define fdisk_is_ask(a, x) (fdisk_ask_get_type(a) == FDISK_ASKTYPE_ ## x)
 351
 352 extern struct fdisk_ask *fdisk_new_ask(void);
 353 extern void fdisk_reset_ask(struct fdisk_ask *ask);
 354 extern void fdisk_free_ask(struct fdisk_ask *ask);
 355 extern const char *fdisk_ask_get_query(struct fdisk_ask *ask);
 356 extern int fdisk_ask_set_query(struct fdisk_ask *ask, const char *str);
 357 extern int fdisk_ask_get_type(struct fdisk_ask *ask);
 358 extern int fdisk_ask_set_type(struct fdisk_ask *ask, int type);
 359 extern int fdisk_ask_set_flags(struct fdisk_ask *ask, unsigned int flags);
 360 extern unsigned int fdisk_ask_get_flags(struct fdisk_ask *ask);
 361
 362 extern int fdisk_do_ask(struct fdisk_context *cxt, struct fdisk_ask *ask);
 363
 364 extern const char *fdisk_ask_number_get_range(struct fdisk_ask *ask);
 365 extern int fdisk_ask_number_set_range(struct fdisk_ask *ask, const char *range);
 366 extern uint64_t fdisk_ask_number_get_default(struct fdisk_ask *ask);
 367 extern int fdisk_ask_number_set_default(struct fdisk_ask *ask, uint64_t dflt);
 368 extern uint64_t fdisk_ask_number_get_low(struct fdisk_ask *ask);
 369 extern int fdisk_ask_number_set_low(struct fdisk_ask *ask, uint64_t low);
 370 extern uint64_t fdisk_ask_number_get_high(struct fdisk_ask *ask);
 371 extern int fdisk_ask_number_set_high(struct fdisk_ask *ask, uint64_t high);
 372 extern uint64_t fdisk_ask_number_get_base(struct fdisk_ask *ask);
 373 extern int fdisk_ask_number_set_base(struct fdisk_ask *ask, uint64_t base);
 374 extern uint64_t fdisk_ask_number_get_unit(struct fdisk_ask *ask);
 375 extern int fdisk_ask_number_set_unit(struct fdisk_ask *ask, uint64_t unit);
 376 extern uint64_t fdisk_ask_number_get_result(struct fdisk_ask *ask);
 377 extern int fdisk_ask_number_set_result(struct fdisk_ask *ask, uint64_t result);
 378 extern int fdisk_ask_number_set_relative(struct fdisk_ask *ask, int relative);
 379 extern int fdisk_ask_number_is_relative(struct fdisk_ask *ask);
 380 extern int fdisk_ask_number_inchars(struct fdisk_ask *ask);
 381
 382 extern int fdisk_ask_number(struct fdisk_context *cxt,
 383                      uintmax_t low,
 384                      uintmax_t dflt,
 385                      uintmax_t high,
 386                      const char *query,
 387                      uintmax_t *result);
 388
 389 extern int fdisk_ask_string(struct fdisk_context *cxt,
 390                      const char *query,
 391                      char **result);
 392
 393 extern char *fdisk_ask_string_get_result(struct fdisk_ask *ask);
 394 extern int fdisk_ask_string_set_result(struct fdisk_ask *ask, char *result);
 395
 396 extern int fdisk_ask_yesno(struct fdisk_context *cxt, const char *query, int *result);
 397 extern uint64_t fdisk_ask_yesno_get_result(struct fdisk_ask *ask);
 398 extern int fdisk_ask_yesno_set_result(struct fdisk_ask *ask, uint64_t result);
 399
 400 extern int fdisk_info(struct fdisk_context *cxt, const char *fmt, ...)
 401                         __attribute__ ((__format__ (__printf__, 2, 3)));
 402 extern int fdisk_colon(struct fdisk_context *cxt, const char *fmt, ...)
 403                         __attribute__ ((__format__ (__printf__, 2, 3)));
 404 extern int fdisk_sinfo(struct fdisk_context *cxt, unsigned int flags, const char *fmt, ...)
 405                         __attribute__ ((__format__ (__printf__, 3, 4)));
 406
 407 extern int fdisk_warnx(struct fdisk_context *cxt, const char *fmt, ...)
 408                         __attribute__ ((__format__ (__printf__, 2, 3)));
 409 extern int fdisk_warn(struct fdisk_context *cxt, const char *fmt, ...)
 410                         __attribute__ ((__format__ (__printf__, 2, 3)));
 411
 412 extern int fdisk_ask_print_get_errno(struct fdisk_ask *ask);
 413 extern int fdisk_ask_print_set_errno(struct fdisk_ask *ask, int errnum);
 414 extern const char *fdisk_ask_print_get_mesg(struct fdisk_ask *ask);
 415 extern int fdisk_ask_print_set_mesg(struct fdisk_ask *ask, const char *mesg);
 416
 417
 418 extern size_t fdisk_ask_menu_get_nitems(struct fdisk_ask *ask);
 419 extern int fdisk_ask_menu_set_default(struct fdisk_ask *ask, int dfl);
 420 extern int fdisk_ask_menu_get_default(struct fdisk_ask *ask);
 421 extern int fdisk_ask_menu_set_result(struct fdisk_ask *ask, int key);
 422 extern int fdisk_ask_menu_get_result(struct fdisk_ask *ask, int *key);
 423 extern int fdisk_ask_menu_get_item(struct fdisk_ask *ask, size_t idx, int *key,
 424                             const char **name, const char **desc);
 425 extern int fdisk_ask_menu_add_item(struct fdisk_ask *ask, int key,
 426                         const char *name, const char *desc);
 427
 428
 429 #ifdef __cplusplus
 430 }
 431 #endif
 432
 433 #endif /* _LIBFDISK_FDISK_H */