2N/A/* Mmap management. */
2N/A/*
2N/A * GRUB -- GRand Unified Bootloader
2N/A * Copyright (C) 2009 Free Software Foundation, Inc.
2N/A * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
2N/A *
2N/A * GRUB is free software: you can redistribute it and/or modify
2N/A * it under the terms of the GNU General Public License as published by
2N/A * the Free Software Foundation, either version 3 of the License, or
2N/A * (at your option) any later version.
2N/A *
2N/A * GRUB is distributed in the hope that it will be useful,
2N/A * but WITHOUT ANY WARRANTY; without even the implied warranty of
2N/A * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2N/A * GNU General Public License for more details.
2N/A *
2N/A * You should have received a copy of the GNU General Public License
2N/A * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
2N/A */
2N/A
2N/A#include <grub/memory.h>
2N/A#include <grub/machine/memory.h>
2N/A#include <grub/err.h>
2N/A#include <grub/misc.h>
2N/A#include <grub/mm.h>
2N/A#include <grub/command.h>
2N/A#include <grub/dl.h>
2N/A#include <grub/i18n.h>
2N/A
2N/AGRUB_MOD_LICENSE ("GPLv3+");
2N/A
2N/A#ifndef GRUB_MMAP_REGISTER_BY_FIRMWARE
2N/A
2N/Astruct grub_mmap_region *grub_mmap_overlays = 0;
2N/Astatic int curhandle = 1;
2N/A
2N/A#endif
2N/A
2N/Agrub_err_t
2N/Agrub_mmap_iterate (grub_memory_hook_t hook)
2N/A{
2N/A
2N/A /* This function resolves overlapping regions and sorts the memory map.
2N/A It uses scanline (sweeping) algorithm.
2N/A */
2N/A /* If same page is used by multiple types it's resolved
2N/A according to priority:
2N/A 1 - free memory
2N/A 2 - memory usable by firmware-aware code
2N/A 3 - unusable memory
2N/A 4 - a range deliberately empty
2N/A */
2N/A int priority[] =
2N/A {
2N/A [GRUB_MEMORY_AVAILABLE] = 1,
2N/A [GRUB_MEMORY_RESERVED] = 3,
2N/A [GRUB_MEMORY_ACPI] = 2,
2N/A [GRUB_MEMORY_CODE] = 3,
2N/A [GRUB_MEMORY_NVS] = 3,
2N/A [GRUB_MEMORY_HOLE] = 4,
2N/A };
2N/A
2N/A int i, done;
2N/A
2N/A /* Scanline events. */
2N/A struct grub_mmap_scan
2N/A {
2N/A /* At which memory address. */
2N/A grub_uint64_t pos;
2N/A /* 0 = region starts, 1 = region ends. */
2N/A int type;
2N/A /* Which type of memory region? */
2N/A int memtype;
2N/A };
2N/A struct grub_mmap_scan *scanline_events;
2N/A struct grub_mmap_scan t;
2N/A
2N/A /* Previous scanline event. */
2N/A grub_uint64_t lastaddr;
2N/A int lasttype;
2N/A /* Current scanline event. */
2N/A int curtype;
2N/A /* How many regions of given type overlap at current location? */
2N/A int present[ARRAY_SIZE (priority)];
2N/A /* Number of mmap chunks. */
2N/A int mmap_num;
2N/A
2N/A#ifndef GRUB_MMAP_REGISTER_BY_FIRMWARE
2N/A struct grub_mmap_region *cur;
2N/A#endif
2N/A
2N/A auto int NESTED_FUNC_ATTR count_hook (grub_uint64_t, grub_uint64_t,
2N/A grub_uint32_t);
2N/A int NESTED_FUNC_ATTR count_hook (grub_uint64_t addr __attribute__ ((unused)),
2N/A grub_uint64_t size __attribute__ ((unused)),
2N/A grub_memory_type_t type __attribute__ ((unused)))
2N/A {
2N/A mmap_num++;
2N/A return 0;
2N/A }
2N/A
2N/A auto int NESTED_FUNC_ATTR fill_hook (grub_uint64_t, grub_uint64_t,
2N/A grub_uint32_t);
2N/A int NESTED_FUNC_ATTR fill_hook (grub_uint64_t addr,
2N/A grub_uint64_t size,
2N/A grub_memory_type_t type)
2N/A {
2N/A scanline_events[i].pos = addr;
2N/A scanline_events[i].type = 0;
2N/A if (type < ARRAY_SIZE (priority) && priority[type])
2N/A scanline_events[i].memtype = type;
2N/A else
2N/A {
2N/A grub_dprintf ("mmap", "Unknown memory type %d. Assuming unusable\n",
2N/A type);
2N/A scanline_events[i].memtype = GRUB_MEMORY_RESERVED;
2N/A }
2N/A i++;
2N/A
2N/A scanline_events[i].pos = addr + size;
2N/A scanline_events[i].type = 1;
2N/A scanline_events[i].memtype = scanline_events[i - 1].memtype;
2N/A i++;
2N/A
2N/A return 0;
2N/A }
2N/A
2N/A mmap_num = 0;
2N/A
2N/A#ifndef GRUB_MMAP_REGISTER_BY_FIRMWARE
2N/A for (cur = grub_mmap_overlays; cur; cur = cur->next)
2N/A mmap_num++;
2N/A#endif
2N/A
2N/A grub_machine_mmap_iterate (count_hook);
2N/A
2N/A /* Initialize variables. */
2N/A grub_memset (present, 0, sizeof (present));
2N/A scanline_events = (struct grub_mmap_scan *)
2N/A grub_malloc (sizeof (struct grub_mmap_scan) * 2 * mmap_num);
2N/A
2N/A if (! scanline_events)
2N/A {
2N/A return grub_error (GRUB_ERR_OUT_OF_MEMORY,
2N/A "couldn't allocate space for new memory map");
2N/A }
2N/A
2N/A i = 0;
2N/A#ifndef GRUB_MMAP_REGISTER_BY_FIRMWARE
2N/A /* Register scanline events. */
2N/A for (cur = grub_mmap_overlays; cur; cur = cur->next)
2N/A {
2N/A scanline_events[i].pos = cur->start;
2N/A scanline_events[i].type = 0;
2N/A if (cur->type < ARRAY_SIZE (priority) && priority[cur->type])
2N/A scanline_events[i].memtype = cur->type;
2N/A else
2N/A scanline_events[i].memtype = GRUB_MEMORY_RESERVED;
2N/A i++;
2N/A
2N/A scanline_events[i].pos = cur->end;
2N/A scanline_events[i].type = 1;
2N/A scanline_events[i].memtype = scanline_events[i - 1].memtype;
2N/A i++;
2N/A }
2N/A#endif /* ! GRUB_MMAP_REGISTER_BY_FIRMWARE */
2N/A
2N/A grub_machine_mmap_iterate (fill_hook);
2N/A
2N/A /* Primitive bubble sort. It has complexity O(n^2) but since we're
2N/A unlikely to have more than 100 chunks it's probably one of the
2N/A fastest for one purpose. */
2N/A done = 1;
2N/A while (done)
2N/A {
2N/A done = 0;
2N/A for (i = 0; i < 2 * mmap_num - 1; i++)
2N/A if (scanline_events[i + 1].pos < scanline_events[i].pos
2N/A || (scanline_events[i + 1].pos == scanline_events[i].pos
2N/A && scanline_events[i + 1].type == 0
2N/A && scanline_events[i].type == 1))
2N/A {
2N/A t = scanline_events[i + 1];
2N/A scanline_events[i + 1] = scanline_events[i];
2N/A scanline_events[i] = t;
2N/A done = 1;
2N/A }
2N/A }
2N/A
2N/A lastaddr = scanline_events[0].pos;
2N/A lasttype = scanline_events[0].memtype;
2N/A for (i = 0; i < 2 * mmap_num; i++)
2N/A {
2N/A unsigned k;
2N/A /* Process event. */
2N/A if (scanline_events[i].type)
2N/A present[scanline_events[i].memtype]--;
2N/A else
2N/A present[scanline_events[i].memtype]++;
2N/A
2N/A /* Determine current region type. */
2N/A curtype = -1;
2N/A for (k = 0; k < ARRAY_SIZE (priority); k++)
2N/A if (present[k] && (curtype == -1 || priority[k] > priority[curtype]))
2N/A curtype = k;
2N/A
2N/A /* Announce region to the hook if necessary. */
2N/A if ((curtype == -1 || curtype != lasttype)
2N/A && lastaddr != scanline_events[i].pos
2N/A && lasttype != -1
2N/A && lasttype != GRUB_MEMORY_HOLE
2N/A && hook (lastaddr, scanline_events[i].pos - lastaddr, lasttype))
2N/A {
2N/A grub_free (scanline_events);
2N/A return GRUB_ERR_NONE;
2N/A }
2N/A
2N/A /* Update last values if necessary. */
2N/A if (curtype == -1 || curtype != lasttype)
2N/A {
2N/A lasttype = curtype;
2N/A lastaddr = scanline_events[i].pos;
2N/A }
2N/A }
2N/A
2N/A grub_free (scanline_events);
2N/A return GRUB_ERR_NONE;
2N/A}
2N/A
2N/A#ifndef GRUB_MMAP_REGISTER_BY_FIRMWARE
2N/Aint
2N/Agrub_mmap_register (grub_uint64_t start, grub_uint64_t size, int type)
2N/A{
2N/A struct grub_mmap_region *cur;
2N/A
2N/A grub_dprintf ("mmap", "registering\n");
2N/A
2N/A cur = (struct grub_mmap_region *)
2N/A grub_malloc (sizeof (struct grub_mmap_region));
2N/A if (! cur)
2N/A {
2N/A grub_error (GRUB_ERR_OUT_OF_MEMORY,
2N/A "couldn't allocate memory map overlay");
2N/A return 0;
2N/A }
2N/A
2N/A cur->next = grub_mmap_overlays;
2N/A cur->start = start;
2N/A cur->end = start + size;
2N/A cur->type = type;
2N/A cur->handle = curhandle++;
2N/A grub_mmap_overlays = cur;
2N/A
2N/A if (grub_machine_mmap_register (start, size, type, curhandle))
2N/A {
2N/A grub_mmap_overlays = cur->next;
2N/A grub_free (cur);
2N/A return 0;
2N/A }
2N/A
2N/A return cur->handle;
2N/A}
2N/A
2N/Agrub_err_t
2N/Agrub_mmap_unregister (int handle)
2N/A{
2N/A struct grub_mmap_region *cur, *prev;
2N/A
2N/A for (cur = grub_mmap_overlays, prev = 0; cur; prev= cur, cur = cur->next)
2N/A if (handle == cur->handle)
2N/A {
2N/A grub_err_t err;
2N/A if ((err = grub_machine_mmap_unregister (handle)))
2N/A return err;
2N/A
2N/A if (prev)
2N/A prev->next = cur->next;
2N/A else
2N/A grub_mmap_overlays = cur->next;
2N/A grub_free (cur);
2N/A return GRUB_ERR_NONE;
2N/A }
2N/A return grub_error (GRUB_ERR_BAD_ARGUMENT, "mmap overlay not found");
2N/A}
2N/A
2N/A#endif /* ! GRUB_MMAP_REGISTER_BY_FIRMWARE */
2N/A
2N/A#define CHUNK_SIZE 0x400
2N/A
2N/Astatic inline grub_uint64_t
2N/Afill_mask (grub_uint64_t addr, grub_uint64_t mask, grub_uint64_t iterator)
2N/A{
2N/A int i, j;
2N/A grub_uint64_t ret = (addr & mask);
2N/A
2N/A /* Find first fixed bit. */
2N/A for (i = 0; i < 64; i++)
2N/A if ((mask & (1ULL << i)) != 0)
2N/A break;
2N/A j = 0;
2N/A for (; i < 64; i++)
2N/A if ((mask & (1ULL << i)) == 0)
2N/A {
2N/A if ((iterator & (1ULL << j)) != 0)
2N/A ret |= 1ULL << i;
2N/A j++;
2N/A }
2N/A return ret;
2N/A}
2N/A
2N/Astatic grub_err_t
2N/Agrub_cmd_badram (grub_command_t cmd __attribute__ ((unused)),
2N/A int argc, char **args)
2N/A{
2N/A char * str;
2N/A grub_uint64_t badaddr, badmask;
2N/A
2N/A auto int NESTED_FUNC_ATTR hook (grub_uint64_t, grub_uint64_t,
2N/A grub_memory_type_t);
2N/A int NESTED_FUNC_ATTR hook (grub_uint64_t addr,
2N/A grub_uint64_t size,
2N/A grub_memory_type_t type __attribute__ ((unused)))
2N/A {
2N/A grub_uint64_t iterator, low, high, cur;
2N/A int tail, var;
2N/A int i;
2N/A grub_dprintf ("badram", "hook %llx+%llx\n", (unsigned long long) addr,
2N/A (unsigned long long) size);
2N/A
2N/A /* How many trailing zeros? */
2N/A for (tail = 0; ! (badmask & (1ULL << tail)); tail++);
2N/A
2N/A /* How many zeros in mask? */
2N/A var = 0;
2N/A for (i = 0; i < 64; i++)
2N/A if (! (badmask & (1ULL << i)))
2N/A var++;
2N/A
2N/A if (fill_mask (badaddr, badmask, 0) >= addr)
2N/A iterator = 0;
2N/A else
2N/A {
2N/A low = 0;
2N/A high = ~0ULL;
2N/A /* Find starting value. Keep low and high such that
2N/A fill_mask (low) < addr and fill_mask (high) >= addr;
2N/A */
2N/A while (high - low > 1)
2N/A {
2N/A cur = (low + high) / 2;
2N/A if (fill_mask (badaddr, badmask, cur) >= addr)
2N/A high = cur;
2N/A else
2N/A low = cur;
2N/A }
2N/A iterator = high;
2N/A }
2N/A
2N/A for (; iterator < (1ULL << (var - tail))
2N/A && (cur = fill_mask (badaddr, badmask, iterator)) < addr + size;
2N/A iterator++)
2N/A {
2N/A grub_dprintf ("badram", "%llx (size %llx) is a badram range\n",
2N/A (unsigned long long) cur, (1ULL << tail));
2N/A grub_mmap_register (cur, (1ULL << tail), GRUB_MEMORY_HOLE);
2N/A }
2N/A return 0;
2N/A }
2N/A
2N/A if (argc != 1)
2N/A return grub_error (GRUB_ERR_BAD_ARGUMENT, "badram string required");
2N/A
2N/A grub_dprintf ("badram", "executing badram\n");
2N/A
2N/A str = args[0];
2N/A
2N/A while (1)
2N/A {
2N/A /* Parse address and mask. */
2N/A badaddr = grub_strtoull (str, &str, 16);
2N/A if (*str == ',')
2N/A str++;
2N/A badmask = grub_strtoull (str, &str, 16);
2N/A if (*str == ',')
2N/A str++;
2N/A
2N/A if (grub_errno == GRUB_ERR_BAD_NUMBER)
2N/A {
2N/A grub_errno = 0;
2N/A return GRUB_ERR_NONE;
2N/A }
2N/A
2N/A /* When part of a page is tainted, we discard the whole of it. There's
2N/A no point in providing sub-page chunks. */
2N/A badmask &= ~(CHUNK_SIZE - 1);
2N/A
2N/A grub_dprintf ("badram", "badram %llx:%llx\n",
2N/A (unsigned long long) badaddr, (unsigned long long) badmask);
2N/A
2N/A grub_mmap_iterate (hook);
2N/A }
2N/A}
2N/A
2N/Astatic grub_uint64_t
2N/Aparsemem (const char *str)
2N/A{
2N/A grub_uint64_t ret;
2N/A char *ptr;
2N/A
2N/A ret = grub_strtoul (str, &ptr, 0);
2N/A
2N/A switch (*ptr)
2N/A {
2N/A case 'K':
2N/A return ret << 10;
2N/A case 'M':
2N/A return ret << 20;
2N/A case 'G':
2N/A return ret << 30;
2N/A case 'T':
2N/A return ret << 40;
2N/A }
2N/A return ret;
2N/A}
2N/A
2N/Astatic grub_err_t
2N/Agrub_cmd_cutmem (grub_command_t cmd __attribute__ ((unused)),
2N/A int argc, char **args)
2N/A{
2N/A grub_uint64_t from, to;
2N/A
2N/A auto int NESTED_FUNC_ATTR hook (grub_uint64_t, grub_uint64_t,
2N/A grub_memory_type_t);
2N/A int NESTED_FUNC_ATTR hook (grub_uint64_t addr,
2N/A grub_uint64_t size,
2N/A grub_memory_type_t type __attribute__ ((unused)))
2N/A {
2N/A grub_uint64_t end = addr + size;
2N/A
2N/A if (addr <= from)
2N/A addr = from;
2N/A if (end >= to)
2N/A end = to;
2N/A
2N/A if (end <= addr)
2N/A return 0;
2N/A
2N/A grub_mmap_register (addr, end - addr, GRUB_MEMORY_HOLE);
2N/A return 0;
2N/A }
2N/A
2N/A if (argc != 2)
2N/A return grub_error (GRUB_ERR_BAD_ARGUMENT, "arguments required");
2N/A
2N/A from = parsemem (args[0]);
2N/A if (grub_errno)
2N/A return grub_errno;
2N/A
2N/A to = parsemem (args[1]);
2N/A if (grub_errno)
2N/A return grub_errno;
2N/A
2N/A grub_mmap_iterate (hook);
2N/A
2N/A return GRUB_ERR_NONE;
2N/A}
2N/A
2N/Astatic grub_err_t
2N/Agrub_cmd_addmem (grub_command_t cmd __attribute__ ((unused)),
2N/A int argc, char **args)
2N/A{
2N/A grub_uint64_t from, to;
2N/A
2N/A if (argc != 2)
2N/A return grub_error (GRUB_ERR_BAD_ARGUMENT, "arguments required");
2N/A
2N/A from = parsemem (args[0]);
2N/A if (grub_errno)
2N/A return grub_errno;
2N/A
2N/A to = parsemem (args[1]);
2N/A if (grub_errno)
2N/A return grub_errno;
2N/A
2N/A if (to <= from)
2N/A return grub_error (GRUB_ERR_BAD_ARGUMENT, "to must be >= from");
2N/A
2N/A if (grub_mmap_register (from, to - from, GRUB_MEMORY_AVAILABLE) == 0)
2N/A return grub_errno;
2N/A
2N/A return GRUB_ERR_NONE;
2N/A}
2N/A
2N/Astatic grub_command_t cmd, cmd_cut, cmd_add;
2N/A
2N/A
2N/AGRUB_MOD_INIT(mmap)
2N/A{
2N/A cmd = grub_register_command ("badram", grub_cmd_badram,
2N/A N_("ADDR1,MASK1[,ADDR2,MASK2[,...]]"),
2N/A N_("Declare memory regions as badram."));
2N/A cmd_cut = grub_register_command ("cutmem", grub_cmd_cutmem,
2N/A N_("FROM[K|M|G] TO[K|M|G]"),
2N/A N_("Remove any memory regions in specified range."));
2N/A cmd_add = grub_register_command ("addmem", grub_cmd_addmem,
2N/A N_("FROM[K|M|G] TO[K|M|G]"),
2N/A N_("Add an available memory region in the specified range."));
2N/A
2N/A}
2N/A
2N/AGRUB_MOD_FINI(mmap)
2N/A{
2N/A grub_unregister_command (cmd);
2N/A grub_unregister_command (cmd_cut);
2N/A grub_unregister_command (cmd_add);
2N/A}
2N/A