Subversion Repositories HelenOS

Rev

Rev 4153 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2005 Jakub Jermar
3
 * Copyright (c) 2005 Sergey Bondari
1 jermar 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
 
1854 jermar 30
/** @addtogroup genericmm
1702 cejka 31
 * @{
32
 */
33
/** @file
34
 */
35
 
1854 jermar 36
#ifndef KERN_FRAME_H_
37
#define KERN_FRAME_H_
1 jermar 38
 
39
#include <arch/types.h>
788 jermar 40
#include <adt/list.h>
4153 mejdrech 41
#include <mm/buddy.h>
354 jermar 42
#include <synch/spinlock.h>
814 palkovsky 43
#include <arch/mm/page.h>
935 vana 44
#include <arch/mm/frame.h>
1 jermar 45
 
4153 mejdrech 46
#define ONE_FRAME    0
47
#define TWO_FRAMES   1
48
#define FOUR_FRAMES  2
548 jermar 49
 
2465 jermar 50
 
935 vana 51
#ifdef ARCH_STACK_FRAMES
4153 mejdrech 52
    #define STACK_FRAMES  ARCH_STACK_FRAMES
935 vana 53
#else
4153 mejdrech 54
    #define STACK_FRAMES  ONE_FRAME
935 vana 55
#endif
56
 
4153 mejdrech 57
/** Maximum number of zones in the system. */
58
#define ZONES_MAX  32
814 palkovsky 59
 
4153 mejdrech 60
typedef uint8_t frame_flags_t;
61
 
62
/** Convert the frame address to kernel VA. */
63
#define FRAME_KA          0x01
2059 jermar 64
/** Do not panic and do not sleep on failure. */
4153 mejdrech 65
#define FRAME_ATOMIC      0x02
2059 jermar 66
/** Do not start reclaiming when no free memory. */
4153 mejdrech 67
#define FRAME_NO_RECLAIM  0x04
1 jermar 68
 
4153 mejdrech 69
typedef uint8_t zone_flags_t;
70
 
71
/** Available zone (free for allocation) */
72
#define ZONE_AVAILABLE  0x00
73
/** Zone is reserved (not available for allocation) */
74
#define ZONE_RESERVED   0x08
75
/** Zone is used by firmware (not available for allocation) */
76
#define ZONE_FIRMWARE   0x10
77
 
78
/** Currently there is no equivalent zone flags
79
    for frame flags */
80
#define FRAME_TO_ZONE_FLAGS(frame_flags)  0
81
 
82
typedef struct {
4581 mejdrech 83
    size_t refcount;     /**< Tracking of shared frames */
4153 mejdrech 84
    uint8_t buddy_order;  /**< Buddy system block order */
85
    link_t buddy_link;    /**< Link to the next free block inside
86
                               one order */
87
    void *parent;         /**< If allocated by slab, this points there */
88
} frame_t;
89
 
90
typedef struct {
91
    pfn_t base;                    /**< Frame_no of the first frame
92
                                        in the frames array */
4581 mejdrech 93
    size_t count;                 /**< Size of zone */
94
    size_t free_count;            /**< Number of free frame_t
4153 mejdrech 95
                                        structures */
4581 mejdrech 96
    size_t busy_count;            /**< Number of busy frame_t
4153 mejdrech 97
                                        structures */
98
    zone_flags_t flags;            /**< Type of the zone */
99
 
100
    frame_t *frames;               /**< Array of frame_t structures
101
                                        in this zone */
102
    buddy_system_t *buddy_system;  /**< Buddy system for the zone */
103
} zone_t;
104
 
105
/*
106
 * The zoneinfo.lock must be locked when accessing zoneinfo structure.
107
 * Some of the attributes in zone_t structures are 'read-only'
108
 */
109
typedef struct {
110
    SPINLOCK_DECLARE(lock);
4581 mejdrech 111
    size_t count;
4153 mejdrech 112
    zone_t info[ZONES_MAX];
113
} zones_t;
114
 
115
extern zones_t zones;
116
 
1780 jermar 117
static inline uintptr_t PFN2ADDR(pfn_t frame)
814 palkovsky 118
{
2059 jermar 119
    return (uintptr_t) (frame << FRAME_WIDTH);
814 palkovsky 120
}
121
 
1780 jermar 122
static inline pfn_t ADDR2PFN(uintptr_t addr)
814 palkovsky 123
{
2059 jermar 124
    return (pfn_t) (addr >> FRAME_WIDTH);
814 palkovsky 125
}
126
 
4581 mejdrech 127
static inline size_t SIZE2FRAMES(size_t size)
814 palkovsky 128
{
129
    if (!size)
130
        return 0;
4581 mejdrech 131
    return (size_t) ((size - 1) >> FRAME_WIDTH) + 1;
814 palkovsky 132
}
133
 
4581 mejdrech 134
static inline size_t FRAMES2SIZE(size_t frames)
2725 decky 135
{
136
    return (size_t) (frames << FRAME_WIDTH);
137
}
138
 
4153 mejdrech 139
static inline bool zone_flags_available(zone_flags_t flags)
140
{
141
    return ((flags & (ZONE_RESERVED | ZONE_FIRMWARE)) == 0);
142
}
143
 
144
#define IS_BUDDY_ORDER_OK(index, order) \
3207 jermar 145
    ((~(((unative_t) -1) << (order)) & (index)) == 0)
4153 mejdrech 146
#define IS_BUDDY_LEFT_BLOCK(zone, frame) \
147
    (((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 0)
148
#define IS_BUDDY_RIGHT_BLOCK(zone, frame) \
149
    (((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 1)
150
#define IS_BUDDY_LEFT_BLOCK_ABS(zone, frame) \
151
    (((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 0)
152
#define IS_BUDDY_RIGHT_BLOCK_ABS(zone, frame) \
153
    (((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 1)
479 bondari 154
 
4153 mejdrech 155
#define frame_alloc(order, flags) \
3207 jermar 156
    frame_alloc_generic(order, flags, NULL)
786 bondari 157
 
1 jermar 158
extern void frame_init(void);
4581 mejdrech 159
extern void *frame_alloc_generic(uint8_t, frame_flags_t, size_t *);
3207 jermar 160
extern void frame_free(uintptr_t);
161
extern void frame_reference_add(pfn_t);
689 bondari 162
 
4581 mejdrech 163
extern size_t find_zone(pfn_t frame, size_t count, size_t hint);
164
extern size_t zone_create(pfn_t, size_t, pfn_t, zone_flags_t);
165
extern void *frame_get_parent(pfn_t, size_t);
166
extern void frame_set_parent(pfn_t, void *, size_t);
167
extern void frame_mark_unavailable(pfn_t, size_t);
168
extern uintptr_t zone_conf_size(size_t);
169
extern bool zone_merge(size_t, size_t);
2725 decky 170
extern void zone_merge_all(void);
171
extern uint64_t zone_total_size(void);
479 bondari 172
 
173
/*
676 bondari 174
 * Console functions
175
 */
176
extern void zone_print_list(void);
4581 mejdrech 177
extern void zone_print_one(size_t);
676 bondari 178
 
1 jermar 179
#endif
1702 cejka 180
 
1854 jermar 181
/** @}
1702 cejka 182
 */