rsshogi 1.0.1

Reusable Rust shogi primitives for board state, move generation, legality, and record parsing.
Documentation 
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

#![allow(clippy::missing_const_for_fn)]
#![allow(dead_code)]

#[inline]
#[must_use]
pub fn byte_reverse(p0: u64, p1: u64) -> (u64, u64) {
    (p1.swap_bytes(), p0.swap_bytes())
}

#[inline]
#[must_use]
pub fn and(a: (u64, u64), b: (u64, u64)) -> (u64, u64) {
    #[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
    unsafe {
        // SAFETY: SSE2 が有効なときのみコンパイル・呼び出される。
        and_sse2(a, b)
    }
    #[cfg(not(all(target_arch = "x86_64", target_feature = "sse2")))]
    {
        (a.0 & b.0, a.1 & b.1)
    }
}

#[inline]
#[must_use]
pub fn or(a: (u64, u64), b: (u64, u64)) -> (u64, u64) {
    #[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
    unsafe {
        // SAFETY: SSE2 が有効なときのみコンパイル・呼び出される。
        or_sse2(a, b)
    }
    #[cfg(not(all(target_arch = "x86_64", target_feature = "sse2")))]
    {
        (a.0 | b.0, a.1 | b.1)
    }
}

#[inline]
#[must_use]
pub fn xor(a: (u64, u64), b: (u64, u64)) -> (u64, u64) {
    #[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
    unsafe {
        // SAFETY: SSE2 が有効なときのみコンパイル・呼び出される。
        xor_sse2(a, b)
    }
    #[cfg(not(all(target_arch = "x86_64", target_feature = "sse2")))]
    {
        (a.0 ^ b.0, a.1 ^ b.1)
    }
}

#[inline]
#[must_use]
pub fn and_not(a: (u64, u64), b: (u64, u64)) -> (u64, u64) {
    #[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
    unsafe {
        // SAFETY: SSE2 が有効なときのみコンパイル・呼び出される。
        andnot_sse2(a, b)
    }
    #[cfg(not(all(target_arch = "x86_64", target_feature = "sse2")))]
    {
        (a.0 & !b.0, a.1 & !b.1)
    }
}

#[inline]
#[must_use]
pub fn testz(a: (u64, u64), b: (u64, u64)) -> bool {
    #[cfg(all(target_arch = "x86_64", target_feature = "sse4.1"))]
    unsafe {
        // SAFETY: SSE4.1 が有効なときのみコンパイル・呼び出される。
        testz_sse41(a, b)
    }
    #[cfg(not(all(target_arch = "x86_64", target_feature = "sse4.1")))]
    {
        (a.0 & b.0) == 0 && (a.1 & b.1) == 0
    }
}

#[inline]
#[must_use]
pub fn unpack(hi_in: (u64, u64), lo_in: (u64, u64)) -> ((u64, u64), (u64, u64)) {
    let hi_out = (lo_in.1, hi_in.1);
    let lo_out = (lo_in.0, hi_in.0);
    (hi_out, lo_out)
}

#[inline]
#[must_use]
pub fn decrement_pair(hi_in: (u64, u64), lo_in: (u64, u64)) -> ((u64, u64), (u64, u64)) {
    let hi_out = (
        hi_in.0.wrapping_sub(u64::from(lo_in.0 == 0)),
        hi_in.1.wrapping_sub(u64::from(lo_in.1 == 0)),
    );
    let lo_out = (lo_in.0.wrapping_sub(1), lo_in.1.wrapping_sub(1));
    (hi_out, lo_out)
}

#[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
use std::arch::x86_64::{
    __m128i, _mm_and_si128, _mm_andnot_si128, _mm_or_si128, _mm_set_epi64x, _mm_storeu_si128,
    _mm_xor_si128,
};

#[cfg(all(target_arch = "x86_64", target_feature = "sse4.1"))]
use std::arch::x86_64::_mm_testz_si128;

#[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
#[inline]
#[target_feature(enable = "sse2")]
unsafe fn and_sse2(a: (u64, u64), b: (u64, u64)) -> (u64, u64) {
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    let av = unsafe { to_m128i(a) };
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    let bv = unsafe { to_m128i(b) };
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    unsafe { from_m128i(_mm_and_si128(av, bv)) }
}

#[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
#[inline]
#[target_feature(enable = "sse2")]
unsafe fn or_sse2(a: (u64, u64), b: (u64, u64)) -> (u64, u64) {
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    let av = unsafe { to_m128i(a) };
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    let bv = unsafe { to_m128i(b) };
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    unsafe { from_m128i(_mm_or_si128(av, bv)) }
}

#[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
#[inline]
#[target_feature(enable = "sse2")]
unsafe fn xor_sse2(a: (u64, u64), b: (u64, u64)) -> (u64, u64) {
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    let av = unsafe { to_m128i(a) };
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    let bv = unsafe { to_m128i(b) };
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    unsafe { from_m128i(_mm_xor_si128(av, bv)) }
}

#[cfg(all(target_arch = "x86_64", target_feature = "sse4.1"))]
#[inline]
#[target_feature(enable = "sse4.1")]
unsafe fn testz_sse41(a: (u64, u64), b: (u64, u64)) -> bool {
    // SAFETY: SSE4.1 が有効な場合のみコンパイル・呼び出される。
    let av = unsafe { to_m128i(a) };
    // SAFETY: SSE4.1 が有効な場合のみコンパイル・呼び出される。
    let bv = unsafe { to_m128i(b) };
    _mm_testz_si128(av, bv) != 0
}

#[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
#[inline]
#[target_feature(enable = "sse2")]
unsafe fn andnot_sse2(a: (u64, u64), b: (u64, u64)) -> (u64, u64) {
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    let av = unsafe { to_m128i(a) };
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    let bv = unsafe { to_m128i(b) };
    // SAFETY: SSE2 が有効な場合のみコンパイル・呼び出される。
    unsafe { from_m128i(_mm_andnot_si128(bv, av)) }
}

#[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
#[inline]
#[target_feature(enable = "sse2")]
unsafe fn to_m128i(value: (u64, u64)) -> __m128i {
    let lo = i64::from_ne_bytes(value.0.to_ne_bytes());
    let hi = i64::from_ne_bytes(value.1.to_ne_bytes());
    _mm_set_epi64x(hi, lo)
}

#[cfg(all(target_arch = "x86_64", target_feature = "sse2"))]
#[inline]
#[target_feature(enable = "sse2")]
unsafe fn from_m128i(value: __m128i) -> (u64, u64) {
    #[repr(align(16))]
    struct AlignedU64x2([u64; 2]);

    let mut out = AlignedU64x2([0u64; 2]);
    let ptr = std::ptr::addr_of_mut!(out).cast::<__m128i>();
    // SAFETY: `out` は少なくとも 16 バイトの書き込み領域を持ち、`_mm_storeu_si128`
    // はアライメント要件がない。
    unsafe { _mm_storeu_si128(ptr, value) };
    (out.0[0], out.0[1])
}

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

    #[test]
    fn test_u64x2_ops_helpers() {
        let (p0, p1) = byte_reverse(0x1122_3344_5566_7788, 0x99AA_BBCC_DDEE_FF00);
        assert_eq!(p0, 0x00FF_EEDD_CCBB_AA99);
        assert_eq!(p1, 0x8877_6655_4433_2211);

        let and_out = and((0b1100, 0b1010), (0b1010, 0b1100));
        assert_eq!(and_out, (0b1000, 0b1000));
        let or_out = or((0b1100, 0b1010), (0b1010, 0b1100));
        assert_eq!(or_out, (0b1110, 0b1110));
        let xor_out = xor((0b1100, 0b1010), (0b1010, 0b1100));
        assert_eq!(xor_out, (0b0110, 0b0110));
        let and_not_out = and_not((0b1100, 0b1010), (0b1010, 0b1100));
        assert_eq!(and_not_out, (0b0100, 0b0010));
        assert!(testz((0b1000, 0b0000), (0b0001, 0b0000)));
        assert!(!testz((0b1000, 0b0000), (0b1000, 0b0000)));

        let hi_in = (1u64, 2u64);
        let lo_in = (3u64, 4u64);
        let (hi_out, lo_out) = unpack(hi_in, lo_in);
        assert_eq!(hi_out, (4, 2));
        assert_eq!(lo_out, (3, 1));

        let (dec_hi, dec_lo) = decrement_pair((5, 6), (0, 7));
        assert_eq!(dec_hi, (4, 6));
        assert_eq!(dec_lo, (u64::MAX, 6));
    }
}