stand/common/part.h

   1 /*-
   2  * Copyright (c) 2012 Andrey V. Elsukov <ae@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _PART_H_
  30 #define _PART_H_
  31
  32 struct ptable;
  33
  34 enum ptable_type {
  35         PTABLE_NONE,
  36         PTABLE_BSD,
  37         PTABLE_MBR,
  38         PTABLE_GPT,
  39         PTABLE_VTOC8,
  40         PTABLE_ISO9660
  41 };
  42
  43 enum partition_type {
  44         PART_UNKNOWN,
  45         PART_EFI,
  46         PART_FREEBSD,
  47         PART_FREEBSD_BOOT,
  48         PART_FREEBSD_UFS,
  49         PART_FREEBSD_ZFS,
  50         PART_FREEBSD_SWAP,
  51         PART_FREEBSD_VINUM,
  52         PART_LINUX,
  53         PART_LINUX_SWAP,
  54         PART_DOS,
  55         PART_ISO9660,
  56         PART_APFS
  57 };
  58
  59 struct ptable_entry {
  60         uint64_t                start;
  61         uint64_t                end;
  62         int                     index;
  63         enum partition_type     type;
  64 };
  65
  66 /* The offset and size are in sectors */
  67 typedef int (diskread_t)(void *arg, void *buf, size_t blocks, uint64_t offset);
  68 typedef int (ptable_iterate_t)(void *arg, const char *partname,
  69     const struct ptable_entry *part);
  70
  71 struct ptable *ptable_open(void *dev, uint64_t sectors, uint16_t sectorsize,
  72     diskread_t *dread);
  73 void ptable_close(struct ptable *table);
  74 enum ptable_type ptable_gettype(const struct ptable *table);
  75 int ptable_getsize(const struct ptable *table, uint64_t *sizep);
  76
  77 int ptable_getpart(const struct ptable *table, struct ptable_entry *part,
  78     int index);
  79 int ptable_getbestpart(const struct ptable *table, struct ptable_entry *part);
  80
  81 int ptable_iterate(const struct ptable *table, void *arg,
  82     ptable_iterate_t *iter);
  83 const char *parttype2str(enum partition_type type);
  84
  85 #endif  /* !_PART_H_ */