kernel/generic/include/mm/frame.h

   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 <arch/types.h>
  40 #include <typedefs.h>
  41 #include <adt/list.h>
  42 #include <synch/spinlock.h>
  43 #include <mm/buddy.h>
  44 #include <arch/mm/page.h>
  45 #include <arch/mm/frame.h>
  46
  47 #define ONE_FRAME       0
  48 #define TWO_FRAMES      1
  49
  50 #ifdef ARCH_STACK_FRAMES
  51 #define STACK_FRAMES ARCH_STACK_FRAMES
  52 #else
  53 #define STACK_FRAMES ONE_FRAME
  54 #endif
  55
  56 #define ZONES_MAX       16      /**< Maximum number of zones in system */
  57
  58 #define ZONE_JOIN       0x1     /**< If possible, merge with neighbouring zones */
  59
  60 #define FRAME_KA                0x1     /* convert the frame address to kernel va */
  61 #define FRAME_ATOMIC            0x2     /* do not panic and do not sleep on failure */
  62 #define FRAME_NO_RECLAIM        0x4     /* do not start reclaiming when no free memory */
  63
  64 static inline uintptr_t PFN2ADDR(pfn_t frame)
  65 {
  66         return (uintptr_t)(frame << FRAME_WIDTH);
  67 }
  68
  69 static inline pfn_t ADDR2PFN(uintptr_t addr)
  70 {
  71         return (pfn_t)(addr >> FRAME_WIDTH);
  72 }
  73
  74 static inline count_t SIZE2FRAMES(size_t size)
  75 {
  76         if (!size)
  77                 return 0;
  78         return (count_t)((size-1) >> FRAME_WIDTH)+1;
  79 }
  80
  81 #define IS_BUDDY_ORDER_OK(index, order)         ((~(((unative_t) -1) << (order)) & (index)) == 0)
  82 #define IS_BUDDY_LEFT_BLOCK(zone, frame)        (((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 0)
  83 #define IS_BUDDY_RIGHT_BLOCK(zone, frame)       (((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 1)
  84 #define IS_BUDDY_LEFT_BLOCK_ABS(zone, frame)    (((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 0)
  85 #define IS_BUDDY_RIGHT_BLOCK_ABS(zone, frame)   (((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 1)
  86
  87 #define frame_alloc(order, flags)               frame_alloc_generic(order, flags, NULL)
  88
  89 extern void frame_init(void);
  90 extern void * frame_alloc_generic(uint8_t order, int flags, int *pzone);
  91 extern void frame_free(uintptr_t frame);
  92 extern void frame_reference_add(pfn_t pfn);
  93
  94 extern int zone_create(pfn_t start, count_t count, pfn_t confframe, int flags);
  95 void * frame_get_parent(pfn_t frame, int hint);
  96 void frame_set_parent(pfn_t frame, void *data, int hint);
  97 void frame_mark_unavailable(pfn_t start, count_t count);
  98 uintptr_t zone_conf_size(count_t count);
  99 void zone_merge(int z1, int z2);
 100 void zone_merge_all(void);
 101
 102 /*
 103  * Console functions
 104  */
 105 extern void zone_print_list(void);
 106 void zone_print_one(int znum);
 107
 108 #endif
 109
 110 /** @}
 111  */