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

Last change on this file since 407 was 407, checked in by alain, 5 years ago

First implementation of fork/exec.

File size: 8.7 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 for an user process.
39 *********************************************************************************************/
40
41typedef enum
42{
43    VSEG_TYPE_CODE   = 0,          /*! executable user code   / private / localized          */
44    VSEG_TYPE_DATA   = 1,          /*! initialized user data  / public  / distributed        */
45    VSEG_TYPE_STACK  = 2,          /*! execution user stack   / private / localized          */
46    VSEG_TYPE_ANON   = 3,          /*! anonymous mmap         / public  / localized          */
47    VSEG_TYPE_FILE   = 4,          /*! file mmap              / public  / localized          */
48    VSEG_TYPE_REMOTE = 5,          /*! remote mmap            / public  / localized          */
49
50    VSEG_TYPE_KDATA  = 10,
51    VSEG_TYPE_KCODE  = 11,
52    VSEG_TYPE_KDEV   = 12,
53}
54vseg_type_t;
55
56
57/**********************************************************************************************
58 * These masks define the vseg generic (hardware independent) flags.
59 *********************************************************************************************/
60
61#define VSEG_USER     0x0001       /*! user accessible                                       */
62#define VSEG_WRITE    0x0002       /*! writeable                                             */
63#define VSEG_EXEC     0x0004       /*! executable                                            */
64#define VSEG_CACHE    0x0008       /*! cachable                                              */
65#define VSEG_PRIVATE  0x0010       /*! should not be accessed from another cluster           */
66#define VSEG_DISTRIB  0x0020       /*! physically distributed on all clusters                */
67
68/**********************************************************************************************
69 * This structure defines a virtual segment descriptor.
70 *********************************************************************************************/
71
72typedef struct vseg_s
73{
74        list_entry_t      list;         /*! all vsegs in same process / same free list if mmap   */
75        struct vmm_s    * vmm;          /*! pointer on associated VM manager                     */
76    uint32_t          type;         /*! vseg type                                            */
77        intptr_t          min;          /*! segment min virtual address                          */
78        intptr_t          max;          /*! segment max virtual address (excluded)               */
79        vpn_t             vpn_base;     /*! first page of vseg                                   */
80        vpn_t             vpn_size;     /*! number of pages occupied                             */
81        uint32_t          flags;        /*! vseg attributes                                      */
82        xptr_t            mapper_xp;    /*! xptr on remote mapper (for types CODE/DATA/FILE)     */
83        intptr_t          file_offset;  /*! vseg offset in file (for types CODE/DATA/FILE        */
84    intptr_t          file_size;    /*! max segment size in mapper (for type CODE/DATA)      */
85    cxy_t             cxy;          /*! physical mapping (for non distributed vseg)          */ 
86}
87vseg_t;
88
89/**********************************************************************************************
90 * This function returns a printable string for the vseg type.
91 **********************************************************************************************
92 * @ vseg_type  : type of vseg
93 * @ return pointer on string
94 *********************************************************************************************/
95char * vseg_type_str( uint32_t vseg_type );
96
97/**********************************************************************************************
98 * This function allocates physical memory for a new vseg descriptor from the local cluster
99 * physical memory allocator.
100 **********************************************************************************************
101 * @ return pointer on allocated vseg descriptor if success / return NULL if failure.
102 *********************************************************************************************/
103vseg_t * vseg_alloc();
104
105/**********************************************************************************************
106 * This function releases physical memory allocated for a vseg descriptor to the local cluster
107 * physical memory allocator.
108 **********************************************************************************************
109 * @ vseg   : local pointer on released vseg descriptor.
110 *********************************************************************************************/
111void vseg_free( vseg_t * vseg );
112
113/**********************************************************************************************
114 * This function initializes a local vseg descriptor, from the arguments values.
115 * It does NOT register the vseg in the local VMM.
116 **********************************************************************************************
117 * @ vseg      : pointer on the vseg descriptor.
118 * @ base      : vseg base address.
119 * @ size      : vseg size (bytes).
120 * @ vpn_base  : first page index.
121 * @ vpn_size  : number of pages.
122 * @ type      : vseg type.
123 * @ cxy       : target cluster for physical mapping.
124 *********************************************************************************************/
125void vseg_init( vseg_t      * vseg,
126                    vseg_type_t   type,
127                intptr_t      base,
128                    uint32_t      size,
129                vpn_t         vpn_base,
130                vpn_t         vpn_size,
131                uint32_t      file_offset,
132                uint32_t      file_size,
133                xptr_t        mapper_xp,
134                cxy_t         cxy );
135
136/**********************************************************************************************
137 * This function initializes a local vseg descriptor from values contained in a reference
138 * remote vseg descriptor. It does NOT register the vseg in the local VMM.
139 **********************************************************************************************
140 * @ vseg      : pointer on the vseg descriptor.
141 * @ ref_xp    : extended pointer on the reference vseg descriptor.
142 *********************************************************************************************/
143void vseg_init_from_ref( vseg_t * vseg,
144                         xptr_t   ref_xp );
145
146/**********************************************************************************************
147 * This function adds a vseg descriptor in the set of vsegs controlled by a given VMM,
148 * and updates the vmm field in the vseg descriptor.
149 * The lock protecting the vsegs list in VMM must be taken by the caller.
150 **********************************************************************************************
151 * @ vmm       : pointer on the VMM
152 * @ vseg      : pointer on the vseg descriptor
153 *********************************************************************************************/
154void vseg_attach( struct vmm_s  * vmm,
155                  vseg_t        * vseg );
156
157/**********************************************************************************************
158 * This function removes a vseg descriptor from the set of vsegs controlled by a given VMM,
159 * and updates the vmm field in the vseg descriptor. No memory is released.
160 * The lock protecting the vsegs list in VMM must be taken by the caller.
161 **********************************************************************************************
162 * @ vmm       : pointer on the VMM
163 * @ vseg      : pointer on the vseg descriptor
164 *********************************************************************************************/
165void vseg_detach( struct vmm_s  * vmm,
166                  vseg_t        * vseg );
167
168
169#endif /* _VSEG_H_ */
Note: See TracBrowser for help on using the repository browser.