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
/*
    This file is part of Donet.

    Copyright © 2024 Max Rodriguez

    Donet is free software; you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License,
    as published by the Free Software Foundation, either version 3
    of the License, or (at your option) any later version.

    Donet 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public
    License along with Donet. If not, see <https://www.gnu.org/licenses/>.
*/

//! Utils for swapping little-endian bytes to the compiling
//! processor's native endianness (byte order).

/// Swaps 2 bytes in little endian byte order to big endian.
/// Returns the input if the processor is little endian.
#[cfg(target_endian = "big")]
pub fn swap_le_16(v: u16) -> u16 {
    (v & 0x00ff) << 8 | (v & 0xff00) >> 8
}

/// Swaps 4 bytes in little endian byte order to big endian.
/// Returns the input if the processor is little endian.
#[rustfmt::skip]
#[cfg(target_endian = "big")]
pub fn swap_le_32(v: u32) -> u32 {
    (v & 0x000000ff) << 24
    | (v & 0x0000ff00) << 8
    | (v & 0x00ff0000) >> 8
    | (v & 0xff000000) >> 24
}

/// Swaps 8 bytes in little endian byte order to big endian.
/// Returns the input if the processor is little endian.
#[cfg(target_endian = "big")]
#[rustdoc::doc(hidden)]
pub fn swap_le_64(v: u64) -> u64 {
    (v & 0x00000000000000ff) << 56
        | (v & 0x000000000000ff00) << 40
        | (v & 0x0000000000ff0000) << 24
        | (v & 0x00000000ff000000) << 8
        | (v & 0x000000ff00000000) >> 8
        | (v & 0x0000ff0000000000) >> 24
        | (v & 0x00ff000000000000) >> 40
        | (v & 0xff00000000000000) >> 56
}

/// Swaps 2 bytes in little endian byte order to big endian.
/// Returns the input if the processor is little endian.
#[cfg(target_endian = "little")]
pub fn swap_le_16(v: u16) -> u16 {
    v // no need to swap bytes
}

/// Swaps 4 bytes in little endian byte order to big endian.
/// Returns the input if the processor is little endian.
#[cfg(target_endian = "little")]
pub fn swap_le_32(v: u32) -> u32 {
    v
}

/// Swaps 8 bytes in little endian byte order to big endian.
/// Returns the input if the processor is little endian.
#[cfg(target_endian = "little")]
pub fn swap_le_64(v: u64) -> u64 {
    v
}

/// Swaps 2 bytes in big endian byte order to little endian.
/// Returns the input if the processor is big endian.
#[cfg(target_endian = "little")]
pub fn swap_be_16(v: u16) -> u16 {
    (v & 0x00ff) << 8 | (v & 0xff00) >> 8
}

/// Swaps 4 bytes in big endian byte order to little endian.
/// Returns the input if the processor is big endian.
#[rustfmt::skip]
#[cfg(target_endian = "little")]
pub fn swap_be_32(v: u32) -> u32 {
    (v & 0x000000ff) << 24
    | (v & 0x0000ff00) << 8
    | (v & 0x00ff0000) >> 8
    | (v & 0xff000000) >> 24
}

/// Swaps 8 bytes in big endian byte order to little endian.
/// Returns the input if the processor is big endian.
#[cfg(target_endian = "little")]
pub fn swap_be_64(v: u64) -> u64 {
    (v & 0x00000000000000ff) << 56
        | (v & 0x000000000000ff00) << 40
        | (v & 0x0000000000ff0000) << 24
        | (v & 0x00000000ff000000) << 8
        | (v & 0x000000ff00000000) >> 8
        | (v & 0x0000ff0000000000) >> 24
        | (v & 0x00ff000000000000) >> 40
        | (v & 0xff00000000000000) >> 56
}

/// Swaps 2 bytes in big endian byte order to little endian.
/// Returns the input if the processor is big endian.
#[cfg(target_endian = "big")]
pub fn swap_be_16(v: u16) -> u16 {
    v // no need to swap bytes
}

/// Swaps 4 bytes in big endian byte order to little endian.
/// Returns the input if the processor is big endian.
#[cfg(target_endian = "big")]
pub fn swap_be_32(v: u32) -> u32 {
    v
}

/// Swaps 8 bytes in big endian byte order to little endian.
/// Returns the input if the processor is big endian.
#[cfg(target_endian = "big")]
pub fn swap_be_64(v: u64) -> u64 {
    v
}

#[cfg(test)]
mod unit_testing {
    use super::*;

    // Little-endian swap tests

    #[test]
    #[cfg(target_endian = "big")]
    fn endianness_swap_le_16() -> () {
        let res: u16 = swap_le_16(1000 as u16);
        assert_eq!(res, 59395);
    }

    #[test]
    #[cfg(target_endian = "little")]
    fn endianness_swap_le_16() -> () {
        let res: u16 = swap_le_16(1000 as u16);
        assert_eq!(res, 1000);
    }

    #[test]
    #[cfg(target_endian = "big")]
    fn endianness_swap_le_32() -> () {
        let res: u32 = swap_le_32(100000000 as u32);
        assert_eq!(res, 14808325);
    }

    #[test]
    #[cfg(target_endian = "little")]
    fn endianness_swap_le_32() -> () {
        let res: u32 = swap_le_32(100000000 as u32);
        assert_eq!(res, 100000000);
    }

    #[test]
    #[cfg(target_endian = "big")]
    fn endianness_swap_le_64() -> () {
        let res: u64 = swap_le_64(100000000000000000 as u64);
        assert_eq!(res, 152134054404865);
    }

    #[test]
    #[cfg(target_endian = "little")]
    fn endianness_swap_le_64() -> () {
        let res: u64 = swap_le_64(100000000000000000 as u64);
        assert_eq!(res, 100000000000000000);
    }

    // Big-endian swap tests

    #[test]
    #[cfg(target_endian = "little")]
    fn endianness_swap_be_16() -> () {
        let res: u16 = swap_be_16(1000 as u16);
        assert_eq!(res, 59395);
    }

    #[test]
    #[cfg(target_endian = "big")]
    fn endianness_swap_be_16() -> () {
        let res: u16 = swap_be_16(1000 as u16);
        assert_eq!(res, 1000);
    }

    #[test]
    #[cfg(target_endian = "little")]
    fn endianness_swap_be_32() -> () {
        let res: u32 = swap_be_32(100000000 as u32);
        assert_eq!(res, 14808325);
    }

    #[test]
    #[cfg(target_endian = "big")]
    fn endianness_swap_be_32() -> () {
        let res: u32 = swap_be_32(100000000 as u32);
        assert_eq!(res, 100000000);
    }

    #[test]
    #[cfg(target_endian = "little")]
    fn endianness_swap_be_64() -> () {
        let res: u64 = swap_be_64(100000000000000000 as u64);
        assert_eq!(res, 152134054404865);
    }

    #[test]
    #[cfg(target_endian = "big")]
    fn endianness_swap_be_64() -> () {
        let res: u64 = swap_be_64(100000000000000000 as u64);
        assert_eq!(res, 100000000000000000);
    }
}