aboutsummaryrefslogtreecommitdiff
path: root/src/cpu/kernels/softmax/generic/neon/impl.h
blob: 60380cd2339f4fe9dfb0381ab32e069e3b97e508 (plain)
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
/*
 * Copyright (c) 2021-2023 Arm Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef ACL_SRC_CPU_KERNELS_SOFTMAX_GENERIC_NEON_IMPL_H
#define ACL_SRC_CPU_KERNELS_SOFTMAX_GENERIC_NEON_IMPL_H

#include "arm_compute/core/Helpers.h"

#include "src/core/NEON/NEMath.h"
#include "src/core/NEON/wrapper/wrapper.h"

namespace arm_compute
{
namespace cpu
{

#ifdef __aarch64__
namespace
{
// These helper functions are added because vaddv does not exist for fp16,
// and, therefore, is not part of the wrapper::vaddv interface.
#ifdef __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
inline float16_t wrapper_vaddv(const float16x8_t &a, int sum_stages)
{
    auto sum_res = wrapper::vpadd(wrapper::vgethigh(a), wrapper::vgetlow(a));
    for (int i = 0; i < sum_stages; ++i)
    {
        sum_res = wrapper::vpadd(sum_res, sum_res);
    }
    return wrapper::vgetlane(sum_res, 0);
}
#endif // __ARM_FEATURE_FP16_VECTOR_ARITHMETIC

inline float wrapper_vaddv(const float32x4_t &a, int sum_stages)
{
    ARM_COMPUTE_UNUSED(sum_stages);
    return wrapper::vaddv(a);
}
} // namespace
#endif // __aarch64__

// The template implementation for float data types is stored in the header file because
// we need all fp16 instantiated code to live in fp16.cpp files.
template <typename T, bool IS_LOG>
void neon_softmax_float(const ITensor *in, void *const tmp, ITensor *out, float beta, const Window &window)
{
    ARM_COMPUTE_UNUSED(tmp);

    const int input_width = in->info()->valid_region().shape.x();

    Iterator in_it(in, window);
    Iterator out_it(out, window);

    /** SIMD vector tag type. */
    using ExactTagType = typename wrapper::traits::neon_bitvector_tag_t<T, wrapper::traits::BitWidth::W128>;

    constexpr int vec_size = 16 / sizeof(T);

    const int sum_stages = log2(vec_size >> 1);

    const auto beta_vec = wrapper::vdup_n(static_cast<T>(beta), ExactTagType{});

    execute_window_loop(
        window,
        [&](const Coordinates &)
        {
            /* Get pointers */
            const T *in_ptr  = reinterpret_cast<const T *>(in_it.ptr());
            T       *out_ptr = reinterpret_cast<T *>(out_it.ptr());

            T max_val;

            /* Compute Max */
            {
                // Init max value
                auto vec_max = wrapper::vdup_n(support::cpp11::lowest<T>(), ExactTagType{});
                int  x       = 0;

                for (; x <= (input_width - vec_size); x += vec_size)
                {
                    const auto current_value = wrapper::vloadq(in_ptr + x);
                    vec_max                  = wrapper::vmax(vec_max, current_value);
                }

#ifdef __aarch64__
                max_val = wrapper::vmaxv(vec_max);
#else  // __aarch64__
                auto carry_max = wrapper::vpmax(wrapper::vgethigh(vec_max), wrapper::vgetlow(vec_max));

                for (int i = 0; i < sum_stages; ++i)
                {
                    carry_max = wrapper::vpmax(carry_max, carry_max);
                }

                max_val      = wrapper::vgetlane(carry_max, 0);
#endif // __aarch64__

                // Compute left-over elements
                for (; x < input_width; ++x)
                {
                    max_val = std::max(*(in_ptr + x), max_val);
                }
            } // compute max

            T sum_transformed{};

            /* Compute exponentials and sum */
            {
                /* Get max value */
                const auto vec_max = wrapper::vdup_n(max_val, ExactTagType{});

                /* Init sum to zero */
                auto vec_sum = wrapper::vdup_n(static_cast<T>(0), ExactTagType{});

                /* Loop over row and compute exponentials and sum */
                int x = 0;
                for (; x <= (input_width - vec_size); x += vec_size)
                {
                    auto vec_elements = wrapper::vloadq(in_ptr + x);
                    vec_elements      = wrapper::vsub(vec_elements, vec_max);
                    if (IS_LOG)
                    {
                        vec_elements = wrapper::vmul(vec_elements, beta_vec);
                        vec_sum      = wrapper::vadd(vec_sum, wrapper::vexpq(vec_elements));
                    }
                    else
                    {
                        vec_elements = wrapper::vexpq(wrapper::vmul(vec_elements, beta_vec));
                        vec_sum      = wrapper::vadd(vec_sum, vec_elements);
                    }
                    wrapper::vstore(out_ptr + x, vec_elements);
                }

                /* Reduce sum */
                T sum{};
#ifdef __aarch64__
                sum = wrapper_vaddv(vec_sum, sum_stages);
#else  // __aarch64__
                auto sum_res = wrapper::vpadd(wrapper::vgethigh(vec_sum), wrapper::vgetlow(vec_sum));
                for (int i = 0; i < sum_stages; ++i)
                {
                    sum_res = wrapper::vpadd(sum_res, sum_res);
                }
                sum = wrapper::vgetlane(sum_res, 0);
#endif // __aarch64__

                /* Run remaining elements */
                for (; x < input_width; ++x)
                {
                    T element{};

                    if (IS_LOG)
                    {
                        element = (in_ptr[x] - max_val) * beta;
                        sum += std::exp(element);
                    }
                    else
                    {
                        element = std::exp((in_ptr[x] - max_val) * beta);
                        sum += element;
                    }

                    out_ptr[x] = element;
                }

                if (!IS_LOG)
                {
                    sum_transformed = T(1) / sum;
                }
                else
                {
                    sum_transformed = static_cast<T>(std::log(sum));
                }
            } // Compute exponentials and sum

            /* Normalize exponentials */
            {
                const auto sum_vec = wrapper::vdup_n(static_cast<T>(sum_transformed), ExactTagType{});

                /* Loop over row and compute softmax */
                int x = 0;
                for (; x <= (input_width - vec_size); x += vec_size)
                {
                    const auto vec_in = wrapper::vloadq(out_ptr + x);
                    if (IS_LOG)
                    {
                        wrapper::vstore(out_ptr + x, wrapper::vsub(vec_in, sum_vec));
                    }
                    else
                    {
                        wrapper::vstore(out_ptr + x, wrapper::vmul(vec_in, sum_vec));
                    }
                }

                /* Run remaining elements */
                for (; x < input_width; ++x)
                {
                    if (IS_LOG)
                    {
                        out_ptr[x] = out_ptr[x] - sum_transformed;
                    }
                    else
                    {
                        out_ptr[x] = out_ptr[x] * sum_transformed;
                    }
                }
            } // Normalize exponentials
        },
        in_it, out_it);
}

template <typename T, bool IS_LOG>
void neon_softmax_quantized(const ITensor *in, void *const tmp, ITensor *out, float beta, const Window &window);
} // namespace cpu
} // namespace arm_compute

#endif // ACL_SRC_CPU_KERNELS_SOFTMAX_GENERIC_NEON_IMPL_H