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
// Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. //! Defines memory-related functions, such as allocate/deallocate/reallocate memory //! regions, cache and allocation alignments. use std::alloc::Layout; use std::mem::align_of; use std::ptr::NonNull; // NOTE: Below code is written for spatial/temporal prefetcher optimizations. Memory allocation // should align well with usage pattern of cache access and block sizes on layers of storage levels from // registers to non-volatile memory. These alignments are all cache aware alignments incorporated // from [cuneiform](https://crates.io/crates/cuneiform) crate. This approach mimicks Intel TBB's // cache_aligned_allocator which exploits cache locality and minimizes prefetch signals // resulting in less round trip time between the layers of storage. // For further info: https://software.intel.com/en-us/node/506094 // 32-bit architecture and things other than netburst microarchitecture are using 64 bytes. /// Cache and allocation multiple alignment size #[cfg(target_arch = "x86")] pub const ALIGNMENT: usize = 1 << 6; // Intel x86_64: // L2D streamer from L1: // Loads data or instructions from memory to the second-level cache. To use the streamer, // organize the data or instructions in blocks of 128 bytes, aligned on 128 bytes. // - https://www.intel.com/content/dam/www/public/us/en/documents/manuals/64-ia-32-architectures-optimization-manual.pdf /// Cache and allocation multiple alignment size #[cfg(target_arch = "x86_64")] pub const ALIGNMENT: usize = 1 << 7; // 24Kc: // Data Line Size // - https://s3-eu-west-1.amazonaws.com/downloads-mips/documents/MD00346-2B-24K-DTS-04.00.pdf // - https://gitlab.e.foundation/e/devices/samsung/n7100/stable_android_kernel_samsung_smdk4412/commit/2dbac10263b2f3c561de68b4c369bc679352ccee /// Cache and allocation multiple alignment size #[cfg(target_arch = "mips")] pub const ALIGNMENT: usize = 1 << 5; /// Cache and allocation multiple alignment size #[cfg(target_arch = "mips64")] pub const ALIGNMENT: usize = 1 << 5; // Defaults for powerpc /// Cache and allocation multiple alignment size #[cfg(target_arch = "powerpc")] pub const ALIGNMENT: usize = 1 << 5; // Defaults for the ppc 64 /// Cache and allocation multiple alignment size #[cfg(target_arch = "powerpc64")] pub const ALIGNMENT: usize = 1 << 6; // e.g.: sifive // - https://github.com/torvalds/linux/blob/master/Documentation/devicetree/bindings/riscv/sifive-l2-cache.txt#L41 // in general all of them are the same. /// Cache and allocation multiple alignment size #[cfg(target_arch = "riscv")] pub const ALIGNMENT: usize = 1 << 6; // This size is same across all hardware for this architecture. // - https://docs.huihoo.com/doxygen/linux/kernel/3.7/arch_2s390_2include_2asm_2cache_8h.html /// Cache and allocation multiple alignment size #[cfg(target_arch = "s390x")] pub const ALIGNMENT: usize = 1 << 8; // This size is same across all hardware for this architecture. // - https://docs.huihoo.com/doxygen/linux/kernel/3.7/arch_2sparc_2include_2asm_2cache_8h.html#a9400cc2ba37e33279bdbc510a6311fb4 /// Cache and allocation multiple alignment size #[cfg(target_arch = "sparc")] pub const ALIGNMENT: usize = 1 << 5; /// Cache and allocation multiple alignment size #[cfg(target_arch = "sparc64")] pub const ALIGNMENT: usize = 1 << 6; // On ARM cache line sizes are fixed. both v6 and v7. // Need to add board specific or platform specific things later. /// Cache and allocation multiple alignment size #[cfg(target_arch = "thumbv6")] pub const ALIGNMENT: usize = 1 << 5; /// Cache and allocation multiple alignment size #[cfg(target_arch = "thumbv7")] pub const ALIGNMENT: usize = 1 << 5; // Operating Systems cache size determines this. // Currently no way to determine this without runtime inference. /// Cache and allocation multiple alignment size #[cfg(target_arch = "wasm32")] pub const ALIGNMENT: usize = FALLBACK_ALIGNMENT; // Same as v6 and v7. // List goes like that: // Cortex A, M, R, ARM v7, v7-M, Krait and NeoverseN uses this size. /// Cache and allocation multiple alignment size #[cfg(target_arch = "arm")] pub const ALIGNMENT: usize = 1 << 5; // Combined from 4 sectors. Volta says 128. // Prevent chunk optimizations better to go to the default size. // If you have smaller data with less padded functionality then use 32 with force option. // - https://devtalk.nvidia.com/default/topic/803600/variable-cache-line-width-/ /// Cache and allocation multiple alignment size #[cfg(target_arch = "nvptx")] pub const ALIGNMENT: usize = 1 << 7; /// Cache and allocation multiple alignment size #[cfg(target_arch = "nvptx64")] pub const ALIGNMENT: usize = 1 << 7; // This size is same across all hardware for this architecture. /// Cache and allocation multiple alignment size #[cfg(target_arch = "aarch64")] pub const ALIGNMENT: usize = 1 << 6; #[doc(hidden)] /// Fallback cache and allocation multiple alignment size const FALLBACK_ALIGNMENT: usize = 1 << 6; /// /// As you can see this is global and lives as long as the program lives. /// Be careful to not write anything to this pointer in any scenario. /// If you use allocation methods shown here you won't have any problems. const BYPASS_PTR: NonNull<u8> = unsafe { NonNull::new_unchecked(ALIGNMENT as *mut u8) }; pub fn allocate_aligned(size: usize) -> *mut u8 { unsafe { if size == 0 { // In a perfect world, there is no need to request zero size allocation. // Currently, passing zero sized layout to alloc is UB. // This will dodge allocator api for any type. BYPASS_PTR.as_ptr() } else { let layout = Layout::from_size_align_unchecked(size, ALIGNMENT); std::alloc::alloc_zeroed(layout) } } } /// # Safety /// /// This function is unsafe because undefined behavior can result if the caller does not ensure all /// of the following: /// /// * ptr must denote a block of memory currently allocated via this allocator, /// /// * size must be the same size that was used to allocate that block of memory, pub unsafe fn free_aligned(ptr: *mut u8, size: usize) { if ptr != BYPASS_PTR.as_ptr() { std::alloc::dealloc(ptr, Layout::from_size_align_unchecked(size, ALIGNMENT)); } } /// # Safety /// /// This function is unsafe because undefined behavior can result if the caller does not ensure all /// of the following: /// /// * ptr must be currently allocated via this allocator, /// /// * new_size must be greater than zero. /// /// * new_size, when rounded up to the nearest multiple of [ALIGNMENT], must not overflow (i.e., /// the rounded value must be less than usize::MAX). pub unsafe fn reallocate(ptr: *mut u8, old_size: usize, new_size: usize) -> *mut u8 { if ptr == BYPASS_PTR.as_ptr() { return allocate_aligned(new_size); } if new_size == 0 { free_aligned(ptr, old_size); return BYPASS_PTR.as_ptr(); } let new_ptr = std::alloc::realloc( ptr, Layout::from_size_align_unchecked(old_size, ALIGNMENT), new_size, ); if !new_ptr.is_null() && new_size > old_size { new_ptr.add(old_size).write_bytes(0, new_size - old_size); } new_ptr } /// # Safety /// /// Behavior is undefined if any of the following conditions are violated: /// /// * `src` must be valid for reads of `len * size_of::<T>()` bytes. /// /// * `dst` must be valid for writes of `len * size_of::<T>()` bytes. /// /// * Both `src` and `dst` must be properly aligned. /// /// `memcpy` creates a bitwise copy of `T`, regardless of whether `T` is [`Copy`]. If `T` is not /// [`Copy`], using both the values in the region beginning at `*src` and the region beginning at /// `*dst` can [violate memory safety][read-ownership]. pub unsafe fn memcpy(dst: *mut u8, src: *const u8, len: usize) { if len != 0x00 && src != BYPASS_PTR.as_ptr() { std::ptr::copy_nonoverlapping(src, dst, len) } } extern "C" { pub fn memcmp(p1: *const u8, p2: *const u8, len: usize) -> i32; } /// Check if the pointer `p` is aligned to offset `a`. pub fn is_aligned<T>(p: *const T, a: usize) -> bool { let a_minus_one = a.wrapping_sub(1); let pmoda = p as usize & a_minus_one; pmoda == 0 } pub fn is_ptr_aligned<T>(p: *const T) -> bool { p.align_offset(align_of::<T>()) == 0 } #[cfg(test)] mod tests { use super::*; #[test] fn test_allocate() { for _ in 0..10 { let p = allocate_aligned(1024); // make sure this is 64-byte aligned assert_eq!(0, (p as usize) % 64); } } #[test] fn test_is_aligned() { // allocate memory aligned to 64-byte let mut ptr = allocate_aligned(10); assert_eq!(true, is_aligned::<u8>(ptr, 1)); assert_eq!(true, is_aligned::<u8>(ptr, 2)); assert_eq!(true, is_aligned::<u8>(ptr, 4)); // now make the memory aligned to 63-byte ptr = unsafe { ptr.offset(1) }; assert_eq!(true, is_aligned::<u8>(ptr, 1)); assert_eq!(false, is_aligned::<u8>(ptr, 2)); assert_eq!(false, is_aligned::<u8>(ptr, 4)); } }