Subversion Repositories HelenOS

Rev

Rev 3036 | Rev 3624 | 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. /**
  57.  * Defined to be true if user address space and kernel address space shadow each
  58.  * other.
  59.  */
  60. #define KERNEL_ADDRESS_SPACE_SHADOWED   KERNEL_ADDRESS_SPACE_SHADOWED_ARCH
  61.  
  62. #define KERNEL_ADDRESS_SPACE_START  KERNEL_ADDRESS_SPACE_START_ARCH
  63. #define KERNEL_ADDRESS_SPACE_END    KERNEL_ADDRESS_SPACE_END_ARCH
  64. #define USER_ADDRESS_SPACE_START    USER_ADDRESS_SPACE_START_ARCH
  65. #define USER_ADDRESS_SPACE_END      USER_ADDRESS_SPACE_END_ARCH
  66.  
  67. #define USTACK_ADDRESS          USTACK_ADDRESS_ARCH
  68.  
  69. /** Kernel address space. */
  70. #define FLAG_AS_KERNEL          (1 << 0)   
  71.  
  72. /* Address space area attributes. */
  73. #define AS_AREA_ATTR_NONE   0
  74. #define AS_AREA_ATTR_PARTIAL    1   /**< Not fully initialized area. */
  75.  
  76. /** The page fault was not resolved by as_page_fault(). */
  77. #define AS_PF_FAULT     0
  78. /** The page fault was resolved by as_page_fault(). */
  79. #define AS_PF_OK        1
  80. /** The page fault was caused by memcpy_from_uspace() or memcpy_to_uspace(). */
  81. #define AS_PF_DEFER     2
  82.  
  83. /** Address space structure.
  84.  *
  85.  * as_t contains the list of as_areas of userspace accessible
  86.  * pages for one or more tasks. Ranges of kernel memory pages are not
  87.  * supposed to figure in the list as they are shared by all tasks and
  88.  * set up during system initialization.
  89.  */
  90. typedef struct as {
  91.     /** Protected by asidlock. */
  92.     link_t inactive_as_with_asid_link;
  93.     /**
  94.      * Number of processors on wich is this address space active.
  95.      * Protected by asidlock.
  96.      */
  97.     count_t cpu_refcount;
  98.     /**
  99.      * Address space identifier.
  100.      * Constant on architectures that do not support ASIDs.
  101.      * Protected by asidlock.
  102.      */
  103.     asid_t asid;
  104.  
  105.     /** Number of references (i.e tasks that reference this as). */
  106.     atomic_t refcount;
  107.  
  108.     mutex_t lock;
  109.  
  110.     /** B+tree of address space areas. */
  111.     btree_t as_area_btree;
  112.    
  113.     /** Non-generic content. */
  114.     as_genarch_t genarch;
  115.  
  116.     /** Architecture specific content. */
  117.     as_arch_t arch;
  118. } as_t;
  119.  
  120. typedef struct {
  121.     pte_t *(* page_table_create)(int flags);
  122.     void (* page_table_destroy)(pte_t *page_table);
  123.     void (* page_table_lock)(as_t *as, bool lock);
  124.     void (* page_table_unlock)(as_t *as, bool unlock);
  125. } as_operations_t;
  126.  
  127. /**
  128.  * This structure contains information associated with the shared address space
  129.  * area.
  130.  */
  131. typedef struct {
  132.     /** This lock must be acquired only when the as_area lock is held. */
  133.     mutex_t lock;      
  134.     /** This structure can be deallocated if refcount drops to 0. */
  135.     count_t refcount;
  136.     /**
  137.      * B+tree containing complete map of anonymous pages of the shared area.
  138.      */
  139.     btree_t pagemap;
  140. } share_info_t;
  141.  
  142. /** Page fault access type. */
  143. typedef enum {
  144.     PF_ACCESS_READ,
  145.     PF_ACCESS_WRITE,
  146.     PF_ACCESS_EXEC
  147. } pf_access_t;
  148.  
  149. struct mem_backend;
  150.  
  151. /** Backend data stored in address space area. */
  152. typedef union mem_backend_data {
  153.     struct {    /**< elf_backend members */
  154.         elf_header_t *elf;
  155.         elf_segment_header_t *segment;
  156.     };
  157.     struct {    /**< phys_backend members */
  158.         uintptr_t base;
  159.         count_t frames;
  160.     };
  161. } mem_backend_data_t;
  162.  
  163. /** Address space area structure.
  164.  *
  165.  * Each as_area_t structure describes one contiguous area of virtual memory.
  166.  */
  167. typedef struct {
  168.     mutex_t lock;
  169.     /** Containing address space. */
  170.     as_t *as;      
  171.     /**
  172.      * Flags related to the memory represented by the address space area.
  173.      */
  174.     int flags;
  175.     /** Attributes related to the address space area itself. */
  176.     int attributes;
  177.     /** Size of this area in multiples of PAGE_SIZE. */
  178.     count_t pages;
  179.     /** Base address of this area. */
  180.     uintptr_t base;
  181.     /** Map of used space. */
  182.     btree_t used_space;
  183.  
  184.     /**
  185.      * If the address space area has been shared, this pointer will
  186.      * reference the share info structure.
  187.      */
  188.     share_info_t *sh_info;
  189.  
  190.     /** Memory backend backing this address space area. */
  191.     struct mem_backend *backend;
  192.  
  193.     /** Data to be used by the backend. */
  194.     mem_backend_data_t backend_data;
  195. } as_area_t;
  196.  
  197. /** Address space area backend structure. */
  198. typedef struct mem_backend {
  199.     int (* page_fault)(as_area_t *area, uintptr_t addr, pf_access_t access);
  200.     void (* frame_free)(as_area_t *area, uintptr_t page, uintptr_t frame);
  201.     void (* share)(as_area_t *area);
  202. } mem_backend_t;
  203.  
  204. extern as_t *AS_KERNEL;
  205.  
  206. extern as_operations_t *as_operations;
  207. extern link_t inactive_as_with_asid_head;
  208.  
  209. extern void as_init(void);
  210.  
  211. extern as_t *as_create(int flags);
  212. extern void as_destroy(as_t *as);
  213. extern void as_switch(as_t *old_as, as_t *new_as);
  214. extern int as_page_fault(uintptr_t page, pf_access_t access, istate_t *istate);
  215.  
  216. extern as_area_t *as_area_create(as_t *as, int flags, size_t size,
  217.     uintptr_t base, int attrs, mem_backend_t *backend,
  218.     mem_backend_data_t *backend_data);
  219. extern int as_area_destroy(as_t *as, uintptr_t address);   
  220. extern int as_area_resize(as_t *as, uintptr_t address, size_t size, int flags);
  221. int as_area_share(as_t *src_as, uintptr_t src_base, size_t acc_size,
  222.     as_t *dst_as, uintptr_t dst_base, int dst_flags_mask);
  223. extern int as_area_change_flags(as_t *as, int flags, uintptr_t address);
  224.  
  225. extern int as_area_get_flags(as_area_t *area);
  226. extern bool as_area_check_access(as_area_t *area, pf_access_t access);
  227. extern size_t as_area_get_size(uintptr_t base);
  228. extern int as_area_make_writeable(uintptr_t address);
  229. extern int as_debug_write(uintptr_t va, void *data, size_t n);
  230. extern int used_space_insert(as_area_t *a, uintptr_t page, count_t count);
  231. extern int used_space_remove(as_area_t *a, uintptr_t page, count_t count);
  232.  
  233.  
  234. /* Interface to be implemented by architectures. */
  235. #ifndef as_constructor_arch
  236. extern int as_constructor_arch(as_t *as, int flags);
  237. #endif /* !def as_constructor_arch */
  238. #ifndef as_destructor_arch
  239. extern int as_destructor_arch(as_t *as);
  240. #endif /* !def as_destructor_arch */
  241. #ifndef as_create_arch
  242. extern int as_create_arch(as_t *as, int flags);
  243. #endif /* !def as_create_arch */
  244. #ifndef as_install_arch
  245. extern void as_install_arch(as_t *as);
  246. #endif /* !def as_install_arch */
  247. #ifndef as_deinstall_arch
  248. extern void as_deinstall_arch(as_t *as);
  249. #endif /* !def as_deinstall_arch */
  250.  
  251. /* Backend declarations and functions. */
  252. extern mem_backend_t anon_backend;
  253. extern mem_backend_t elf_backend;
  254. extern mem_backend_t phys_backend;
  255.  
  256. /**
  257.  * This flags is passed when running the loader, otherwise elf_load()
  258.  * would return with a EE_LOADER error code.
  259.  */
  260. #define ELD_F_NONE  0
  261. #define ELD_F_LOADER    1
  262.  
  263. extern unsigned int elf_load(elf_header_t *header, as_t *as, int flags);
  264.  
  265. /* Address space area related syscalls. */
  266. extern unative_t sys_as_area_create(uintptr_t address, size_t size, int flags);
  267. extern unative_t sys_as_area_resize(uintptr_t address, size_t size, int flags);
  268. extern unative_t sys_as_area_change_flags(uintptr_t address, int flags);
  269. extern unative_t sys_as_area_destroy(uintptr_t address);
  270.  
  271. /* Introspection functions. */
  272. extern void as_print(as_t *as);
  273.  
  274. #endif /* KERNEL */
  275.  
  276. #endif
  277.  
  278. /** @}
  279.  */
  280.