source: trunk/kernel/mm/vseg.h @ 67

Last change on this file since 67 was 18, checked in by max@…, 7 years ago

cosmetic, and a few typos
File size: 8.6 KB
Line 
1/*
2 * vseg.h - virtual segment (vseg) related operations
3 *
4 * Authors   Ghassan Almaless (2008,2009,2010,2011, 2012)
5 *           Mohamed Lamine Karaoui (2015)
6 *           Alain Greiner (2016)
7 *
8 * Copyright (c) UPMC Sorbonne Universites
9 *
10 * This file is part of ALMOS-MKH.
11 *
12 * ALMOS-MKH is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; version 2.0 of the License.
15 *
16 * ALMOS-MKH is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 */
25
26#ifndef _VSEG_H_
27#define _VSEG_H_
28
29#include <hal_types.h>
30#include <spinlock.h>
31#include <vfs.h>
32
33/****  Forward declarations  ****/
34
35struct vmm_s;
36
37/**********************************************************************************************
38 * This enum defines the vseg types
39 *********************************************************************************************/
40
41enum
42{
43    VSEG_TYPE_CODE   = 0,          /*! executable code        / private / localized          */
44    VSEG_TYPE_DATA   = 1,          /*! initialized data       / public  / distributed        */
45    VSEG_TYPE_HEAP   = 2,          /*! standard malloc        / public  / distributed        */
46    VSEG_TYPE_STACK  = 3,          /*! execution stack        / private / localized          */
47    VSEG_TYPE_ANON   = 4,          /*! anonymous mmap         / public  / localized          */
48    VSEG_TYPE_FILE   = 5,          /*! file mmap              / public  / localized          */
49    VSEG_TYPE_REMOTE = 6,          /*! remote mmap            / public  / localized          */
50    VSEG_TYPE_KCODE  = 7,          /*! kernel code            / private / localized          */
51    VSEG_TYPE_KDATA  = 8,          /*! kernel data            / private / localized          */
52    VSEG_TYPE_KDEV   = 9,          /*! device segment         / public  / localized          */
53
54    VSEG_TYPES_NR    = 10,
55};
56
57
58/**********************************************************************************************
59 * These masks define the vseg generic (hardware independent) flags.
60 *********************************************************************************************/
61
62#define VSEG_USER     0x0001       /*! user accessible                                       */
63#define VSEG_WRITE    0x0002       /*! writeable                                             */
64#define VSEG_EXEC     0x0004       /*! executable                                            */
65#define VSEG_CACHE    0x0008       /*! cachable                                              */
66#define VSEG_PRIVATE  0x0010       /*! should not be accessed from another cluster           */
67#define VSEG_DISTRIB  0x0020       /*! physically distributed on all clusters                */
68
69/**********************************************************************************************
70 * This structure defines a virtual segment descriptor.
71 *********************************************************************************************/
72
73typedef struct vseg_s
74{
75        list_entry_t      list;         /*! all vsegs in same process / same free list if mmap   */
76        struct vmm_s    * vmm;          /*! pointer on associated VM manager                     */
77    uint32_t          type;         /*! vseg type                                            */
78        intptr_t          min;          /*! segment min virtual address                          */
79        intptr_t          max;          /*! segment max virtual address (excluded)               */
80        vpn_t             vpn_base;     /*! first page of vseg                                   */
81        vpn_t             vpn_size;     /*! number of pages occupied                             */
82        uint32_t          flags;        /*! vseg attributes                                      */
83        xptr_t            mapper;       /*! extended pointer on associated mapper                */
84        fdid_t            fdid;         /*! associated fdid for a VSEG_TYPE_FILE                 */
85        uint32_t          offset;       /*! offset in file for a VSEG_TYPE_FILE                  */
86    cxy_t             cxy;          /*! target cluster for physical mapping                  */
87}
88vseg_t;
89
90/**********************************************************************************************
91 * This function allocates physical memory for a new vseg descriptor from the local cluster
92 * physical memory allocator.
93 **********************************************************************************************
94 * @ return pointer on allocated vseg descriptor if success / return NULL if failure.
95 *********************************************************************************************/
96vseg_t * vseg_alloc();
97
98/**********************************************************************************************
99 * This function releases physical memory allocated for a vseg descriptor to the local cluster
100 * physical memory allocator.
101 **********************************************************************************************
102 * @ vseg   : local pointer on released vseg descriptor.
103 *********************************************************************************************/
104void vseg_free( vseg_t * vseg );
105
106/**********************************************************************************************
107 * This function initializes a local vseg descriptor, from the arguments values.
108 * It does NOT register the vseg in the local VMM.
109 **********************************************************************************************
110 * @ vseg      : pointer on the vseg descriptor.
111 * @ base      : vseg base address.
112 * @ size      : vseg size (bytes).
113 * @ vpn_base  : first page index.
114 * @ vpn_size  : number of pages.
115 * @ type      : vseg type.
116 * @ cxy       : target cluster for physical mapping.
117 * @ fdid      : file descriptor index if VSEG_TYPE_FILE.
118 * @ offset    : offset in file if VSEG_TYPE_FILE.
119 *********************************************************************************************/
120void vseg_init( vseg_t      * vseg,
121                intptr_t      base,
122                    intptr_t      size,
123                vpn_t         vpn_base,
124                vpn_t         vpn_size,
125                    uint32_t      type,
126                cxy_t         cxy,
127                fdid_t        fdid,
128                    uint32_t      offset );
129
130/**********************************************************************************************
131 * This function initializes a local vseg descriptor from values contained in a reference
132 * remote vseg descriptor. It does NOT register the vseg in the local VMM.
133 **********************************************************************************************
134 * @ vseg      : pointer on the vseg descriptor.
135 * @ ref_xp    : extended pointer on the reference vseg descriptor.
136 *********************************************************************************************/
137void vseg_init_from_ref( vseg_t * vseg,
138                         xptr_t   ref_xp );
139
140/**********************************************************************************************
141 * This function adds a vseg descriptor in the set of vsegs controlled by a given VMM,
142 * and updates the vmm field in the vseg descriptor.
143 * The lock protecting the vsegs list in VMM must be taken by the caller.
144 **********************************************************************************************
145 * @ vmm       : pointer on the VMM
146 * @ vseg      : pointer on the vseg descriptor
147 * @ returns 0 if success / returns ENOMEM if failure.
148 *********************************************************************************************/
149error_t vseg_attach( struct vmm_s  * vmm,
150                     vseg_t        * vseg );
151
152/**********************************************************************************************
153 * This function removes a vseg descriptor from the set of vsegs controlled by a given VMM,
154 * and updates the vmm field in the vseg descriptor. No memory is released.
155 * The lock protecting the vsegs list in VMM must be taken by the caller.
156 **********************************************************************************************
157 * @ vmm       : pointer on the VMM
158 * @ vseg      : pointer on the vseg descriptor
159 *********************************************************************************************/
160void vseg_detach( struct vmm_s  * vmm,
161                  vseg_t        * vseg );
162
163
164#endif /* _VSEG_H_ */
Note: See TracBrowser for help on using the repository browser.