3
* GRUB -- GRand Unified Bootloader
4
* Copyright (C) 2009 Free Software Foundation, Inc.
6
* GRUB is free software: you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation, either version 3 of the License, or
9
* (at your option) any later version.
11
* GRUB 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
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with GRUB. If not, see <http://www.gnu.org/licenses/>.
20
#include <grub/machine/memory.h>
21
#include <grub/memory.h>
23
#include <grub/misc.h>
25
#include <grub/command.h>
27
#include <grub/i18n.h>
29
#ifndef GRUB_MMAP_REGISTER_BY_FIRMWARE
31
struct grub_mmap_region *grub_mmap_overlays = 0;
32
static int curhandle = 1;
37
grub_mmap_iterate (int NESTED_FUNC_ATTR (*hook) (grub_uint64_t,
38
grub_uint64_t, grub_uint32_t))
41
/* This function resolves overlapping regions and sorts the memory map.
42
It uses scanline (sweeping) algorithm.
44
/* If same page is used by multiple types it's resolved
45
according to priority:
47
2 - memory usable by firmware-aware code
49
4 - a range deliberately empty
51
int priority[GRUB_MACHINE_MEMORY_MAX_TYPE + 2] =
53
#ifdef GRUB_MACHINE_MEMORY_AVAILABLE
54
[GRUB_MACHINE_MEMORY_AVAILABLE] = 1,
56
#if defined (GRUB_MACHINE_MEMORY_RESERVED) && GRUB_MACHINE_MEMORY_RESERVED != GRUB_MACHINE_MEMORY_HOLE
57
[GRUB_MACHINE_MEMORY_RESERVED] = 3,
59
#ifdef GRUB_MACHINE_MEMORY_ACPI
60
[GRUB_MACHINE_MEMORY_ACPI] = 2,
62
#ifdef GRUB_MACHINE_MEMORY_CODE
63
[GRUB_MACHINE_MEMORY_CODE] = 3,
65
#ifdef GRUB_MACHINE_MEMORY_NVS
66
[GRUB_MACHINE_MEMORY_NVS] = 3,
68
[GRUB_MACHINE_MEMORY_HOLE] = 4,
73
/* Scanline events. */
76
/* At which memory address. */
78
/* 0 = region starts, 1 = region ends. */
80
/* Which type of memory region? */
83
struct grub_mmap_scan *scanline_events;
84
struct grub_mmap_scan t;
86
/* Previous scanline event. */
87
grub_uint64_t lastaddr;
89
/* Current scanline event. */
91
/* How many regions of given type overlap at current location? */
92
int present[GRUB_MACHINE_MEMORY_MAX_TYPE + 2];
93
/* Number of mmap chunks. */
96
#ifndef GRUB_MMAP_REGISTER_BY_FIRMWARE
97
struct grub_mmap_region *cur;
100
auto int NESTED_FUNC_ATTR count_hook (grub_uint64_t, grub_uint64_t,
102
int NESTED_FUNC_ATTR count_hook (grub_uint64_t addr __attribute__ ((unused)),
103
grub_uint64_t size __attribute__ ((unused)),
104
grub_uint32_t type __attribute__ ((unused)))
110
auto int NESTED_FUNC_ATTR fill_hook (grub_uint64_t, grub_uint64_t,
112
int NESTED_FUNC_ATTR fill_hook (grub_uint64_t addr,
116
scanline_events[i].pos = addr;
117
scanline_events[i].type = 0;
118
if (type <= GRUB_MACHINE_MEMORY_MAX_TYPE && priority[type])
119
scanline_events[i].memtype = type;
122
grub_dprintf ("mmap", "Unknown memory type %d. Assuming unusable\n",
124
scanline_events[i].memtype = GRUB_MACHINE_MEMORY_RESERVED;
128
scanline_events[i].pos = addr + size;
129
scanline_events[i].type = 1;
130
scanline_events[i].memtype = scanline_events[i - 1].memtype;
138
#ifndef GRUB_MMAP_REGISTER_BY_FIRMWARE
139
for (cur = grub_mmap_overlays; cur; cur = cur->next)
143
grub_machine_mmap_iterate (count_hook);
145
/* Initialize variables. */
146
grub_memset (present, 0, sizeof (present));
147
scanline_events = (struct grub_mmap_scan *)
148
grub_malloc (sizeof (struct grub_mmap_scan) * 2 * mmap_num);
150
if (! scanline_events)
152
return grub_error (GRUB_ERR_OUT_OF_MEMORY,
153
"couldn't allocate space for new memory map");
157
#ifndef GRUB_MMAP_REGISTER_BY_FIRMWARE
158
/* Register scanline events. */
159
for (cur = grub_mmap_overlays; cur; cur = cur->next)
161
scanline_events[i].pos = cur->start;
162
scanline_events[i].type = 0;
163
if (cur->type == GRUB_MACHINE_MEMORY_HOLE
164
|| (cur->type >= 0 && cur->type <= GRUB_MACHINE_MEMORY_MAX_TYPE
165
&& priority[cur->type]))
166
scanline_events[i].memtype = cur->type;
168
scanline_events[i].memtype = GRUB_MACHINE_MEMORY_RESERVED;
171
scanline_events[i].pos = cur->end;
172
scanline_events[i].type = 1;
173
scanline_events[i].memtype = scanline_events[i - 1].memtype;
176
#endif /* ! GRUB_MMAP_REGISTER_BY_FIRMWARE */
178
grub_machine_mmap_iterate (fill_hook);
180
/* Primitive bubble sort. It has complexity O(n^2) but since we're
181
unlikely to have more than 100 chunks it's probably one of the
182
fastest for one purpose. */
187
for (i = 0; i < 2 * mmap_num - 1; i++)
188
if (scanline_events[i + 1].pos < scanline_events[i].pos
189
|| (scanline_events[i + 1].pos == scanline_events[i].pos
190
&& scanline_events[i + 1].type == 0
191
&& scanline_events[i].type == 1))
193
t = scanline_events[i + 1];
194
scanline_events[i + 1] = scanline_events[i];
195
scanline_events[i] = t;
200
lastaddr = scanline_events[0].pos;
201
lasttype = scanline_events[0].memtype;
202
for (i = 0; i < 2 * mmap_num; i++)
205
if (scanline_events[i].type)
206
present[scanline_events[i].memtype]--;
208
present[scanline_events[i].memtype]++;
210
/* Determine current region type. */
212
for (k = 0; k <= GRUB_MACHINE_MEMORY_MAX_TYPE + 1; k++)
213
if (present[k] && (curtype == -1 || priority[k] > priority[curtype]))
216
/* Announce region to the hook if necessary. */
217
if ((curtype == -1 || curtype != lasttype)
218
&& lastaddr != scanline_events[i].pos
220
&& lasttype != GRUB_MACHINE_MEMORY_HOLE
221
&& hook (lastaddr, scanline_events[i].pos - lastaddr, lasttype))
223
grub_free (scanline_events);
224
return GRUB_ERR_NONE;
227
/* Update last values if necessary. */
228
if (curtype == -1 || curtype != lasttype)
231
lastaddr = scanline_events[i].pos;
235
grub_free (scanline_events);
236
return GRUB_ERR_NONE;
239
#ifndef GRUB_MMAP_REGISTER_BY_FIRMWARE
241
grub_mmap_register (grub_uint64_t start, grub_uint64_t size, int type)
243
struct grub_mmap_region *cur;
245
grub_dprintf ("mmap", "registering\n");
247
cur = (struct grub_mmap_region *)
248
grub_malloc (sizeof (struct grub_mmap_region));
251
grub_error (GRUB_ERR_OUT_OF_MEMORY,
252
"couldn't allocate memory map overlay");
256
cur->next = grub_mmap_overlays;
258
cur->end = start + size;
260
cur->handle = curhandle++;
261
grub_mmap_overlays = cur;
263
if (grub_machine_mmap_register (start, size, type, curhandle))
265
grub_mmap_overlays = cur->next;
274
grub_mmap_unregister (int handle)
276
struct grub_mmap_region *cur, *prev;
278
for (cur = grub_mmap_overlays, prev = 0; cur; prev= cur, cur = cur->next)
279
if (handle == cur->handle)
282
if ((err = grub_machine_mmap_unregister (handle)))
286
prev->next = cur->next;
288
grub_mmap_overlays = cur->next;
290
return GRUB_ERR_NONE;
292
return grub_error (GRUB_ERR_BAD_ARGUMENT, "mmap overlay not found");
295
#endif /* ! GRUB_MMAP_REGISTER_BY_FIRMWARE */
297
#define CHUNK_SIZE 0x400
299
static inline grub_uint64_t
300
fill_mask (grub_uint64_t addr, grub_uint64_t mask, grub_uint64_t iterator)
303
grub_uint64_t ret = (addr & mask);
305
/* Find first fixed bit. */
306
for (i = 0; i < 64; i++)
307
if ((mask & (1ULL << i)) != 0)
311
if ((mask & (1ULL << i)) == 0)
313
if ((iterator & (1ULL << j)) != 0)
321
grub_cmd_badram (grub_command_t cmd __attribute__ ((unused)),
322
int argc, char **args)
325
grub_uint64_t badaddr, badmask;
327
auto int NESTED_FUNC_ATTR hook (grub_uint64_t, grub_uint64_t, grub_uint32_t);
328
int NESTED_FUNC_ATTR hook (grub_uint64_t addr,
330
grub_uint32_t type __attribute__ ((unused)))
332
grub_uint64_t iterator, low, high, cur;
335
grub_dprintf ("badram", "hook %llx+%llx\n", (unsigned long long) addr,
336
(unsigned long long) size);
338
/* How many trailing zeros? */
339
for (tail = 0; ! (badmask & (1ULL << tail)); tail++);
341
/* How many zeros in mask? */
343
for (i = 0; i < 64; i++)
344
if (! (badmask & (1ULL << i)))
347
if (fill_mask (badaddr, badmask, 0) >= addr)
353
/* Find starting value. Keep low and high such that
354
fill_mask (low) < addr and fill_mask (high) >= addr;
356
while (high - low > 1)
358
cur = (low + high) / 2;
359
if (fill_mask (badaddr, badmask, cur) >= addr)
367
for (; iterator < (1ULL << (var - tail))
368
&& (cur = fill_mask (badaddr, badmask, iterator)) < addr + size;
371
grub_dprintf ("badram", "%llx (size %llx) is a badram range\n",
372
(unsigned long long) cur, (1ULL << tail));
373
grub_mmap_register (cur, (1ULL << tail), GRUB_MACHINE_MEMORY_HOLE);
379
return grub_error (GRUB_ERR_BAD_ARGUMENT, "badram string required");
381
grub_dprintf ("badram", "executing badram\n");
387
/* Parse address and mask. */
388
badaddr = grub_strtoull (str, &str, 16);
391
badmask = grub_strtoull (str, &str, 16);
395
if (grub_errno == GRUB_ERR_BAD_NUMBER)
398
return GRUB_ERR_NONE;
401
/* When part of a page is tainted, we discard the whole of it. There's
402
no point in providing sub-page chunks. */
403
badmask &= ~(CHUNK_SIZE - 1);
405
grub_dprintf ("badram", "badram %llx:%llx\n",
406
(unsigned long long) badaddr, (unsigned long long) badmask);
408
grub_mmap_iterate (hook);
412
static grub_command_t cmd;
417
cmd = grub_register_command ("badram", grub_cmd_badram,
418
N_("ADDR1,MASK1[,ADDR2,MASK2[,...]]"),
419
N_("Declare memory regions as badram."));
424
grub_unregister_command (cmd);