| 1 | /*
|
|---|
| 2 | * Copyright (c) 2005 Jakub Jermar
|
|---|
| 3 | * Copyright (c) 2005 Sergey Bondari
|
|---|
| 4 | * All rights reserved.
|
|---|
| 5 | *
|
|---|
| 6 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 7 | * modification, are permitted provided that the following conditions
|
|---|
| 8 | * are met:
|
|---|
| 9 | *
|
|---|
| 10 | * - Redistributions of source code must retain the above copyright
|
|---|
| 11 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 12 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 13 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 14 | * documentation and/or other materials provided with the distribution.
|
|---|
| 15 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 16 | * derived from this software without specific prior written permission.
|
|---|
| 17 | *
|
|---|
| 18 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 19 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 20 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 21 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 22 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 23 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 24 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 25 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 26 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 27 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 28 | */
|
|---|
| 29 |
|
|---|
| 30 | /** @addtogroup genericmm
|
|---|
| 31 | * @{
|
|---|
| 32 | */
|
|---|
| 33 | /** @file
|
|---|
| 34 | */
|
|---|
| 35 |
|
|---|
| 36 | #ifndef KERN_FRAME_H_
|
|---|
| 37 | #define KERN_FRAME_H_
|
|---|
| 38 |
|
|---|
| 39 | #include <typedefs.h>
|
|---|
| 40 | #include <trace.h>
|
|---|
| 41 | #include <adt/list.h>
|
|---|
| 42 | #include <mm/buddy.h>
|
|---|
| 43 | #include <synch/spinlock.h>
|
|---|
| 44 | #include <arch/mm/page.h>
|
|---|
| 45 | #include <arch/mm/frame.h>
|
|---|
| 46 |
|
|---|
| 47 | /** Maximum number of zones in the system. */
|
|---|
| 48 | #define ZONES_MAX 32
|
|---|
| 49 |
|
|---|
| 50 | typedef uint8_t frame_flags_t;
|
|---|
| 51 |
|
|---|
| 52 | #define FRAME_NONE 0x0
|
|---|
| 53 | /** Convert the frame address to kernel VA. */
|
|---|
| 54 | #define FRAME_KA 0x1
|
|---|
| 55 | /** Do not panic and do not sleep on failure. */
|
|---|
| 56 | #define FRAME_ATOMIC 0x2
|
|---|
| 57 | /** Do not start reclaiming when no free memory. */
|
|---|
| 58 | #define FRAME_NO_RECLAIM 0x4
|
|---|
| 59 | /** Do not reserve / unreserve memory. */
|
|---|
| 60 | #define FRAME_NO_RESERVE 0x8
|
|---|
| 61 | /** Allocate a frame which can be identity-mapped. */
|
|---|
| 62 | #define FRAME_LOWMEM 0x10
|
|---|
| 63 | /** Allocate a frame which cannot be identity-mapped. */
|
|---|
| 64 | #define FRAME_HIGHMEM 0x20
|
|---|
| 65 |
|
|---|
| 66 | typedef uint8_t zone_flags_t;
|
|---|
| 67 |
|
|---|
| 68 | #define ZONE_NONE 0x0
|
|---|
| 69 | /** Available zone (free for allocation) */
|
|---|
| 70 | #define ZONE_AVAILABLE 0x1
|
|---|
| 71 | /** Zone is reserved (not available for allocation) */
|
|---|
| 72 | #define ZONE_RESERVED 0x2
|
|---|
| 73 | /** Zone is used by firmware (not available for allocation) */
|
|---|
| 74 | #define ZONE_FIRMWARE 0x4
|
|---|
| 75 | /** Zone contains memory that can be identity-mapped */
|
|---|
| 76 | #define ZONE_LOWMEM 0x8
|
|---|
| 77 | /** Zone contains memory that cannot be identity-mapped */
|
|---|
| 78 | #define ZONE_HIGHMEM 0x10
|
|---|
| 79 |
|
|---|
| 80 | /** Mask of zone bits that must be matched exactly. */
|
|---|
| 81 | #define ZONE_EF_MASK 0x7
|
|---|
| 82 |
|
|---|
| 83 | #define FRAME_TO_ZONE_FLAGS(ff) \
|
|---|
| 84 | ((((ff) & FRAME_LOWMEM) ? ZONE_LOWMEM : \
|
|---|
| 85 | (((ff) & FRAME_HIGHMEM) ? ZONE_HIGHMEM : ZONE_NONE)) | \
|
|---|
| 86 | (ZONE_AVAILABLE | ZONE_LOWMEM /* | ZONE_HIGHMEM */))
|
|---|
| 87 |
|
|---|
| 88 | #define ZONE_FLAGS_MATCH(zf, f) \
|
|---|
| 89 | (((((zf) & ZONE_EF_MASK)) == ((f) & ZONE_EF_MASK)) && \
|
|---|
| 90 | (((zf) & ~ZONE_EF_MASK) & (f)))
|
|---|
| 91 |
|
|---|
| 92 | typedef struct {
|
|---|
| 93 | size_t refcount; /**< Tracking of shared frames */
|
|---|
| 94 | link_t buddy_link; /**< Link to the next free block inside
|
|---|
| 95 | one order */
|
|---|
| 96 | void *parent; /**< If allocated by slab, this points there */
|
|---|
| 97 | uint8_t buddy_order; /**< Buddy system block order */
|
|---|
| 98 | } frame_t;
|
|---|
| 99 |
|
|---|
| 100 | typedef struct {
|
|---|
| 101 | pfn_t base; /**< Frame_no of the first frame
|
|---|
| 102 | in the frames array */
|
|---|
| 103 | size_t count; /**< Size of zone */
|
|---|
| 104 | size_t free_count; /**< Number of free frame_t
|
|---|
| 105 | structures */
|
|---|
| 106 | size_t busy_count; /**< Number of busy frame_t
|
|---|
| 107 | structures */
|
|---|
| 108 | zone_flags_t flags; /**< Type of the zone */
|
|---|
| 109 |
|
|---|
| 110 | frame_t *frames; /**< Array of frame_t structures
|
|---|
| 111 | in this zone */
|
|---|
| 112 | buddy_system_t *buddy_system; /**< Buddy system for the zone */
|
|---|
| 113 | } zone_t;
|
|---|
| 114 |
|
|---|
| 115 | /*
|
|---|
| 116 | * The zoneinfo.lock must be locked when accessing zoneinfo structure.
|
|---|
| 117 | * Some of the attributes in zone_t structures are 'read-only'
|
|---|
| 118 | */
|
|---|
| 119 | typedef struct {
|
|---|
| 120 | IRQ_SPINLOCK_DECLARE(lock);
|
|---|
| 121 | size_t count;
|
|---|
| 122 | zone_t info[ZONES_MAX];
|
|---|
| 123 | } zones_t;
|
|---|
| 124 |
|
|---|
| 125 | extern zones_t zones;
|
|---|
| 126 |
|
|---|
| 127 | NO_TRACE static inline uintptr_t PFN2ADDR(pfn_t frame)
|
|---|
| 128 | {
|
|---|
| 129 | return (uintptr_t) (frame << FRAME_WIDTH);
|
|---|
| 130 | }
|
|---|
| 131 |
|
|---|
| 132 | NO_TRACE static inline pfn_t ADDR2PFN(uintptr_t addr)
|
|---|
| 133 | {
|
|---|
| 134 | return (pfn_t) (addr >> FRAME_WIDTH);
|
|---|
| 135 | }
|
|---|
| 136 |
|
|---|
| 137 | NO_TRACE static inline size_t SIZE2FRAMES(size_t size)
|
|---|
| 138 | {
|
|---|
| 139 | if (!size)
|
|---|
| 140 | return 0;
|
|---|
| 141 | return (size_t) ((size - 1) >> FRAME_WIDTH) + 1;
|
|---|
| 142 | }
|
|---|
| 143 |
|
|---|
| 144 | NO_TRACE static inline size_t FRAMES2SIZE(size_t frames)
|
|---|
| 145 | {
|
|---|
| 146 | return (size_t) (frames << FRAME_WIDTH);
|
|---|
| 147 | }
|
|---|
| 148 |
|
|---|
| 149 | #define IS_BUDDY_ORDER_OK(index, order) \
|
|---|
| 150 | ((~(((sysarg_t) -1) << (order)) & (index)) == 0)
|
|---|
| 151 | #define IS_BUDDY_LEFT_BLOCK(zone, frame) \
|
|---|
| 152 | (((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 0)
|
|---|
| 153 | #define IS_BUDDY_RIGHT_BLOCK(zone, frame) \
|
|---|
| 154 | (((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 1)
|
|---|
| 155 | #define IS_BUDDY_LEFT_BLOCK_ABS(zone, frame) \
|
|---|
| 156 | (((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 0)
|
|---|
| 157 | #define IS_BUDDY_RIGHT_BLOCK_ABS(zone, frame) \
|
|---|
| 158 | (((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 1)
|
|---|
| 159 |
|
|---|
| 160 | extern void frame_init(void);
|
|---|
| 161 | extern bool frame_adjust_zone_bounds(bool, uintptr_t *, size_t *);
|
|---|
| 162 | extern void *frame_alloc_generic(uint8_t, frame_flags_t, size_t *);
|
|---|
| 163 | extern void *frame_alloc(uint8_t, frame_flags_t);
|
|---|
| 164 | extern void *frame_alloc_noreserve(uint8_t, frame_flags_t);
|
|---|
| 165 | extern void frame_free_generic(uintptr_t, frame_flags_t);
|
|---|
| 166 | extern void frame_free(uintptr_t);
|
|---|
| 167 | extern void frame_free_noreserve(uintptr_t);
|
|---|
| 168 | extern void frame_reference_add(pfn_t);
|
|---|
| 169 | extern size_t frame_total_free_get(void);
|
|---|
| 170 |
|
|---|
| 171 | extern size_t find_zone(pfn_t, size_t, size_t);
|
|---|
| 172 | extern size_t zone_create(pfn_t, size_t, pfn_t, zone_flags_t);
|
|---|
| 173 | extern void *frame_get_parent(pfn_t, size_t);
|
|---|
| 174 | extern void frame_set_parent(pfn_t, void *, size_t);
|
|---|
| 175 | extern void frame_mark_unavailable(pfn_t, size_t);
|
|---|
| 176 | extern size_t zone_conf_size(size_t);
|
|---|
| 177 | extern pfn_t zone_external_conf_alloc(size_t);
|
|---|
| 178 | extern bool zone_merge(size_t, size_t);
|
|---|
| 179 | extern void zone_merge_all(void);
|
|---|
| 180 | extern uint64_t zones_total_size(void);
|
|---|
| 181 | extern void zones_stats(uint64_t *, uint64_t *, uint64_t *, uint64_t *);
|
|---|
| 182 |
|
|---|
| 183 | /*
|
|---|
| 184 | * Console functions
|
|---|
| 185 | */
|
|---|
| 186 | extern void zones_print_list(void);
|
|---|
| 187 | extern void zone_print_one(size_t);
|
|---|
| 188 |
|
|---|
| 189 | #endif
|
|---|
| 190 |
|
|---|
| 191 | /** @}
|
|---|
| 192 | */
|
|---|
