File: memory.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (234 lines) | stat: -rw-r--r-- 7,050 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

//=============================================================================
//
// Memory utils and algorithms
//
//=============================================================================

#ifndef AGS_SHARED_UTIL_MEMORY_H
#define AGS_SHARED_UTIL_MEMORY_H

//include <string.h>
#include "ags/shared/util/bbop.h"
#include "ags/shared/util/math.h"

namespace AGS3 {

#if defined (AGS_STRICT_ALIGNMENT) || defined (TEST_STRICT_ALIGNMENT)
#define MEMORY_STRICT_ALIGNMENT
#endif

namespace AGS {
namespace Shared {

namespace Memory {
//-------------------------------------------------------------------------
// Converts pointer to 32-bit integer value and vice-versa.
// Only for use in special cases for compatibility with 32-bit plugin API.
// Dangerous on 64-bit systems.
//-------------------------------------------------------------------------
template <typename T>
inline int32_t PtrToInt32(T *ptr) {
	return static_cast<int32_t>(reinterpret_cast<intptr_t>(ptr));
}
template <typename T>
inline T *Int32ToPtr(int32_t value) {
	return reinterpret_cast<T *>(static_cast<intptr_t>(value));
}

//-------------------------------------------------------------------------
// Functions for reading and writing basic types from/to the memory.
// Implement safety workaround for CPUs with alignment restrictions
// (e.g. MIPS).
//-------------------------------------------------------------------------
inline int16_t ReadInt16(const void *ptr) {
	#if defined (MEMORY_STRICT_ALIGNMENT)
	const uint8_t *b = (const uint8_t *)ptr;
	#if defined (BITBYTE_BIG_ENDIAN)
	return (b[0] << 8) | b[1];
	#else
	return (b[1] << 8) | b[0];
	#endif
	#else
	return *(const int16_t *)ptr;
	#endif
}

inline int32_t ReadInt32(const void *ptr) {
	#if defined (MEMORY_STRICT_ALIGNMENT)
	const uint8_t *b = (const uint8_t *)ptr;
	#if defined (BITBYTE_BIG_ENDIAN)
	return (b[0] << 24) | (b[1] << 16) | (b[2] << 8) | b[3];
	#else
	return (b[3] << 24) | (b[2] << 16) | (b[1] << 8) | b[0];
	#endif
	#else
	return *(const int32_t *)ptr;
	#endif
}

inline int64_t ReadInt64(const void *ptr) {
	#if defined (MEMORY_STRICT_ALIGNMENT)
	const uint8_t *b = (const uint8_t *)ptr;
	#if defined (BITBYTE_BIG_ENDIAN)
	return ((uint64_t)b[0] << 56) | ((uint64_t)b[1] << 48) | ((uint64_t)b[2] << 40) | ((uint64_t)b[3] << 32) |
		   (b[4] << 24) | (b[5] << 16) | (b[6] << 8) | b[7];
	#else
	return ((uint64_t)b[7] << 56) | ((uint64_t)b[6] << 48) | ((uint64_t)b[5] << 40) | ((uint64_t)b[4] << 32) |
		   (b[3] << 24) | (b[2] << 16) | (b[1] << 8) | b[0];
	#endif
	#else
	return *(const int64_t *)ptr;
	#endif
}

inline void WriteInt16(void *ptr, int16_t value) {
	#if defined (MEMORY_STRICT_ALIGNMENT)
	uint8_t *b = (uint8_t *)ptr;
	#if defined (BITBYTE_BIG_ENDIAN)
	b[0] = (uint8_t)(value >> 8);
	b[1] = (uint8_t)(value);
	#else
	b[1] = (uint8_t)(value >> 8);
	b[0] = (uint8_t)(value);
	#endif
	#else
	*(int16_t *)ptr = value;
	#endif
}

inline void WriteInt32(void *ptr, int32_t value) {
	#if defined (MEMORY_STRICT_ALIGNMENT)
	uint8_t *b = (uint8_t *)ptr;
	#if defined (BITBYTE_BIG_ENDIAN)
	b[0] = (uint8_t)(value >> 24);
	b[1] = (uint8_t)(value >> 16);
	b[2] = (uint8_t)(value >> 8);
	b[3] = (uint8_t)(value);
	#else
	b[3] = (uint8_t)(value >> 24);
	b[2] = (uint8_t)(value >> 16);
	b[1] = (uint8_t)(value >> 8);
	b[0] = (uint8_t)(value);
	#endif
	#else
	*(int32_t *)ptr = value;
	#endif
}

inline void WriteInt64(void *ptr, int64_t value) {
	#if defined (MEMORY_STRICT_ALIGNMENT)
	uint8_t *b = (uint8_t *)ptr;
	#if defined (BITBYTE_BIG_ENDIAN)
	b[0] = (uint8_t)(value >> 56);
	b[1] = (uint8_t)(value >> 48);
	b[2] = (uint8_t)(value >> 40);
	b[3] = (uint8_t)(value >> 32);
	b[4] = (uint8_t)(value >> 24);
	b[5] = (uint8_t)(value >> 16);
	b[6] = (uint8_t)(value >> 8);
	b[7] = (uint8_t)(value);
	#else
	b[7] = (uint8_t)(value >> 56);
	b[6] = (uint8_t)(value >> 48);
	b[5] = (uint8_t)(value >> 40);
	b[4] = (uint8_t)(value >> 32);
	b[3] = (uint8_t)(value >> 24);
	b[2] = (uint8_t)(value >> 16);
	b[1] = (uint8_t)(value >> 8);
	b[0] = (uint8_t)(value);
	#endif
	#else
	*(int64_t *)ptr = value;
	#endif
}

//-------------------------------------------------------------------------
// Helpers for reading and writing from memory with respect for endianess.
//-------------------------------------------------------------------------
inline int16_t ReadInt16LE(const void *ptr) {
	return BBOp::Int16FromLE(ReadInt16(ptr));
}

inline int32_t ReadInt32LE(const void *ptr) {
	return BBOp::Int32FromLE(ReadInt32(ptr));
}

inline int64_t ReadInt64LE(const void *ptr) {
	return BBOp::Int64FromLE(ReadInt64(ptr));
}

inline void WriteInt16LE(void *ptr, int16_t value) {
	WriteInt16(ptr, BBOp::Int16FromLE(value));
}

inline void WriteInt32LE(void *ptr, int32_t value) {
	WriteInt32(ptr, BBOp::Int32FromLE(value));
}

inline void WriteInt64LE(void *ptr, int64_t value) {
	WriteInt64(ptr, BBOp::Int64FromLE(value));
}

inline int16_t ReadInt16BE(const void *ptr) {
	return BBOp::Int16FromBE(ReadInt16(ptr));
}

inline int32_t ReadInt32BE(const void *ptr) {
	return BBOp::Int32FromBE(ReadInt32(ptr));
}

inline int64_t ReadInt64BE(const void *ptr) {
	return BBOp::Int64FromBE(ReadInt64(ptr));
}

inline void WriteInt16BE(void *ptr, int16_t value) {
	WriteInt16(ptr, BBOp::Int16FromBE(value));
}

inline void WriteInt32BE(void *ptr, int32_t value) {
	WriteInt32(ptr, BBOp::Int32FromBE(value));
}

inline void WriteInt64BE(void *ptr, int64_t value) {
	WriteInt64(ptr, BBOp::Int64FromBE(value));
}

//-------------------------------------------------------------------------
// Memory data manipulation
//-------------------------------------------------------------------------
// Copies block of 2d data from source into destination.
inline void BlockCopy(uint8_t *dst, const size_t dst_pitch, const size_t dst_offset,
                      const uint8_t *src, const size_t src_pitch, const size_t src_offset,
                      const size_t height) {
	for (size_t y = 0; y < height; ++y, src += src_pitch, dst += dst_pitch)
		memcpy(dst + dst_offset, src + src_offset, MIN(dst_pitch - dst_offset, src_pitch - src_offset));
}

} // namespace Memory

} // namespace Shared
} // namespace AGS
} // namespace AGS3

#endif