xref: /src/sbin/gpt/show.c

/*-
 * Copyright (c) 2002 Marcel Moolenaar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#if HAVE_NBTOOL_CONFIG_H
#include "nbtool_config.h"
#endif

#include <sys/cdefs.h>
#ifdef __FBSDID
__FBSDID("$FreeBSD: src/sbin/gpt/show.c,v 1.14 2006/06/22 22:22:32 marcel Exp $");
#endif
#ifdef __RCSID
__RCSID("$NetBSD: show.c,v 1.28 2015/12/03 01:07:28 christos Exp $");
#endif

#include <sys/types.h>

#include <err.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "map.h"
#include "gpt.h"
#include "gpt_private.h"

static int cmd_show(gpt_t, int, char *[]);

static const char *showhelp[] = {
	"[-glu] [-i index]",
};

#define SHOW_UUID  1
#define SHOW_GUID  2
#define SHOW_LABEL 4

struct gpt_cmd c_show = {
	"show",
	cmd_show,
	showhelp, __arraycount(showhelp),
	GPT_READONLY,
};

#define usage() gpt_usage(NULL, &c_show)

static int
show(gpt_t gpt, int show)
{
	off_t start;
	map_t m, p;
	struct mbr *mbr;
	struct gpt_ent *ent;
	unsigned int i;
	char buf[128], *b = buf;
	uint8_t utfbuf[__arraycount(ent->ent_name) * 3 + 1];

	printf("  %*s", gpt->lbawidth, "start");
	printf("  %*s", gpt->lbawidth, "size");
	printf("  index  contents\n");

	m = map_first(gpt);
	while (m != NULL) {
		printf("  %*llu", gpt->lbawidth, (long long)m->map_start);
		printf("  %*llu", gpt->lbawidth, (long long)m->map_size);
		putchar(' ');
		putchar(' ');
		if (m->map_index > 0)
			printf("%5d", m->map_index);
		else
			printf("     ");
		putchar(' ');
		putchar(' ');
		switch (m->map_type) {
		case MAP_TYPE_UNUSED:
			printf("Unused");
			break;
		case MAP_TYPE_MBR:
			if (m->map_start != 0)
				printf("Extended ");
			printf("MBR");
			break;
		case MAP_TYPE_PRI_GPT_HDR:
			printf("Pri GPT header");
			break;
		case MAP_TYPE_SEC_GPT_HDR:
			printf("Sec GPT header");
			break;
		case MAP_TYPE_PRI_GPT_TBL:
			printf("Pri GPT table");
			break;
		case MAP_TYPE_SEC_GPT_TBL:
			printf("Sec GPT table");
			break;
		case MAP_TYPE_MBR_PART:
			p = m->map_data;
			if (p->map_start != 0)
				printf("Extended ");
			printf("MBR part ");
			mbr = p->map_data;
			for (i = 0; i < 4; i++) {
				start = le16toh(mbr->mbr_part[i].part_start_hi);
				start = (start << 16) +
				    le16toh(mbr->mbr_part[i].part_start_lo);
				if (m->map_start == p->map_start + start)
					break;
			}
			printf("%d", mbr->mbr_part[i].part_typ);
			break;
		case MAP_TYPE_GPT_PART:
			printf("GPT part ");
			ent = m->map_data;
			if (show & SHOW_LABEL) {
				utf16_to_utf8(ent->ent_name, utfbuf,
				    sizeof(utfbuf));
				b = (char *)buf;
			} else if (show & SHOW_GUID) {
				gpt_uuid_snprintf( buf, sizeof(buf), "%d",
				    ent->ent_guid);
			} else if (show & SHOW_UUID) {
				gpt_uuid_snprintf(buf, sizeof(buf),
				    "%d", ent->ent_type);
			} else {
				gpt_uuid_snprintf(buf, sizeof(buf), "%ls",
				    ent->ent_type);
			}
			printf("- %s", b);
			break;
		case MAP_TYPE_PMBR:
			printf("PMBR");
			break;
		default:
			printf("Unknown %#x", m->map_type);
			break;
		}
		putchar('\n');
		m = m->map_next;
	}
	return 0;
}

static void
show_num(gpt_t gpt, const char *prompt, uintmax_t num)
{
#ifdef HN_AUTOSCALE
	char human_num[5];
	if (humanize_number(human_num, 5, (int64_t)(num * gpt->secsz),
	    "", HN_AUTOSCALE, HN_NOSPACE|HN_B) < 0)
		human_num[0] = '\0';
#endif
	printf("%s: %ju", prompt, num);
#ifdef HN_AUTOSCALE
	if (human_num[0] != '\0')
		printf("(%s)", human_num);
#endif

	printf("\n");
}

static int
show_one(gpt_t gpt, unsigned int entry)
{
	map_t m;
	struct gpt_ent *ent;
	char s1[128], s2[128];
	uint8_t utfbuf[__arraycount(ent->ent_name) * 3 + 1];

	for (m = map_first(gpt); m != NULL; m = m->map_next)
		if (entry == m->map_index)
			break;
	if (m == NULL) {
		gpt_warnx(gpt, "Could not find index %d", entry);
		return -1;
	}
	ent = m->map_data;

	printf("Details for index %d:\n", entry);
	show_num(gpt, "Start", m->map_start);
	show_num(gpt, "Size", m->map_size);

	gpt_uuid_snprintf(s1, sizeof(s1), "%s", ent->ent_type);
	gpt_uuid_snprintf(s2, sizeof(s2), "%d", ent->ent_type);
	if (strcmp(s1, s2) == 0)
		strlcpy(s1, "unknown", sizeof(s1));
	printf("Type: %s (%s)\n", s1, s2);

	gpt_uuid_snprintf(s2, sizeof(s1), "%d", ent->ent_guid);
	printf("GUID: %s\n", s2);

	utf16_to_utf8(ent->ent_name, utfbuf, sizeof(utfbuf));
	printf("Label: %s\n", (char *)utfbuf);

	printf("Attributes:\n");
	if (ent->ent_attr == 0) {
		printf("  None\n");
		return 0;
	}
	if (ent->ent_attr & GPT_ENT_ATTR_REQUIRED_PARTITION)
		printf("  required for platform to function\n");
	if (ent->ent_attr & GPT_ENT_ATTR_NO_BLOCK_IO_PROTOCOL)
		printf("  UEFI won't recognize file system\n");
	if (ent->ent_attr & GPT_ENT_ATTR_LEGACY_BIOS_BOOTABLE)
		printf("  legacy BIOS boot partition\n");
	if (ent->ent_attr & GPT_ENT_ATTR_BOOTME)
		printf("  indicates a bootable partition\n");
	if (ent->ent_attr & GPT_ENT_ATTR_BOOTONCE)
		printf("  attempt to boot this partition only once\n");
	if (ent->ent_attr & GPT_ENT_ATTR_BOOTFAILED)
		printf("  partition was marked bootonce but failed to boot\n");
	return 0;
}

static int
cmd_show(gpt_t gpt, int argc, char *argv[])
{
	int ch;
	int xshow = 0;
	unsigned int entry = 0;

	while ((ch = getopt(argc, argv, "gi:lu")) != -1) {
		switch(ch) {
		case 'g':
			xshow |= SHOW_GUID;
			break;
		case 'i':
			if (gpt_entry_get(&entry) == -1)
				return usage();
			break;
		case 'l':
			xshow |= SHOW_LABEL;
			break;
		case 'u':
			xshow |= SHOW_UUID;
			break;
		default:
			return usage();
		}
	}

	if (argc != optind)
		return usage();

	return entry > 0 ? show_one(gpt, entry) : show(gpt, xshow);
}