Publishing 2019 R1 content
[platform/upstream/dldt.git] / inference-engine / thirdparty / mkl-dnn / src / cpu / jit_avx512_common_conv_kernel.hpp
1 /*******************************************************************************
2 * Copyright 2016-2018 Intel Corporation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *******************************************************************************/
16
17 #ifndef JIT_AVX512_COMMON_CONV_KERNEL_F32_HPP
18 #define JIT_AVX512_COMMON_CONV_KERNEL_F32_HPP
19
20 #include "c_types_map.hpp"
21 #include "memory_tracking.hpp"
22
23 #include "cpu_memory.hpp"
24 #include "jit_generator.hpp"
25 #include "jit_primitive_conf.hpp"
26 #include "jit_uni_eltwise.hpp"
27 #include "jit_uni_depthwise.hpp"
28
29 namespace mkldnn {
30 namespace impl {
31 namespace cpu {
32
33 template<typename Vmm>
34 struct _jit_avx512_common_conv_fwd_kernel : public jit_generator {
35
36     _jit_avx512_common_conv_fwd_kernel(jit_conv_conf_t ajcp,
37             const primitive_attr_t &attr)
38         : jcp(ajcp), attr_(attr)
39     {
40         generate();
41         jit_ker_ = (void (*)(jit_conv_call_s *))getCode();
42     }
43
44     ~_jit_avx512_common_conv_fwd_kernel() {
45         for (auto inj : eltwise_injectors)
46             delete inj;
47         eltwise_injectors.clear();
48
49         for (auto inj : depthwise_injectors)
50             delete inj;
51         depthwise_injectors.clear();
52     }
53
54     DECLARE_CPU_JIT_AUX_FUNCTIONS(_jit_avx512_common_conv_fwd_kernel)
55
56     jit_conv_conf_t jcp;
57     const primitive_attr_t &attr_;
58     void (*jit_ker_)(jit_conv_call_s *);
59
60 private:
61     using reg64_t = const Xbyak::Reg64;
62     enum {
63         typesize = sizeof(float),
64         ker_reg_base_idx = 28,
65     };
66
67     reg64_t param = abi_param1;
68     reg64_t reg_inp = r8;
69     reg64_t reg_ker = r9;
70     reg64_t reg_out = r10;
71
72     reg64_t reg_inp_prf = r11;
73     reg64_t reg_ker_prf = r12;
74     reg64_t reg_out_prf = r13;
75     reg64_t reg_owb = r12;
76
77     reg64_t aux_reg_inp = r14;
78     reg64_t aux_reg_ker = r15;
79
80     reg64_t aux_reg_inp_prf = rsi;
81     reg64_t aux_reg_ker_prf = rdx;
82
83     reg64_t reg_channel = rsi;
84     reg64_t reg_bias = rdx;
85
86     reg64_t aux_reg_ker_d = r9;
87     reg64_t aux_reg_inp_d = rbx;
88     reg64_t aux_reg_inp_d_prf = r13;
89     reg64_t aux_reg_ker_d_prf = abi_not_param1;
90     reg64_t reg_ki = r10;
91
92     reg64_t reg_kj = rax;
93     reg64_t reg_relu_ns = rax;
94     reg64_t reg_oi = rbx;
95     reg64_t reg_kh = abi_not_param1;
96
97     reg64_t reg_tmp = rbp;
98
99     reg64_t reg_ic_loop = rdx;
100     reg64_t reg_inp_loop = rsi;
101
102     reg64_t reg_init_flag = r13;
103     reg64_t reg_bias_ptr = param;
104
105     reg64_t aux_reg_ic = r12;
106     reg64_t reg_binp = rax;
107     reg64_t reg_bout = r11;
108     reg64_t aux1_reg_inp = rbx;
109     reg64_t aux_reg_out = abi_not_param1;
110
111     reg64_t reg_long_offt = r11;
112     reg64_t reg_out_long_offt = r14;
113
114     inline Vmm vmm_ker(int i_ic) {
115         assert(i_ic < 4);
116         return Vmm(ker_reg_base_idx + i_ic);
117     }
118
119     inline Vmm vmm_out(int i_ur, int i_oc) {
120         int idx = i_ur + i_oc * jcp.ur_w;
121         assert(idx < ker_reg_base_idx);
122         return Vmm(idx);
123     }
124
125     inline Vmm vmm_inp(int i_ic, int nb_x_blocking) {
126         int idx = i_ic + nb_x_blocking * jcp.ur_w;
127         assert(idx < 31);
128         return Vmm(idx);
129     }
130
131     Xbyak::Reg64 imm_addr64 = r15;
132     Vmm vmm_wei = Vmm(31);
133
134     reg64_t reg_d_weights = imm_addr64;
135     reg64_t reg_d_bias = reg_kj;
136
137     nstl::vector<jit_uni_eltwise_injector_f32<avx512_common>*> eltwise_injectors;
138     nstl::vector<jit_uni_depthwise_injector_f32<avx512_common>*> depthwise_injectors;
139
140     inline void prepare_output(int ur_w);
141     inline void store_output(int ur_w);
142     inline void compute_loop_fma(int ur_w, int pad_l, int pad_r);
143     inline void compute_loop_fma_core(int ur_w, int pad_l, int pad_r);
144     inline void compute_loop_vnni(int ur_w, int pad_l, int pad_r);
145     inline void compute_loop_4fma(int ur_w, int pad_l, int pad_r);
146     inline void compute_loop_4fma_1st(int ur_w, int pad_l, int pad_r);
147     inline void compute_loop(int ur_w, int pad_l, int pad_r);
148
149     void generate();
150
151     inline void vadd(Vmm vmm, const Xbyak::Operand& op) {
152         if (jcp.ver == ver_4vnni || jcp.ver == ver_vnni)
153             vpaddd(vmm, vmm, op);
154         else
155             vaddps(vmm, vmm, op);
156     }
157
158     inline size_t get_output_offset(int oi, int n_oc_block) {
159         return (size_t)jcp.typesize_out * ((size_t)n_oc_block * jcp.oh
160             * jcp.ow * jcp.od + oi) * jcp.oc_block;
161     }
162
163     inline size_t get_input_offset(int ki, int ic, int oi, int pad_l) {
164         size_t scale = (jcp.ver == ver_4vnni || jcp.ver == ver_vnni) ? 2 : 1;
165         size_t iw_str = !jcp.is_1stconv ? jcp.ic_block : 1;
166         size_t ic_str = !jcp.is_1stconv ? 1 : (size_t)jcp.iw * jcp.ih * jcp.id;
167         return (size_t)jcp.typesize_in
168                 * ((size_t)(ki * (jcp.dilate_w + 1) + oi * jcp.stride_w - pad_l)
169                                   * iw_str
170                           + scale * ic * ic_str);
171     }
172
173     inline int get_kernel_offset(int ki,int ic,int n_oc_block,int ker_number) {
174         int scale = (jcp.ver == ver_4vnni || jcp.ver == ver_vnni) ? 2 : 1;
175         return jcp.typesize_in * jcp.oc_block
176             * (n_oc_block * jcp.nb_ic * jcp.ic_block * jcp.kh * jcp.kw * jcp.kd
177                     + (ic + ker_number) * scale + ki * jcp.ic_block);
178     }
179
180     inline int get_ow_start(int ki, int pad_l) {
181         return nstl::max(0,
182                 utils::div_up(pad_l - ki * (jcp.dilate_w + 1), jcp.stride_w));
183     }
184
185     inline int get_ow_end(int ur_w, int ki, int pad_r) {
186         return ur_w - nstl::max(0, utils::div_up(pad_r
187                                                    - (jcp.kw - 1 - ki)
188                                                            * (jcp.dilate_w + 1),
189                                            jcp.stride_w));
190     }
191 };
192
193 struct jit_avx512_common_conv_fwd_kernel {
194
195     jit_avx512_common_conv_fwd_kernel(jit_conv_conf_t ajcp,
196         const primitive_attr_t &attr) :
197         jit_ker(nullptr),
198         zmm_kernel_(nullptr),
199         xmm_kernel_(nullptr) {
200         int ch_block = ajcp.is_depthwise ? ajcp.ch_block : ajcp.oc_block;
201         switch (ch_block) {
202         case 16:
203             zmm_kernel_ =
204                 new _jit_avx512_common_conv_fwd_kernel<Xbyak::Zmm>(
205                     ajcp, attr);
206             jit_ker = zmm_kernel_->jit_ker_;
207             return;
208         case 4:
209             xmm_kernel_ =
210                 new _jit_avx512_common_conv_fwd_kernel<Xbyak::Xmm>(
211                     ajcp, attr);
212             jit_ker = xmm_kernel_->jit_ker_;
213             return;
214         default:
215             assert(!"invalid channel blocking");
216         }
217     }
218
219     ~jit_avx512_common_conv_fwd_kernel() {
220         delete xmm_kernel_;
221         delete zmm_kernel_;
222     }
223
224     enum {
225         typesize = sizeof(float)
226     };
227
228     static bool post_ops_ok(jit_conv_conf_t &jcp,
229         const primitive_attr_t &attr);
230     static status_t init_conf(jit_conv_conf_t &jcp,
231         const convolution_desc_t &cd,
232         cpu_memory_t::pd_t &src_pd,
233         cpu_memory_t::pd_t &weights_pd,
234         cpu_memory_t::pd_t &dst_pd,
235         cpu_memory_t::pd_t &bias_pd,
236         const primitive_attr_t &attr,
237         int nthreads);
238     static void init_scratchpad(memory_tracking::registrar_t &scratchpad,
239         const jit_conv_conf_t &jcp);
240
241     void(*jit_ker)(jit_conv_call_s *);
242     _jit_avx512_common_conv_fwd_kernel<Xbyak::Zmm> *zmm_kernel_;
243     _jit_avx512_common_conv_fwd_kernel<Xbyak::Xmm> *xmm_kernel_;
244 };
245
246 struct jit_avx512_common_conv_bwd_data_kernel_f32: public jit_generator {
247
248     jit_avx512_common_conv_bwd_data_kernel_f32(jit_conv_conf_t ajcp): jcp(ajcp)
249     {
250         generate();
251         jit_ker = (void (*)(jit_conv_call_s *))getCode();
252     }
253
254     DECLARE_CPU_JIT_AUX_FUNCTIONS(jit_avx512_common_conv_bwd_data_kernel_f32)
255
256     static status_t init_conf(jit_conv_conf_t &jcp,
257             const convolution_desc_t &cd,
258             const memory_desc_wrapper &diff_src_d,
259             const memory_desc_wrapper &weights_d,
260             const memory_desc_wrapper &diff_dst_d);
261     static void init_scratchpad(memory_tracking::registrar_t &scratchpad,
262             const jit_conv_conf_t &jcp);
263
264     jit_conv_conf_t jcp;
265     void (*jit_ker)(jit_conv_call_s *);
266
267 private:
268     using reg64_t = const Xbyak::Reg64;
269     enum {
270         typesize = sizeof(float),
271         ker_reg_base_idx = 28,
272     };
273
274     reg64_t param = abi_param1;
275     reg64_t reg_dst = r8;
276     reg64_t reg_ker = r9;
277     reg64_t reg_src = r10;
278
279     reg64_t reg_dst_prf = r11;
280     reg64_t reg_ker_prf = r12;
281     reg64_t reg_src_prf = r13;
282
283     reg64_t aux_reg_dst = r14;
284     reg64_t aux_reg_ker = r15;
285
286     reg64_t aux_reg_dst_prf = rsi;
287     reg64_t aux_reg_ker_prf = rdx;
288
289     reg64_t aux_reg_dst_d_prf = r13;
290     reg64_t aux_reg_dst_d = rbx;
291     reg64_t aux_reg_ker_d_prf = abi_not_param1;
292     reg64_t aux_reg_ker_d = r9;
293     reg64_t reg_ki = r10;
294
295     reg64_t reg_kj = rax;
296     reg64_t reg_oi = rbx;
297     reg64_t reg_kh = abi_not_param1;
298
299     reg64_t reg_channel = rsi;
300
301     reg64_t reg_tmp = rbp;
302     reg64_t reg_long_offt = r14;
303
304     inline Xbyak::Zmm zmm_ker(int i_ic) {
305         assert(i_ic < 4);
306         return Xbyak::Zmm(ker_reg_base_idx + i_ic);
307     }
308     inline Xbyak::Zmm zmm_inp(int i_ic, int nb_x_blocking) {
309         int idx = i_ic + nb_x_blocking * jcp.ur_w;
310         assert(idx < 31);
311         return Xbyak::Zmm(idx);
312     }
313     inline Xbyak::Zmm zmm_out(int i_ur, int i_oc) {
314         int idx = i_ur + i_oc * jcp.ur_w;
315         assert(idx < ker_reg_base_idx);
316         return Xbyak::Zmm(idx);
317     }
318     inline void vpXdpwssd(Xbyak::Zmm zmm1, Xbyak::Zmm zmm2, reg64_t reg,
319         int offset) {
320         if (jcp.ver == ver_4vnni)
321             vp4dpwssd(zmm1, zmm2, EVEX_compress_addr(reg, offset, false));
322         else
323             vpdpwssd(zmm1, zmm2, EVEX_compress_addr(reg, offset, true));
324     }
325     inline void vadd(Xbyak::Zmm zmm, const Xbyak::Operand& op) {
326         if (jcp.ver == ver_4vnni || jcp.ver == ver_vnni)
327             vpaddd(zmm, zmm, op);
328         else
329             vaddps(zmm, zmm, op);
330     }
331
332     Xbyak::Zmm zmm_wei = Xbyak::Zmm(31);
333
334     inline void prepare_output(int ur_w);
335     inline void store_output(int ur_w);
336     inline void compute_loop_4fma(int ur_w, int l_overflow, int r_overflow);
337     inline void compute_loop_vnni(int ur_w, int l_overflow, int r_overflow);
338     inline void compute_loop_fma(int ur_w, int l_overflow, int r_overflow);
339     inline void compute_loop_fma_core(int ur_w, int l_overflow, int r_overflow);
340     inline void compute_loop(int ur_w, int l_overflow, int r_overflow);
341     void generate();
342
343     inline int get_iw_start(int ki, int l_overflow)
344     {
345         int res = (jcp.iw - 1 + jcp.r_pad) % jcp.stride_w
346                 + l_overflow * jcp.stride_w
347                 - (jcp.kw - 1 - ki) * (jcp.dilate_w + 1);
348         while (res < 0)
349             res += jcp.stride_w;
350
351         return res;
352     }
353
354     inline int get_iw_end(int ur_w, int ki, int r_overflow)
355     {
356         if (utils::one_of(ur_w, jcp.iw, jcp.ur_w_tail))
357             ur_w += nstl::min(0, jcp.r_pad); // remove negative padding
358         int res = (ur_w - 1 + jcp.l_pad) % jcp.stride_w
359                 + r_overflow * jcp.stride_w - ki * (jcp.dilate_w + 1);
360         while (res < 0)
361             res += jcp.stride_w;
362
363         return ur_w - res;
364     }
365 };
366
367 struct jit_avx512_common_conv_bwd_weights_kernel_f32 : public jit_generator {
368
369     jit_avx512_common_conv_bwd_weights_kernel_f32(jit_conv_conf_t ajcp)
370         : jcp(ajcp)
371     {
372         generate();
373         jit_ker = (void (*)(jit_conv_call_s *))getCode();
374     }
375
376     DECLARE_CPU_JIT_AUX_FUNCTIONS(jit_avx512_common_conv_bwd_weights_kernel_f32)
377
378     static status_t init_conf(jit_conv_conf_t &jcp,
379             const convolution_desc_t &cd, cpu_memory_t::pd_t &src_pd,
380             cpu_memory_t::pd_t &diff_weights_pd,
381             cpu_memory_t::pd_t &diff_bias_pd, cpu_memory_t::pd_t &diff_dst_pd);
382     static void init_scratchpad(memory_tracking::registrar_t &scratchpad,
383             const jit_conv_conf_t &jcp);
384
385     jit_conv_conf_t jcp;
386     void (*jit_ker)(jit_conv_call_s *);
387
388 private:
389     using reg64_t = const Xbyak::Reg64;
390     enum {typesize = sizeof(float)};
391     static const int max_ur_w;
392
393     reg64_t param = abi_param1;
394     reg64_t reg_input = rax;
395     reg64_t reg_kernel = rdx;
396     reg64_t reg_output = rsi;
397     reg64_t b_ic = abi_not_param1;
398     reg64_t kj = r8;
399     reg64_t reg_kh = r9;
400     reg64_t reg_ur_w_trips = r10;
401     reg64_t reg_oj = r15;
402     reg64_t reg_ih_count = rbx;
403     reg64_t reg_tmp = r14;
404     reg64_t reg_long_offt = r14;
405
406     reg64_t ki = r11;
407     reg64_t reg_kd_count = r12;
408     reg64_t reg_oi = r12;
409     reg64_t reg_d_index = r13;
410     reg64_t reg_input_d = r15;
411     reg64_t reg_output_d = rbx;
412     reg64_t aux_reg_input = r12;
413     reg64_t aux_reg_kernel = r13;
414     reg64_t reg_bias = rbx;
415
416     inline void bias_kernel();
417     inline void maybe_zero_kernel();
418     inline void compute_oh_step_unroll_ow_icblock(int ic_block_step,
419             int max_ur_w);
420     inline void od_step_comeback_pointers();
421     inline void oh_step_comeback_pointers();
422     inline void compute_oh_step_unroll_ow(int ic_block_step, int max_ur_w);
423     inline void compute_ic_block_step(int ur_w,
424             int pad_l, int pad_r, int ic_block_step,
425             int input_offset, int kernel_offset, int output_offset,
426             bool input_wraparound = false);
427     inline void compute_ic_block_step_fma(int ur_w,
428             int pad_l, int pad_r, int ic_block_step,
429             int input_offset, int kernel_offset, int output_offset,
430             bool input_wraparound);
431     inline void compute_ic_block_step_4fma(int ur_w,
432             int pad_l, int pad_r, int ic_block_step,
433             int input_offset, int kernel_offset, int output_offset,
434             bool input_wraparound);
435     inline void compute_ic_block_step_vnni(int ur_w,
436             int pad_l, int pad_r, int ic_block_step,
437             int input_offset, int kernel_offset, int output_offset,
438             bool input_wraparound);
439     inline void compute_oh_step_common(int ic_block_step, int max_ur_w);
440     inline void compute_oh_step_disp();
441     inline void compute_oh_loop_common();
442
443     inline bool compute_full_spat_loop();
444     inline bool flat_4ops_compute();
445
446     inline void compute_loop();
447
448     void generate();
449
450     static void balance(const jit_conv_conf_t &j, int &nthr, int &nthr_mb,
451             int &nthr_g, int &nthr_oc_b, int &nthr_ic_b);
452 };
453
454 }
455 }
456 }
457
458 #endif