Subversion Repositories HelenOS

Rev

Rev 2089 | Rev 2094 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2001-2004 Jakub Jermar
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup genericmm
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #ifndef KERN_AS_H_
  36. #define KERN_AS_H_
  37.  
  38. /** Address space area flags. */
  39. #define AS_AREA_READ        1
  40. #define AS_AREA_WRITE       2
  41. #define AS_AREA_EXEC        4
  42. #define AS_AREA_CACHEABLE   8
  43.  
  44. #ifdef KERNEL
  45.  
  46. #include <arch/mm/page.h>
  47. #include <arch/mm/as.h>
  48. #include <arch/mm/asid.h>
  49. #include <arch/types.h>
  50. #include <synch/spinlock.h>
  51. #include <synch/mutex.h>
  52. #include <adt/list.h>
  53. #include <adt/btree.h>
  54. #include <lib/elf.h>
  55.  
  56. /** Defined to be true if user address space and kernel address space shadow each other. */
  57. #define KERNEL_ADDRESS_SPACE_SHADOWED   KERNEL_ADDRESS_SPACE_SHADOWED_ARCH
  58.  
  59. #define KERNEL_ADDRESS_SPACE_START  KERNEL_ADDRESS_SPACE_START_ARCH
  60. #define KERNEL_ADDRESS_SPACE_END    KERNEL_ADDRESS_SPACE_END_ARCH
  61. #define USER_ADDRESS_SPACE_START    USER_ADDRESS_SPACE_START_ARCH
  62. #define USER_ADDRESS_SPACE_END      USER_ADDRESS_SPACE_END_ARCH
  63.  
  64. #define USTACK_ADDRESS  USTACK_ADDRESS_ARCH
  65.  
  66. #define FLAG_AS_KERNEL      (1 << 0)    /**< Kernel address space. */
  67.  
  68. /** Address space area attributes. */
  69. #define AS_AREA_ATTR_NONE   0
  70. #define AS_AREA_ATTR_PARTIAL    1   /**< Not fully initialized area. */
  71.  
  72. #define AS_PF_FAULT     0   /**< The page fault was not resolved by as_page_fault(). */
  73. #define AS_PF_OK        1   /**< The page fault was resolved by as_page_fault(). */
  74. #define AS_PF_DEFER     2   /**< The page fault was caused by memcpy_from_uspace() or memcpy_to_uspace(). */
  75.  
  76. typedef struct {
  77.     pte_t *(* page_table_create)(int flags);
  78.     void (* page_table_destroy)(pte_t *page_table);
  79.     void (* page_table_lock)(as_t *as, bool lock);
  80.     void (* page_table_unlock)(as_t *as, bool unlock);
  81. } as_operations_t;
  82.  
  83. /** This structure contains information associated with the shared address space area. */
  84. typedef struct {
  85.     mutex_t lock;       /**< This lock must be acquired only when the as_area lock is held. */
  86.     count_t refcount;   /**< This structure can be deallocated if refcount drops to 0. */
  87.     btree_t pagemap;    /**< B+tree containing complete map of anonymous pages of the shared area. */
  88. } share_info_t;
  89.  
  90. /** Page fault access type. */
  91. typedef enum {
  92.     PF_ACCESS_READ,
  93.     PF_ACCESS_WRITE,
  94.     PF_ACCESS_EXEC
  95. } pf_access_t;
  96.  
  97. struct mem_backend;
  98.  
  99. /** Backend data stored in address space area. */
  100. typedef union mem_backend_data {
  101.     struct {    /**< elf_backend members */
  102.         elf_header_t *elf;
  103.         elf_segment_header_t *segment;
  104.     };
  105.     struct {    /**< phys_backend members */
  106.         uintptr_t base;
  107.         count_t frames;
  108.     };
  109. } mem_backend_data_t;
  110.  
  111. /** Address space area structure.
  112.  *
  113.  * Each as_area_t structure describes one contiguous area of virtual memory.
  114.  * In the future, it should not be difficult to support shared areas.
  115.  */
  116. typedef struct {
  117.     mutex_t lock;
  118.     as_t *as;       /**< Containing address space. */
  119.     int flags;      /**< Flags related to the memory represented by the address space area. */
  120.     int attributes;     /**< Attributes related to the address space area itself. */
  121.     count_t pages;      /**< Size of this area in multiples of PAGE_SIZE. */
  122.     uintptr_t base;     /**< Base address of this area. */
  123.     btree_t used_space; /**< Map of used space. */
  124.     share_info_t *sh_info;  /**< If the address space area has been shared, this pointer will
  125.                          reference the share info structure. */
  126.     struct mem_backend *backend;    /**< Memory backend backing this address space area. */
  127.  
  128.     /** Data to be used by the backend. */
  129.     mem_backend_data_t backend_data;
  130. } as_area_t;
  131.  
  132. /** Address space area backend structure. */
  133. typedef struct mem_backend {
  134.     int (* page_fault)(as_area_t *area, uintptr_t addr, pf_access_t access);
  135.     void (* frame_free)(as_area_t *area, uintptr_t page, uintptr_t frame);
  136.     void (* share)(as_area_t *area);
  137. } mem_backend_t;
  138.  
  139. extern as_t *AS_KERNEL;
  140. extern as_operations_t *as_operations;
  141.  
  142. SPINLOCK_EXTERN(inactive_as_with_asid_lock);
  143. extern link_t inactive_as_with_asid_head;
  144.  
  145. extern void as_init(void);
  146.  
  147. extern as_t *as_create(int flags);
  148. extern void as_destroy(as_t *as);
  149. extern void as_switch(as_t *old, as_t *new);
  150. extern int as_page_fault(uintptr_t page, pf_access_t access, istate_t *istate);
  151.  
  152. extern as_area_t *as_area_create(as_t *as, int flags, size_t size, uintptr_t base, int attrs,
  153.     mem_backend_t *backend, mem_backend_data_t *backend_data);
  154. extern int as_area_destroy(as_t *as, uintptr_t address);   
  155. extern int as_area_resize(as_t *as, uintptr_t address, size_t size, int flags);
  156. int as_area_share(as_t *src_as, uintptr_t src_base, size_t acc_size,
  157.           as_t *dst_as, uintptr_t dst_base, int dst_flags_mask);
  158.  
  159. extern int as_area_get_flags(as_area_t *area);
  160. extern bool as_area_check_access(as_area_t *area, pf_access_t access);
  161. extern size_t as_get_size(uintptr_t base);
  162. extern int used_space_insert(as_area_t *a, uintptr_t page, count_t count);
  163. extern int used_space_remove(as_area_t *a, uintptr_t page, count_t count);
  164.  
  165.  
  166. /* Interface to be implemented by architectures. */
  167. #ifndef as_constructor_arch
  168. extern int as_constructor_arch(as_t *as, int flags);
  169. #endif /* !def as_constructor_arch */
  170. #ifndef as_destructor_arch
  171. extern int as_destructor_arch(as_t *as);
  172. #endif /* !def as_destructor_arch */
  173. #ifndef as_create_arch
  174. extern int as_create_arch(as_t *as, int flags);
  175. #endif /* !def as_create_arch */
  176. #ifndef as_install_arch
  177. extern void as_install_arch(as_t *as);
  178. #endif /* !def as_install_arch */
  179. #ifndef as_deinstall_arch
  180. extern void as_deinstall_arch(as_t *as);
  181. #endif /* !def as_deinstall_arch */
  182.  
  183. /* Backend declarations and functions. */
  184. extern mem_backend_t anon_backend;
  185. extern mem_backend_t elf_backend;
  186. extern mem_backend_t phys_backend;
  187.  
  188. extern int elf_load(elf_header_t *header, as_t *as);
  189.  
  190. /* Address space area related syscalls. */
  191. extern unative_t sys_as_area_create(uintptr_t address, size_t size, int flags);
  192. extern unative_t sys_as_area_resize(uintptr_t address, size_t size, int flags);
  193. extern unative_t sys_as_area_destroy(uintptr_t address);
  194.  
  195. /* Introspection functions. */
  196. extern void as_print(as_t *as);
  197.  
  198. #endif /* KERNEL */
  199.  
  200. #endif
  201.  
  202. /** @}
  203.  */
  204.