grub/util/grub-probe.c

/* grub-probe.c - probe device information for a given path */
/*
 *  GRUB  --  GRand Unified Bootloader
 *  Copyright (C) 2005,2006,2007,2008,2009,2010  Free Software Foundation, Inc.
 *
 *  GRUB is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  GRUB is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <grub/types.h>
#include <grub/emu/misc.h>
#include <grub/util/misc.h>
#include <grub/device.h>
#include <grub/disk.h>
#include <grub/file.h>
#include <grub/fs.h>
#include <grub/partition.h>
#include <grub/msdos_partition.h>
#include <grub/emu/hostdisk.h>
#include <grub/emu/getroot.h>
#include <grub/term.h>
#include <grub/env.h>
#include <grub/raid.h>
#include <grub/i18n.h>
#include <grub/emu/misc.h>
#include <grub/util/ofpath.h>
#include <grub/crypto.h>
#include <grub/cryptodisk.h>

#include <stdio.h>
#include <unistd.h>
#include <string.h>
#include <stdlib.h>
#include <sys/stat.h>

#define _GNU_SOURCE	1
#include <getopt.h>

#include "progname.h"

enum {
  PRINT_FS,
  PRINT_FS_UUID,
  PRINT_FS_LABEL,
  PRINT_DRIVE,
  PRINT_DEVICE,
  PRINT_PARTMAP,
  PRINT_ABSTRACTION,
  PRINT_CRYPTODISK_UUID,
  PRINT_HINT_STR,
  PRINT_BIOS_HINT,
  PRINT_IEEE1275_HINT,
  PRINT_BAREMETAL_HINT,
  PRINT_EFI_HINT,
  PRINT_ARC_HINT,
  PRINT_COMPATIBILITY_HINT
};

static int print = PRINT_FS;
static unsigned int argument_is_device = 0;

static void
probe_partmap (grub_disk_t disk)
{
  grub_partition_t part;
  grub_disk_memberlist_t list = NULL, tmp;

  if (disk->partition == NULL)
    {
      grub_util_info ("no partition map found for %s", disk->name);
    }

  for (part = disk->partition; part; part = part->parent)
    printf ("%s ", part->partmap->name);

  /* In case of LVM/RAID, check the member devices as well.  */
  if (disk->dev->memberlist)
    {
      list = disk->dev->memberlist (disk);
    }
  while (list)
    {
      probe_partmap (list->disk);
      tmp = list->next;
      free (list);
      list = tmp;
    }
}

static void
probe_cryptodisk_uuid (grub_disk_t disk)
{
  grub_disk_memberlist_t list = NULL, tmp;

  /* In case of LVM/RAID, check the member devices as well.  */
  if (disk->dev->memberlist)
    {
      list = disk->dev->memberlist (disk);
    }
  while (list)
    {
      probe_cryptodisk_uuid (list->disk);
      tmp = list->next;
      free (list);
      list = tmp;
    }
  if (disk->dev->id == GRUB_DISK_DEVICE_CRYPTODISK_ID)
    grub_util_cryptodisk_print_uuid (disk);
}

static int
probe_raid_level (grub_disk_t disk)
{
  /* disk might be NULL in the case of a LVM physical volume with no LVM
     signature.  Ignore such cases here.  */
  if (!disk)
    return -1;

  if (disk->dev->id != GRUB_DISK_DEVICE_RAID_ID)
    return -1;

  return ((struct grub_raid_array *) disk->data)->level;
}

/* Since OF path names can have "," characters in them, and GRUB
   internally uses "," to indicate partitions (unlike OF which uses
   ":" for this purpose) we escape such commas.  */
static char *
escape_of_path (const char *orig_path)
{
  char *new_path, *d, c;
  const char *p;

  if (!strchr (orig_path, ','))
    return (char *) orig_path;

  new_path = xmalloc (strlen (orig_path) * 2 + sizeof ("ieee1275/"));

  p = orig_path;
  grub_strcpy (new_path, "ieee1275/");
  d = new_path + sizeof ("ieee1275/") - 1;
  while ((c = *p++) != '\0')
    {
      if (c == ',')
	*d++ = '\\';
      *d++ = c;
    }
  *d = 0;

  free ((char *) orig_path);

  return new_path;
}

static char *
guess_bios_drive (const char *orig_path)
{
  char *canon;
  char *ptr;
  canon = canonicalize_file_name (orig_path);
  if (!canon)
    return NULL;
  ptr = strrchr (orig_path, '/');
  if (ptr)
    ptr++;
  else
    ptr = canon;
  if ((ptr[0] == 's' || ptr[0] == 'h') && ptr[1] == 'd')
    {
      int num = ptr[2] - 'a';
      free (canon);
      return xasprintf ("hd%d", num);
    }
  if (ptr[0] == 'f' && ptr[1] == 'd')
    {
      int num = atoi (ptr + 2);
      free (canon);
      return xasprintf ("fd%d", num);
    }
  free (canon);
  return NULL;
}

static char *
guess_efi_drive (const char *orig_path)
{
  char *canon;
  char *ptr;
  canon = canonicalize_file_name (orig_path);
  if (!canon)
    return NULL;
  ptr = strrchr (orig_path, '/');
  if (ptr)
    ptr++;
  else
    ptr = canon;
  if ((ptr[0] == 's' || ptr[0] == 'h') && ptr[1] == 'd')
    {
      int num = ptr[2] - 'a';
      free (canon);
      return xasprintf ("hd%d", num);
    }
  if (ptr[0] == 'f' && ptr[1] == 'd')
    {
      int num = atoi (ptr + 2);
      free (canon);
      return xasprintf ("fd%d", num);
    }
  free (canon);
  return NULL;
}

static char *
guess_baremetal_drive (const char *orig_path)
{
  char *canon;
  char *ptr;
  canon = canonicalize_file_name (orig_path);
  if (!canon)
    return NULL;
  ptr = strrchr (orig_path, '/');
  if (ptr)
    ptr++;
  else
    ptr = canon;
  if (ptr[0] == 'h' && ptr[1] == 'd')
    {
      int num = ptr[2] - 'a';
      free (canon);
      return xasprintf ("ata%d", num);
    }
  if (ptr[0] == 's' && ptr[1] == 'd')
    {
      int num = ptr[2] - 'a';
      free (canon);
      return xasprintf ("ahci%d", num);
    }
  free (canon);
  return NULL;
}

static void
print_full_name (const char *drive, grub_device_t dev)
{
  if (dev->disk->partition)
    {
      char *pname = grub_partition_get_name (dev->disk->partition);
      printf ("%s,%s", drive, pname);
      free (pname);
    }
  else
    printf ("%s", drive);
} 

static void
probe_abstraction (grub_disk_t disk)
{
  grub_disk_memberlist_t list = NULL, tmp;
  int raid_level;

  if (disk->dev->memberlist)
    list = disk->dev->memberlist (disk);
  while (list)
    {
      probe_abstraction (list->disk);

      tmp = list->next;
      free (list);
      list = tmp;
    }

  if (disk->dev->id == GRUB_DISK_DEVICE_LVM_ID)
    printf ("lvm ");

  if (disk->dev->id == GRUB_DISK_DEVICE_CRYPTODISK_ID)
    grub_util_cryptodisk_print_abstraction (disk);

  raid_level = probe_raid_level (disk);
  if (raid_level >= 0)
    {
      printf ("raid ");
      if (disk->dev->raidname)
	printf ("%s ", disk->dev->raidname (disk));
    }
  if (raid_level == 5)
    printf ("raid5rec ");
  if (raid_level == 6)
    printf ("raid6rec ");
}

static void
probe (const char *path, char *device_name)
{
  char *drive_name = NULL;
  char *grub_path = NULL;
  char *filebuf_via_grub = NULL, *filebuf_via_sys = NULL;
  grub_device_t dev = NULL;
  grub_fs_t fs;

  if (path == NULL)
    {
#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__) || defined(__sun__)
      if (! grub_util_check_char_device (device_name))
        grub_util_error (_("%s is not a character device"), device_name);
#else
      if (! grub_util_check_block_device (device_name))
        grub_util_error (_("%s is not a block device"), device_name);
#endif
    }
  else
    {
      grub_path = canonicalize_file_name (path);
      device_name = grub_guess_root_device (grub_path);
    }

  if (! device_name)
    grub_util_error (_("cannot find a device for %s (is /dev mounted?)"), path);

  if (print == PRINT_DEVICE)
    {
      printf ("%s\n", device_name);
      goto end;
    }

  drive_name = grub_util_get_grub_dev (device_name);
  if (! drive_name)
    grub_util_error (_("cannot find a GRUB drive for %s.  Check your device.map"),
		     device_name);

  if (print == PRINT_DRIVE)
    {
      printf ("(%s)\n", drive_name);
      goto end;
    }

  grub_util_info ("opening %s", drive_name);
  dev = grub_device_open (drive_name);
  if (! dev)
    grub_util_error ("%s", _(grub_errmsg));

  if (print == PRINT_HINT_STR)
    {
      const char *osdev = grub_util_biosdisk_get_osdev (dev->disk);
      const char *orig_path = grub_util_devname_to_ofpath (osdev);
      char *biosname, *bare, *efi;
      const char *map;

      if (orig_path)
	{
	  char *ofpath = escape_of_path (orig_path);
	  printf ("--hint-ieee1275='");
	  print_full_name (ofpath, dev);
	  printf ("' ");
	  free (ofpath);
	}

      biosname = guess_bios_drive (device_name);
      if (biosname)
	{
	  printf ("--hint-bios=");
	  print_full_name (biosname, dev);
	  printf (" ");
	}
      free (biosname);

      efi = guess_efi_drive (device_name);
      if (efi)
	{
	  printf ("--hint-efi=");
	  print_full_name (efi, dev);
	  printf (" ");
	}
      free (efi);

      bare = guess_baremetal_drive (device_name);
      if (bare)
	{
	  printf ("--hint-baremetal=");
	  print_full_name (bare, dev);
	  printf (" ");
	}
      free (bare);

      /* FIXME: Add ARC hint.  */

      map = grub_util_biosdisk_get_compatibility_hint (dev->disk);
      if (map)
	{
	  printf ("--hint='");
	  print_full_name (map, dev);
	  printf ("' ");
	}
      printf ("\n");

      goto end;
    }

  if (print == PRINT_COMPATIBILITY_HINT)
    {
      const char *map;
      char *biosname;
      map = grub_util_biosdisk_get_compatibility_hint (dev->disk);
      if (map)
	{
	  print_full_name (map, dev);
	  printf ("\n");
	  goto end;
	}
      biosname = guess_bios_drive (device_name);
      if (biosname)
	print_full_name (biosname, dev);
      printf ("\n");
      free (biosname);
      goto end;
    }

  if (print == PRINT_BIOS_HINT)
    {
      char *biosname;
      biosname = guess_bios_drive (device_name);
      if (biosname)
	print_full_name (biosname, dev);
      printf ("\n");
      free (biosname);
      goto end;
    }
  if (print == PRINT_IEEE1275_HINT)
    {
      const char *osdev = grub_util_biosdisk_get_osdev (dev->disk);
      const char *orig_path = grub_util_devname_to_ofpath (osdev);
      char *ofpath = escape_of_path (orig_path);
      const char *map;

      map = grub_util_biosdisk_get_compatibility_hint (dev->disk);
      if (map)
	{
	  printf (" ");
	  print_full_name (map, dev);
	}

      printf (" ");
      print_full_name (ofpath, dev);

      printf ("\n");
      free (ofpath);
      goto end;
    }
  if (print == PRINT_EFI_HINT)
    {
      char *biosname;
      char *name;
      const char *map;
      biosname = guess_efi_drive (device_name);

      map = grub_util_biosdisk_get_compatibility_hint (dev->disk);
      if (map)
	{
	  printf (" ");
	  print_full_name (map, dev);
	}
      if (biosname)
	{
	  printf (" ");
	  print_full_name (biosname, dev);
	}

      printf ("\n");
      free (biosname);
      goto end;
    }

  if (print == PRINT_BAREMETAL_HINT)
    {
      char *biosname;
      char *name;
      const char *map;

      biosname = guess_baremetal_drive (device_name);

      map = grub_util_biosdisk_get_compatibility_hint (dev->disk);
      if (map)
	{
	  printf (" ");
	  print_full_name (map, dev);
	}
      if (biosname)
	{
	  printf (" ");
	  print_full_name (biosname, dev);
	}

      printf ("\n");
      free (biosname);
      goto end;
    }

  if (print == PRINT_ARC_HINT)
    {
      const char *map;

      map = grub_util_biosdisk_get_compatibility_hint (dev->disk);
      if (map)
	{
	  printf (" ");
	  print_full_name (map, dev);
	}
      printf ("\n");

      /* FIXME */

      goto end;
    }

  if (print == PRINT_ABSTRACTION)
    {
      probe_abstraction (dev->disk);
      printf ("\n");
      goto end;
    }

  if (print == PRINT_CRYPTODISK_UUID)
    {
      probe_cryptodisk_uuid (dev->disk);
      printf ("\n");
      goto end;
    }

  if (print == PRINT_PARTMAP)
    {
      /* Check if dev->disk itself is contained in a partmap.  */
      probe_partmap (dev->disk);
      printf ("\n");
      goto end;
    }

  fs = grub_fs_probe (dev);
  if (! fs)
    grub_util_error ("%s", _(grub_errmsg));

  if (print == PRINT_FS)
    {
      printf ("%s\n", fs->name);
    }
  else if (print == PRINT_FS_UUID)
    {
      char *uuid;
      if (! fs->uuid)
	grub_util_error (_("%s does not support UUIDs"), fs->name);

      if (fs->uuid (dev, &uuid) != GRUB_ERR_NONE)
	grub_util_error ("%s", grub_errmsg);

      printf ("%s\n", uuid);
    }
  else if (print == PRINT_FS_LABEL)
    {
      char *label;
      if (! fs->label)
	grub_util_error (_("%s does not support labels"), fs->name);

      if (fs->label (dev, &label) != GRUB_ERR_NONE)
	grub_util_error ("%s", _(grub_errmsg));

      printf ("%s\n", label);
    }

 end:
  if (dev)
    grub_device_close (dev);
  free (grub_path);
  free (filebuf_via_grub);
  free (filebuf_via_sys);
  free (drive_name);
}

static struct option options[] =
  {
    {"device", no_argument, 0, 'd'},
    {"device-map", required_argument, 0, 'm'},
    {"target", required_argument, 0, 't'},
    {"help", no_argument, 0, 'h'},
    {"version", no_argument, 0, 'V'},
    {"verbose", no_argument, 0, 'v'},
    {0, 0, 0, 0}
  };

static void
usage (int status)
{
  if (status)
    fprintf (stderr,
	     _("Try `%s --help' for more information.\n"), program_name);
  else
    printf (_("\
Usage: %s [OPTION]... [PATH|DEVICE]\n\
\n\
Probe device information for a given path (or device, if the -d option is given).\n\
\n\
  -d, --device              given argument is a system device, not a path\n\
  -m, --device-map=FILE     use FILE as the device map [default=%s]\n\
  -t, --target=(fs|fs_uuid|fs_label|drive|device|partmap|abstraction|cryptodisk_uuid)\n\
                            print filesystem module, GRUB drive, system device, partition map module, abstraction module or CRYPTO UUID [default=fs]\n\
  -h, --help                display this message and exit\n\
  -V, --version             print version information and exit\n\
  -v, --verbose             print verbose messages\n\
\n\
Report bugs to <%s>.\n\
"), program_name,
	    DEFAULT_DEVICE_MAP, PACKAGE_BUGREPORT);

  exit (status);
}

int
main (int argc, char *argv[])
{
  char *dev_map = 0;
  char *argument;

  set_program_name (argv[0]);

  grub_util_init_nls ();

  /* Check for options.  */
  while (1)
    {
      int c = getopt_long (argc, argv, "dm:t:hVv", options, 0);

      if (c == -1)
	break;
      else
	switch (c)
	  {
	  case 'd':
	    argument_is_device = 1;
	    break;

	  case 'm':
	    if (dev_map)
	      free (dev_map);

	    dev_map = xstrdup (optarg);
	    break;

	  case 't':
	    if (!strcmp (optarg, "fs"))
	      print = PRINT_FS;
	    else if (!strcmp (optarg, "fs_uuid"))
	      print = PRINT_FS_UUID;
	    else if (!strcmp (optarg, "fs_label"))
	      print = PRINT_FS_LABEL;
	    else if (!strcmp (optarg, "drive"))
	      print = PRINT_DRIVE;
	    else if (!strcmp (optarg, "device"))
	      print = PRINT_DEVICE;
	    else if (!strcmp (optarg, "partmap"))
	      print = PRINT_PARTMAP;
	    else if (!strcmp (optarg, "abstraction"))
	      print = PRINT_ABSTRACTION;
	    else if (!strcmp (optarg, "cryptodisk_uuid"))
	      print = PRINT_CRYPTODISK_UUID;
	    else if (!strcmp (optarg, "hints_string"))
	      print = PRINT_HINT_STR;
	    else if (!strcmp (optarg, "bios_hints"))
	      print = PRINT_BIOS_HINT;
	    else if (!strcmp (optarg, "ieee1275_hints"))
	      print = PRINT_IEEE1275_HINT;
	    else if (!strcmp (optarg, "baremetal_hints"))
	      print = PRINT_BAREMETAL_HINT;
	    else if (!strcmp (optarg, "efi_hints"))
	      print = PRINT_EFI_HINT;
	    else if (!strcmp (optarg, "arc_hints"))
	      print = PRINT_ARC_HINT;
	    else if (!strcmp (optarg, "compatibility_hint"))
	      print = PRINT_COMPATIBILITY_HINT;
	    else
	      usage (1);
	    break;

	  case 'h':
	    usage (0);
	    break;

	  case 'V':
	    printf ("%s (%s) %s\n", program_name, PACKAGE_NAME, PACKAGE_VERSION);
	    return 0;

	  case 'v':
	    verbosity++;
	    break;

	  default:
	    usage (1);
	    break;
	  }
    }

  if (verbosity > 1)
    grub_env_set ("debug", "all");

  /* Obtain ARGUMENT.  */
  if (optind >= argc)
    {
      fprintf (stderr, _("No path or device is specified.\n"));
      usage (1);
    }

  if (optind + 1 != argc)
    {
      fprintf (stderr, _("Unknown extra argument `%s'.\n"), argv[optind + 1]);
      usage (1);
    }

  argument = argv[optind];

  /* Initialize the emulated biosdisk driver.  */
  grub_util_biosdisk_init (dev_map ? : DEFAULT_DEVICE_MAP);

  /* Initialize all modules. */
  grub_init_all ();
  grub_gcry_init_all ();

  grub_lvm_fini ();
  grub_mdraid09_fini ();
  grub_mdraid1x_fini ();
  grub_raid_fini ();
  grub_raid_init ();
  grub_mdraid09_init ();
  grub_mdraid1x_init ();
  grub_lvm_init ();

  /* Do it.  */
  if (argument_is_device)
    probe (NULL, argument);
  else
    probe (argument, NULL);

  /* Free resources.  */
  grub_gcry_fini_all ();
  grub_fini_all ();
  grub_util_biosdisk_fini ();

  free (dev_map);

  return 0;
}