Add doc comments to alignment functions

master
SamTebbs33 2019-06-27 22:22:17 +01:00
parent d422d5753b
commit 14abf0fda5
1 changed files with 5 additions and 0 deletions

View File

@ -1481,6 +1481,7 @@ test "subArrayPtr" {
}
/// Round an address up to the nearest aligned address
/// The alignment must be greater than 0.
pub fn alignForward(addr: usize, alignment: usize) usize {
return alignBackward(addr + (alignment - 1), alignment);
}
@ -1500,6 +1501,8 @@ test "alignForward" {
testing.expect(alignForward(17, 8) == 24);
}
/// Round an address up to the previous aligned address
/// The alignment must be greater than 0.
pub fn alignBackward(addr: usize, alignment: usize) usize {
// 000010000 // example addr
// 000001111 // subtract 1
@ -1507,6 +1510,8 @@ pub fn alignBackward(addr: usize, alignment: usize) usize {
return addr & ~(alignment - 1);
}
/// Given an address and an alignment, return true if the address is a multiple of the alignment
/// The alignment must be greater than 0.
pub fn isAligned(addr: usize, alignment: usize) bool {
return alignBackward(addr, alignment) == addr;
}