Subversion Repositories HelenOS

Rev

Rev 1780 | Rev 1868 | 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 __AS_H__
  36. #define __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 <typedefs.h>
  51. #include <synch/spinlock.h>
  52. #include <synch/mutex.h>
  53. #include <adt/list.h>
  54. #include <adt/btree.h>
  55. #include <elf.h>
  56.  
  57. /** Defined to be true if user address space and kernel address space shadow each other. */
  58. #define KERNEL_ADDRESS_SPACE_SHADOWED   KERNEL_ADDRESS_SPACE_SHADOWED_ARCH
  59.  
  60. #define KERNEL_ADDRESS_SPACE_START  KERNEL_ADDRESS_SPACE_START_ARCH
  61. #define KERNEL_ADDRESS_SPACE_END    KERNEL_ADDRESS_SPACE_END_ARCH
  62. #define USER_ADDRESS_SPACE_START    USER_ADDRESS_SPACE_START_ARCH
  63. #define USER_ADDRESS_SPACE_END      USER_ADDRESS_SPACE_END_ARCH
  64.  
  65. #define IS_KA(addr) ((addr)>=KERNEL_ADDRESS_SPACE_START && (addr)<=KERNEL_ADDRESS_SPACE_END)
  66.  
  67. #define USTACK_ADDRESS  USTACK_ADDRESS_ARCH
  68.  
  69. #define FLAG_AS_KERNEL      (1 << 0)    /**< Kernel address space. */
  70.  
  71. /** Address space structure.
  72.  *
  73.  * as_t contains the list of as_areas of userspace accessible
  74.  * pages for one or more tasks. Ranges of kernel memory pages are not
  75.  * supposed to figure in the list as they are shared by all tasks and
  76.  * set up during system initialization.
  77.  */
  78. struct as {
  79.     /** Protected by asidlock. */
  80.     link_t inactive_as_with_asid_link;
  81.  
  82.     mutex_t lock;
  83.  
  84.     /** Number of references (i.e tasks that reference this as). */
  85.     count_t refcount;
  86.  
  87.     /** Number of processors on wich is this address space active. */
  88.     count_t cpu_refcount;
  89.  
  90.     /** B+tree of address space areas. */
  91.     btree_t as_area_btree;
  92.  
  93.     /** Page table pointer. Constant on architectures that use global page hash table. */
  94.     pte_t *page_table;
  95.  
  96.     /** Address space identifier. Constant on architectures that do not support ASIDs.*/
  97.     asid_t asid;
  98. };
  99.  
  100. struct as_operations {
  101.     pte_t *(* page_table_create)(int flags);
  102.     void (* page_table_destroy)(pte_t *page_table);
  103.     void (* page_table_lock)(as_t *as, bool lock);
  104.     void (* page_table_unlock)(as_t *as, bool unlock);
  105. };
  106. typedef struct as_operations as_operations_t;
  107.  
  108. /** Address space area attributes. */
  109. #define AS_AREA_ATTR_NONE   0
  110. #define AS_AREA_ATTR_PARTIAL    1   /**< Not fully initialized area. */
  111.  
  112. #define AS_PF_FAULT     0   /**< The page fault was not resolved by as_page_fault(). */
  113. #define AS_PF_OK        1   /**< The page fault was resolved by as_page_fault(). */
  114. #define AS_PF_DEFER     2   /**< The page fault was caused by memcpy_from_uspace()
  115.                          or memcpy_to_uspace(). */
  116.  
  117. /** This structure contains information associated with the shared address space area. */
  118. typedef struct {
  119.     mutex_t lock;       /**< This lock must be acquired only when the as_area lock is held. */
  120.     count_t refcount;   /**< This structure can be deallocated if refcount drops to 0. */
  121.     btree_t pagemap;    /**< B+tree containing complete map of anonymous pages of the shared area. */
  122. } share_info_t;
  123.  
  124. /** Address space area backend structure. */
  125. typedef struct {
  126.     int (* page_fault)(as_area_t *area, uintptr_t addr, pf_access_t access);
  127.     void (* frame_free)(as_area_t *area, uintptr_t page, uintptr_t frame);
  128.     void (* share)(as_area_t *area);
  129. } mem_backend_t;
  130.  
  131. /** Backend data stored in address space area. */
  132. typedef union {
  133.     struct {    /**< elf_backend members */
  134.         elf_header_t *elf;
  135.         elf_segment_header_t *segment;
  136.     };
  137.     struct {    /**< phys_backend members */
  138.         uintptr_t base;
  139.         count_t frames;
  140.     };
  141. } mem_backend_data_t;
  142.  
  143. /** Address space area structure.
  144.  *
  145.  * Each as_area_t structure describes one contiguous area of virtual memory.
  146.  * In the future, it should not be difficult to support shared areas.
  147.  */
  148. struct as_area {
  149.     mutex_t lock;
  150.     as_t *as;       /**< Containing address space. */
  151.     int flags;      /**< Flags related to the memory represented by the address space area. */
  152.     int attributes;     /**< Attributes related to the address space area itself. */
  153.     count_t pages;      /**< Size of this area in multiples of PAGE_SIZE. */
  154.     uintptr_t base;     /**< Base address of this area. */
  155.     btree_t used_space; /**< Map of used space. */
  156.     share_info_t *sh_info;  /**< If the address space area has been shared, this pointer will
  157.                          reference the share info structure. */
  158.     mem_backend_t *backend; /**< Memory backend backing this address space area. */
  159.  
  160.     /** Data to be used by the backend. */
  161.     mem_backend_data_t backend_data;
  162. };
  163.  
  164. extern as_t *AS_KERNEL;
  165. extern as_operations_t *as_operations;
  166.  
  167. extern spinlock_t inactive_as_with_asid_lock;
  168. extern link_t inactive_as_with_asid_head;
  169.  
  170. extern void as_init(void);
  171.  
  172. extern as_t *as_create(int flags);
  173. extern void as_destroy(as_t *as);
  174. extern void as_switch(as_t *old, as_t *new);
  175. extern int as_page_fault(uintptr_t page, pf_access_t access, istate_t *istate);
  176.  
  177. extern as_area_t *as_area_create(as_t *as, int flags, size_t size, uintptr_t base, int attrs,
  178.     mem_backend_t *backend, mem_backend_data_t *backend_data);
  179. extern int as_area_destroy(as_t *as, uintptr_t address);   
  180. extern int as_area_resize(as_t *as, uintptr_t address, size_t size, int flags);
  181. int as_area_share(as_t *src_as, uintptr_t src_base, size_t acc_size,
  182.           as_t *dst_as, uintptr_t dst_base, int dst_flags_mask);
  183.  
  184. extern int as_area_get_flags(as_area_t *area);
  185. extern bool as_area_check_access(as_area_t *area, pf_access_t access);
  186. extern size_t as_get_size(uintptr_t base);
  187. extern int used_space_insert(as_area_t *a, uintptr_t page, count_t count);
  188. extern int used_space_remove(as_area_t *a, uintptr_t page, count_t count);
  189.  
  190. /* Interface to be implemented by architectures. */
  191. #ifndef as_install_arch
  192. extern void as_install_arch(as_t *as);
  193. #endif /* !def as_install_arch */
  194.  
  195. /* Backend declarations. */
  196. extern mem_backend_t anon_backend;
  197. extern mem_backend_t elf_backend;
  198. extern mem_backend_t phys_backend;
  199.  
  200. /* Address space area related syscalls. */
  201. extern unative_t sys_as_area_create(uintptr_t address, size_t size, int flags);
  202. extern unative_t sys_as_area_resize(uintptr_t address, size_t size, int flags);
  203. extern unative_t sys_as_area_destroy(uintptr_t address);
  204.  
  205. #endif /* KERNEL */
  206.  
  207. #endif
  208.  
  209.  /** @}
  210.  */
  211.  
  212.