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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
use std::sync::Arc;
use super::allocator::{align_allocation_no_fill, fill_alignment_gap, AllocatorContext};
use super::BumpPointer;
use crate::policy::immix::line::*;
use crate::policy::immix::ImmixSpace;
use crate::policy::space::Space;
use crate::util::alloc::allocator::get_maximum_aligned_size;
use crate::util::alloc::Allocator;
use crate::util::linear_scan::Region;
use crate::util::opaque_pointer::VMThread;
use crate::util::rust_util::unlikely;
use crate::util::Address;
use crate::vm::*;
/// Immix allocator
#[repr(C)]
pub struct ImmixAllocator<VM: VMBinding> {
/// [`VMThread`] associated with this allocator instance
pub tls: VMThread,
/// The fastpath bump pointer.
pub bump_pointer: BumpPointer,
/// [`Space`](src/policy/space/Space) instance associated with this allocator instance.
space: &'static ImmixSpace<VM>,
context: Arc<AllocatorContext<VM>>,
/// *unused*
hot: bool,
/// Is this a copy allocator?
copy: bool,
/// Bump pointer for large objects
pub(in crate::util::alloc) large_bump_pointer: BumpPointer,
/// Is the current request for large or small?
request_for_large: bool,
/// Hole-searching cursor
line: Option<Line>,
}
impl<VM: VMBinding> ImmixAllocator<VM> {
pub(crate) fn reset(&mut self) {
self.bump_pointer.reset(Address::ZERO, Address::ZERO);
self.large_bump_pointer.reset(Address::ZERO, Address::ZERO);
self.request_for_large = false;
self.line = None;
}
}
impl<VM: VMBinding> Allocator<VM> for ImmixAllocator<VM> {
fn get_space(&self) -> &'static dyn Space<VM> {
self.space as _
}
fn get_context(&self) -> &AllocatorContext<VM> {
&self.context
}
fn does_thread_local_allocation(&self) -> bool {
true
}
fn get_thread_local_buffer_granularity(&self) -> usize {
crate::policy::immix::block::Block::BYTES
}
fn alloc(&mut self, size: usize, align: usize, offset: usize) -> Address {
debug_assert!(
size <= crate::policy::immix::MAX_IMMIX_OBJECT_SIZE,
"Trying to allocate a {} bytes object, which is larger than MAX_IMMIX_OBJECT_SIZE {}",
size,
crate::policy::immix::MAX_IMMIX_OBJECT_SIZE
);
let result = align_allocation_no_fill::<VM>(self.bump_pointer.cursor, align, offset);
let new_cursor = result + size;
if new_cursor > self.bump_pointer.limit {
trace!(
"{:?}: Thread local buffer used up, go to alloc slow path",
self.tls
);
if get_maximum_aligned_size::<VM>(size, align) > Line::BYTES {
// Size larger than a line: do large allocation
self.overflow_alloc(size, align, offset)
} else {
// Size smaller than a line: fit into holes
self.alloc_slow_hot(size, align, offset)
}
} else {
// Simple bump allocation.
fill_alignment_gap::<VM>(self.bump_pointer.cursor, result);
self.bump_pointer.cursor = new_cursor;
trace!(
"{:?}: Bump allocation size: {}, result: {}, new_cursor: {}, limit: {}",
self.tls,
size,
result,
self.bump_pointer.cursor,
self.bump_pointer.limit
);
result
}
}
/// Acquire a clean block from ImmixSpace for allocation.
fn alloc_slow_once(&mut self, size: usize, align: usize, offset: usize) -> Address {
trace!("{:?}: alloc_slow_once", self.tls);
self.acquire_clean_block(size, align, offset)
}
/// This is called when precise stress is used. We try use the thread local buffer for
/// the allocation (after restoring the correct limit for thread local buffer). If we cannot
/// allocate from thread local buffer, we will go to the actual slowpath. After allocation,
/// we will set the fake limit so future allocations will fail the slowpath and get here as well.
fn alloc_slow_once_precise_stress(
&mut self,
size: usize,
align: usize,
offset: usize,
need_poll: bool,
) -> Address {
trace!("{:?}: alloc_slow_once_precise_stress", self.tls);
// If we are required to make a poll, we call acquire_clean_block() which will acquire memory
// from the space which includes a GC poll.
if need_poll {
trace!(
"{:?}: alloc_slow_once_precise_stress going to poll",
self.tls
);
let ret = self.acquire_clean_block(size, align, offset);
// Set fake limits so later allocation will fail in the fastpath, and end up going to this
// special slowpath.
self.set_limit_for_stress();
trace!(
"{:?}: alloc_slow_once_precise_stress done - forced stress poll",
self.tls
);
return ret;
}
// We are not yet required to do a stress GC. We will try to allocate from thread local
// buffer if possible. Restore the fake limit to the normal limit so we can do thread
// local allocation normally. Check if we have exhausted our current thread local block,
// and if so, then directly acquire a new one
self.restore_limit_for_stress();
let ret = if self.require_new_block(size, align, offset) {
// We don't have enough space in thread local block to service the allocation request,
// hence allocate a new block
trace!(
"{:?}: alloc_slow_once_precise_stress - acquire new block",
self.tls
);
self.acquire_clean_block(size, align, offset)
} else {
// This `alloc()` call should always succeed given the if-branch checks if we are out
// of thread local block space
trace!("{:?}: alloc_slow_once_precise_stress - alloc()", self.tls,);
self.alloc(size, align, offset)
};
// Set fake limits
self.set_limit_for_stress();
ret
}
fn get_tls(&self) -> VMThread {
self.tls
}
}
impl<VM: VMBinding> ImmixAllocator<VM> {
pub(crate) fn new(
tls: VMThread,
space: Option<&'static dyn Space<VM>>,
context: Arc<AllocatorContext<VM>>,
copy: bool,
) -> Self {
ImmixAllocator {
tls,
space: space.unwrap().downcast_ref::<ImmixSpace<VM>>().unwrap(),
context,
bump_pointer: BumpPointer::default(),
hot: false,
copy,
large_bump_pointer: BumpPointer::default(),
request_for_large: false,
line: None,
}
}
pub(crate) fn immix_space(&self) -> &'static ImmixSpace<VM> {
self.space
}
/// Large-object (larger than a line) bump allocation.
fn overflow_alloc(&mut self, size: usize, align: usize, offset: usize) -> Address {
trace!("{:?}: overflow_alloc", self.tls);
let start = align_allocation_no_fill::<VM>(self.large_bump_pointer.cursor, align, offset);
let end = start + size;
if end > self.large_bump_pointer.limit {
self.request_for_large = true;
let rtn = self.alloc_slow_inline(size, align, offset);
self.request_for_large = false;
rtn
} else {
fill_alignment_gap::<VM>(self.large_bump_pointer.cursor, start);
self.large_bump_pointer.cursor = end;
start
}
}
/// Bump allocate small objects into recyclable lines (i.e. holes).
fn alloc_slow_hot(&mut self, size: usize, align: usize, offset: usize) -> Address {
trace!("{:?}: alloc_slow_hot", self.tls);
if self.acquire_recyclable_lines(size, align, offset) {
// If stress test is active, then we need to go to the slow path instead of directly
// calling `alloc()`. This is because the `acquire_recyclable_lines()` function
// manipulates the cursor and limit if a line can be recycled and if we directly call
// `alloc()` after recyling a line, then we will miss updating the `allocation_bytes`
// as the newly recycled line will service the allocation request. If we set the stress
// factor limit directly in `acquire_recyclable_lines()`, then we risk running into an
// loop of failing the fastpath (i.e. `alloc()`) and then trying to allocate from a
// recyclable line. Hence, we bring the "if we're in stress test" check up a level and
// directly call `alloc_slow_inline()` which will properly account for the allocation
// request as well as allocate from the newly recycled line
let stress_test = self.context.options.is_stress_test_gc_enabled();
let precise_stress = *self.context.options.precise_stress;
if unlikely(stress_test && precise_stress) {
self.alloc_slow_inline(size, align, offset)
} else {
self.alloc(size, align, offset)
}
} else {
self.alloc_slow_inline(size, align, offset)
}
}
/// Search for recyclable lines.
fn acquire_recyclable_lines(&mut self, size: usize, align: usize, offset: usize) -> bool {
while self.line.is_some() || self.acquire_recyclable_block() {
let line = self.line.unwrap();
if let Some((start_line, end_line)) = self.immix_space().get_next_available_lines(line)
{
// Find recyclable lines. Update the bump allocation cursor and limit.
self.bump_pointer.cursor = start_line.start();
self.bump_pointer.limit = end_line.start();
trace!(
"{:?}: acquire_recyclable_lines -> {:?} [{:?}, {:?}) {:?}",
self.tls,
self.line,
start_line,
end_line,
self.tls
);
crate::util::memory::zero(
self.bump_pointer.cursor,
self.bump_pointer.limit - self.bump_pointer.cursor,
);
debug_assert!(
align_allocation_no_fill::<VM>(self.bump_pointer.cursor, align, offset) + size
<= self.bump_pointer.limit
);
let block = line.block();
self.line = if end_line == block.end_line() {
// Hole searching reached the end of a reusable block. Set the hole-searching cursor to None.
None
} else {
// Update the hole-searching cursor to None.
Some(end_line)
};
return true;
} else {
// No more recyclable lines. Set the hole-searching cursor to None.
self.line = None;
}
}
false
}
/// Get a recyclable block from ImmixSpace.
fn acquire_recyclable_block(&mut self) -> bool {
match self.immix_space().get_reusable_block(self.copy) {
Some(block) => {
trace!("{:?}: acquire_recyclable_block -> {:?}", self.tls, block);
// Set the hole-searching cursor to the start of this block.
self.line = Some(block.start_line());
true
}
_ => false,
}
}
// Get a clean block from ImmixSpace.
fn acquire_clean_block(&mut self, size: usize, align: usize, offset: usize) -> Address {
match self.immix_space().get_clean_block(self.tls, self.copy) {
None => Address::ZERO,
Some(block) => {
trace!(
"{:?}: Acquired a new block {:?} -> {:?}",
self.tls,
block.start(),
block.end()
);
if self.request_for_large {
self.large_bump_pointer.cursor = block.start();
self.large_bump_pointer.limit = block.end();
} else {
self.bump_pointer.cursor = block.start();
self.bump_pointer.limit = block.end();
}
self.alloc(size, align, offset)
}
}
}
/// Return whether the TLAB has been exhausted and we need to acquire a new block. Assumes that
/// the buffer limits have been restored using [`ImmixAllocator::restore_limit_for_stress`].
/// Note that this function may implicitly change the limits of the allocator.
fn require_new_block(&mut self, size: usize, align: usize, offset: usize) -> bool {
let result = align_allocation_no_fill::<VM>(self.bump_pointer.cursor, align, offset);
let new_cursor = result + size;
let insufficient_space = new_cursor > self.bump_pointer.limit;
// We want this function to behave as if `alloc()` has been called. Hence, we perform a
// size check and then return the conditions where `alloc_slow_inline()` would be called
// in an `alloc()` call, namely when both `overflow_alloc()` and `alloc_slow_hot()` fail
// to service the allocation request
if insufficient_space && get_maximum_aligned_size::<VM>(size, align) > Line::BYTES {
let start =
align_allocation_no_fill::<VM>(self.large_bump_pointer.cursor, align, offset);
let end = start + size;
end > self.large_bump_pointer.limit
} else {
// We try to acquire recyclable lines here just like `alloc_slow_hot()`
insufficient_space && !self.acquire_recyclable_lines(size, align, offset)
}
}
/// Set fake limits for the bump allocation for stress tests. The fake limit is the remaining
/// thread local buffer size, which should be always smaller than the bump cursor. This method
/// may be reentrant. We need to check before setting the values.
fn set_limit_for_stress(&mut self) {
if self.bump_pointer.cursor < self.bump_pointer.limit {
let old_limit = self.bump_pointer.limit;
let new_limit =
unsafe { Address::from_usize(self.bump_pointer.limit - self.bump_pointer.cursor) };
self.bump_pointer.limit = new_limit;
trace!(
"{:?}: set_limit_for_stress. normal c {} l {} -> {}",
self.tls,
self.bump_pointer.cursor,
old_limit,
new_limit,
);
}
if self.large_bump_pointer.cursor < self.large_bump_pointer.limit {
let old_lg_limit = self.large_bump_pointer.limit;
let new_lg_limit = unsafe {
Address::from_usize(self.large_bump_pointer.limit - self.large_bump_pointer.cursor)
};
self.large_bump_pointer.limit = new_lg_limit;
trace!(
"{:?}: set_limit_for_stress. large c {} l {} -> {}",
self.tls,
self.large_bump_pointer.cursor,
old_lg_limit,
new_lg_limit,
);
}
}
/// Restore the real limits for the bump allocation so we can properly do a thread local
/// allocation. The fake limit is the remaining thread local buffer size, and we restore the
/// actual limit from the size and the cursor. This method may be reentrant. We need to check
/// before setting the values.
fn restore_limit_for_stress(&mut self) {
if self.bump_pointer.limit < self.bump_pointer.cursor {
let old_limit = self.bump_pointer.limit;
let new_limit = self.bump_pointer.cursor + self.bump_pointer.limit.as_usize();
self.bump_pointer.limit = new_limit;
trace!(
"{:?}: restore_limit_for_stress. normal c {} l {} -> {}",
self.tls,
self.bump_pointer.cursor,
old_limit,
new_limit,
);
}
if self.large_bump_pointer.limit < self.large_bump_pointer.cursor {
let old_lg_limit = self.large_bump_pointer.limit;
let new_lg_limit =
self.large_bump_pointer.cursor + self.large_bump_pointer.limit.as_usize();
self.large_bump_pointer.limit = new_lg_limit;
trace!(
"{:?}: restore_limit_for_stress. large c {} l {} -> {}",
self.tls,
self.large_bump_pointer.cursor,
old_lg_limit,
new_lg_limit,
);
}
}
}