1/* $OpenBSD: hibernate_var.h,v 1.16 2025/05/21 04:05:22 mlarkin Exp $ */
2
3/*
4 * Copyright (c) 2011 Mike Larkin <mlarkin@openbsd.org>
5 *
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19#define HIB_PD_MASK 0xffc00000
20#define PIGLET_PAGE_MASK (HIB_PD_MASK)
21
22#define HIBERNATE_PD_PAGE (PAGE_SIZE * 21)
23#define HIBERNATE_PT_PAGE (PAGE_SIZE * 22)
24/* 2 pages for stack */
25#define HIBERNATE_STACK_PAGE (PAGE_SIZE * 24)
26#define HIBERNATE_INFLATE_PAGE (PAGE_SIZE * 25)
27/* HIBERNATE_HIBALLOC_PAGE must be the last stolen page (see machdep.c) */
28#define HIBERNATE_HIBALLOC_PAGE (PAGE_SIZE * 26)
29
30/* Use 4MB hibernation chunks */
31#define HIBERNATE_CHUNK_SIZE 0x400000
32
33#define HIBERNATE_CHUNK_TABLE_SIZE 0x100000
34
35#define HIBERNATE_STACK_OFFSET 0x0F00
36
37#define atop_4m(x) ((x) >> PDSHIFT)
38#define atop_4k(x) ((x) >> PAGE_SHIFT)
39#define s4pde_4m(va) ((pt_entry_t *)HIBERNATE_PD_PAGE + atop_4m(va))
40#define s4pde_4k(va) ((pt_entry_t *)HIBERNATE_PD_PAGE + atop_4k(va))
41#define s4pte_4k(va) ((pt_entry_t *)HIBERNATE_PT_PAGE + atop_4k(va))
42
43/*
44 * Minimum amount of memory for hibernate support. This is used in early boot
45 * when deciding if we can preallocate the piglet. If the machine does not
46 * have at least HIBERNATE_MIN_MEMORY RAM, we won't support hibernate. This
47 * avoids late allocation issues due to fragmented memory and failure to
48 * hibernate. We need to be able to allocate 16MB contiguous memory, aligned
49 * to 2MB.
50 *
51 * The default minimum required memory is 512MB (1ULL << 29).
52 */
53#define HIBERNATE_MIN_MEMORY (1ULL << 29)