source: mainline/kernel/generic/include/mm/frame.h@ e2a0d76

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since e2a0d76 was 8cbf1c3, checked in by Martin Decky <martin@…>, 12 years ago

prepare the public API of the frame allocator for the new backend
remove FRAME_KA (can be easily implemented explicitly)
  • Property mode set to 100644
File size: 6.5 KB
Line 
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
50typedef uint8_t frame_flags_t;
51
52#define FRAME_NONE 0x00
53/** Do not panic and do not sleep on failure. */
54#define FRAME_ATOMIC 0x01
55/** Do not start reclaiming when no free memory. */
56#define FRAME_NO_RECLAIM 0x02
57/** Do not reserve / unreserve memory. */
58#define FRAME_NO_RESERVE 0x04
59/** Allocate a frame which can be identity-mapped. */
60#define FRAME_LOWMEM 0x08
61/** Allocate a frame which cannot be identity-mapped. */
62#define FRAME_HIGHMEM 0x10
63
64typedef uint8_t zone_flags_t;
65
66#define ZONE_NONE 0x00
67/** Available zone (free for allocation) */
68#define ZONE_AVAILABLE 0x01
69/** Zone is reserved (not available for allocation) */
70#define ZONE_RESERVED 0x02
71/** Zone is used by firmware (not available for allocation) */
72#define ZONE_FIRMWARE 0x04
73/** Zone contains memory that can be identity-mapped */
74#define ZONE_LOWMEM 0x08
75/** Zone contains memory that cannot be identity-mapped */
76#define ZONE_HIGHMEM 0x10
77
78/** Mask of zone bits that must be matched exactly. */
79#define ZONE_EF_MASK 0x07
80
81#define FRAME_TO_ZONE_FLAGS(ff) \
82 ((((ff) & FRAME_LOWMEM) ? ZONE_LOWMEM : \
83 (((ff) & FRAME_HIGHMEM) ? ZONE_HIGHMEM : \
84 ZONE_LOWMEM /* | ZONE_HIGHMEM */)) | \
85 ZONE_AVAILABLE)
86
87#define ZONE_FLAGS_MATCH(zf, f) \
88 (((((zf) & ZONE_EF_MASK)) == ((f) & ZONE_EF_MASK)) && \
89 (((zf) & ~ZONE_EF_MASK) & (f)))
90
91typedef struct {
92 size_t refcount; /**< Tracking of shared frames */
93 link_t buddy_link; /**< Link to the next free block inside
94 one order */
95 void *parent; /**< If allocated by slab, this points there */
96 uint8_t buddy_order; /**< Buddy system block order */
97} frame_t;
98
99typedef struct {
100 pfn_t base; /**< Frame_no of the first frame
101 in the frames array */
102 size_t count; /**< Size of zone */
103 size_t free_count; /**< Number of free frame_t
104 structures */
105 size_t busy_count; /**< Number of busy frame_t
106 structures */
107 zone_flags_t flags; /**< Type of the zone */
108
109 frame_t *frames; /**< Array of frame_t structures
110 in this zone */
111 buddy_system_t *buddy_system; /**< Buddy system for the zone */
112} zone_t;
113
114/*
115 * The zoneinfo.lock must be locked when accessing zoneinfo structure.
116 * Some of the attributes in zone_t structures are 'read-only'
117 */
118typedef struct {
119 IRQ_SPINLOCK_DECLARE(lock);
120 size_t count;
121 zone_t info[ZONES_MAX];
122} zones_t;
123
124extern zones_t zones;
125
126NO_TRACE static inline uintptr_t PFN2ADDR(pfn_t frame)
127{
128 return (uintptr_t) (frame << FRAME_WIDTH);
129}
130
131NO_TRACE static inline pfn_t ADDR2PFN(uintptr_t addr)
132{
133 return (pfn_t) (addr >> FRAME_WIDTH);
134}
135
136NO_TRACE static inline size_t SIZE2FRAMES(size_t size)
137{
138 if (size == 0)
139 return 0;
140
141 return (size_t) ((size - 1) >> FRAME_WIDTH) + 1;
142}
143
144NO_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
160extern void frame_init(void);
161extern bool frame_adjust_zone_bounds(bool, uintptr_t *, size_t *);
162extern uintptr_t frame_alloc_generic(uint8_t, frame_flags_t, uintptr_t, size_t *);
163extern uintptr_t frame_alloc(uint8_t, frame_flags_t, uintptr_t);
164extern uintptr_t frame_alloc_noreserve(uint8_t, frame_flags_t, uintptr_t);
165extern void frame_free_generic(uintptr_t, frame_flags_t);
166extern void frame_free(uintptr_t);
167extern void frame_free_noreserve(uintptr_t);
168extern void frame_reference_add(pfn_t);
169extern size_t frame_total_free_get(void);
170
171extern size_t find_zone(pfn_t, size_t, size_t);
172extern size_t zone_create(pfn_t, size_t, pfn_t, zone_flags_t);
173extern void *frame_get_parent(pfn_t, size_t);
174extern void frame_set_parent(pfn_t, void *, size_t);
175extern void frame_mark_unavailable(pfn_t, size_t);
176extern size_t zone_conf_size(size_t);
177extern pfn_t zone_external_conf_alloc(size_t);
178extern bool zone_merge(size_t, size_t);
179extern void zone_merge_all(void);
180extern uint64_t zones_total_size(void);
181extern void zones_stats(uint64_t *, uint64_t *, uint64_t *, uint64_t *);
182
183/*
184 * Console functions
185 */
186extern void zones_print_list(void);
187extern void zone_print_one(size_t);
188
189#endif
190
191/** @}
192 */
Note: See TracBrowser for help on using the repository browser.