source: trunk/hal/x86_64/core/hal_types.h @ 371

Last change on this file since 371 was 320, checked in by max@…, 4 years ago

Remove unused.

File size: 7.8 KB
Line 
1/*
2 * hal_types.h - common kernel types for x86_64
3 *
4 * Author  Alain Greiner (2016)
5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MKH.
9 *
10 * ALMOS-MKH is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2.0 of the License.
13 *
14 * ALMOS-MKH is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#ifndef HAL_TYPES_H_
25#define HAL_TYPES_H_
26
27#include <kernel_config.h>
28
29#define HAL_64BIT
30
31#ifndef NULL
32#define NULL (void*)        0
33#endif
34
35#define __packed        __attribute__((__packed__))
36#define __arraycount(a) (sizeof(a) / sizeof(*(a)))
37#define __in_kdata      __attribute__((section(".kdata")))
38
39#define __HAL_x86_64__ 1
40
41/**************************************************************************
42 *                      Exact-width integer types.
43 **************************************************************************/
44
45typedef   signed           char      int8_t;
46typedef unsigned           char     uint8_t;
47
48typedef   signed           short    int16_t;
49typedef unsigned           short   uint16_t;
50
51typedef          int                int32_t;
52typedef unsigned int               uint32_t;
53
54typedef   signed long long int      int64_t;
55typedef unsigned long long int     uint64_t;
56
57typedef uint64_t                     size_t;
58
59typedef uint64_t                    vaddr_t; // XXX
60typedef uint64_t                 pt_entry_t; // XXX
61
62/***************************************************************************
63 * Pthread related types
64 **************************************************************************/
65
66typedef uint32_t      pthread_t;
67typedef uint32_t      pthread_mutexattr_t;
68typedef uint32_t      pthread_barrier_t;
69typedef uint32_t      pthread_barrierattr_t;
70typedef uint32_t      sem_t;
71typedef uint32_t      pthread_cond_t;
72typedef uint32_t      pthread_condattr_t;
73typedef uint32_t      pthread_rwlock_t;
74typedef uint32_t      pthread_rwlockattr_t;
75typedef uint32_t      pthread_key_t;
76
77/***************************************************************************
78 * Boolean type and macros
79 **************************************************************************/
80
81typedef uint32_t      bool_t;
82
83#define false         0
84#define true          1
85
86/***************************************************************************
87 * Kernel error type : signed
88 **************************************************************************/
89
90typedef int32_t       error_t;
91
92/***************************************************************************
93 * Time related type
94 **************************************************************************/
95
96typedef uint64_t      cycle_t;   // for cycle counters
97
98/***************************************************************************
99 * Global Process identifier type / fixed format
100 * 16 MSB = cluster XY identifier
101 * 16 LSB = local process index
102 **************************************************************************/
103
104typedef uint32_t      pid_t;
105
106/***************************************************************************
107 * Local Process index
108 **************************************************************************/
109
110typedef uint16_t      lpid_t;
111
112/***************************************************************************
113 * Thread  identifier type / fixed format
114 * 16 MSB = cluster XY identifier
115 * 16 LSB = local thread index
116 **************************************************************************/
117
118typedef uint32_t      trdid_t;
119
120/***************************************************************************
121 * Local Thread index
122 **************************************************************************/
123
124typedef uint16_t      ltid_t;
125
126/***************************************************************************
127 * User identifier type
128 **************************************************************************/
129
130typedef uint32_t      uid_t;
131
132/***************************************************************************
133 * CPU identifier types
134 **************************************************************************/
135
136typedef uint16_t      lid_t;    // local index in cluster
137typedef uint32_t      gid_t;    // global (hardware) identifier
138
139/***************************************************************************
140 * File Descriptor Index in File Descriptor Array
141 **************************************************************************/
142
143typedef uint32_t      fdid_t;
144
145/***************************************************************************
146 * This structure defines a single 32 bits integer alone in a cache line.
147 **************************************************************************/
148
149typedef struct cache_line_s
150{
151        union
152        {
153                uint32_t values[CONFIG_CACHE_LINE_SIZE>>2];
154                uint32_t value;
155        };
156}
157__attribute__((packed)) cacheline_t;
158
159#define CACHELINE_ALIGNED __attribute__((aligned(CONFIG_CACHE_LINE_SIZE)))
160
161/***************************************************************************
162 *  Address types and macros        !!! hardware dependent !!!
163 ***************************************************************************
164 * An extended pointer is a 64 bits integer, structured in two fields :
165 * - cxy : cluster identifier.
166 * - ptr : pointer in the virtual space of a single cluster.
167 *
168 * In Intel 64 bits, the kernel virtual space has 64 Gbytes per cluster
169 * - the cxy field occupies bits[43:36]
170 * - the ptr field occupies bits[35:0]
171 ***************************************************************************
172 * A physical address is a 64 bits integer, structured in two fields :
173 * - cxy : cluster identifier.
174 * - lpa : local physical address inside cluster.
175 *
176 * In Intel 64 bits, the physical space has 8 Gbytes per cluster.
177 * - the cxy field occupies bits[40:33]
178 * - the lpa field occupies bits[32:0]
179 **************************************************************************/
180
181typedef uint64_t               reg_t;          // core register
182
183typedef uint64_t               xptr_t;         // extended pointer
184
185typedef uint16_t               cxy_t;          // cluster identifier
186
187typedef uint64_t               paddr_t;        // global physical address (64 bits)
188
189typedef uint64_t               lpa_t;          // local physical address
190
191typedef uint64_t               intptr_t;       // local pointer stored as integer
192
193typedef uint64_t               ppn_t;          // Physical Page Number
194
195typedef uint64_t               vpn_t;          // Virtual Page number
196
197#define XPTR_NULL              0
198
199/* virtual */
200#define HAL_VA_BASE            0xffff800000000000ULL
201#define PTR_MASK               0x0000000FFFFFFFFFULL
202#define CXY_MASK               0x00000FF000000000ULL
203#define PTR_SHIFT              36
204#define GET_CXY(xp)            ((cxy_t)(((xp) & CXY_MASK) >> PTR_SHIFT))
205
206#define GET_PTR(xp)            ((void *)((uint64_t)HAL_VA_BASE | \
207                                ((uint64_t)(local_cxy) << PTR_SHIFT) | \
208                                (((uint64_t)(xp)) & PTR_MASK)))
209
210#define XPTR(cxy,ptr)          ((uint64_t)HAL_VA_BASE | \
211                                ((uint64_t)(cxy) << PTR_SHIFT) | \
212                                (((uint64_t)(ptr)) & PTR_MASK))
213
214/* physical */
215#define LPA_MASK               0x00000001FFFFFFFFULL
216#define LPA_SHIFT              33
217#define CXY_FROM_PADDR(paddr)  ((cxy_t)((paddr) >> LPA_SHIFT))
218#define LPA_FROM_PADDR(paddr)  (lpa_t)(paddr & LPA_MASK)
219#define PADDR(cxy,lpa)         (((uint64_t)(cxy) << LPA_SHIFT) | (((uint64_t)(lpa)) & LPA_MASK))
220
221#endif  /* HAL_TYPES_H_ */
Note: See TracBrowser for help on using the repository browser.