Vector Optimized Library of Kernels  3.1.2
Architecture-tuned implementations of math kernels
volk.tmpl.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2011-2020 Free Software Foundation, Inc.
4  *
5  * This file is part of VOLK
6  *
7  * SPDX-License-Identifier: LGPL-3.0-or-later
8  */
9 
10 #ifndef INCLUDED_VOLK_RUNTIME
11 #define INCLUDED_VOLK_RUNTIME
12 
13 #include <volk/volk_typedefs.h>
14 #include <volk/volk_config_fixed.h>
15 #include <volk/volk_common.h>
16 #include <volk/volk_complex.h>
17 #include <volk/volk_malloc.h>
18 #include <volk/volk_version.h>
19 
20 #include <stdlib.h>
21 #include <stdbool.h>
22 
24 
25 typedef struct volk_func_desc
26 {
27  const char **impl_names;
28  const int *impl_deps;
29  const bool *impl_alignment;
30  size_t n_impls;
32 
34 VOLK_API void volk_list_machines(void);
35 
37 VOLK_API const char* volk_get_machine(void);
38 
40 VOLK_API size_t volk_get_alignment(void);
41 
48 #define VOLK_OR_PTR(ptr0, ptr1) \
49  (const void *)(((intptr_t)(ptr0)) | ((intptr_t)(ptr1)))
50 
61 VOLK_API bool volk_is_aligned(const void *ptr);
62 
63 // Just drop the deprecated attribute in case we are on Windows. Clang and GCC support `__attribute__`.
64 // We just assume the compiler and the system are tight together as far as Mako templates are concerned.
65 <%
66 deprecated_kernels = ('volk_16i_x5_add_quad_16i_x4', 'volk_16i_branch_4_state_8',
67  'volk_16i_max_star_16i', 'volk_16i_max_star_horizontal_16i',
68  'volk_16i_permute_and_scalar_add', 'volk_16i_x4_quad_max_star_16i',
69  'volk_32fc_s32fc_multiply_32fc', 'volk_32fc_s32fc_x2_rotator_32fc',
70  'volk_32fc_x2_s32fc_multiply_conjugate_add_32fc')
71 from platform import system
72 if system() == 'Windows':
73  deprecated_kernels = ()
74 %>
75 %for kern in kernels:
76 
77 % if kern.name in deprecated_kernels:
79 extern VOLK_API ${kern.pname} ${kern.name} __attribute__((deprecated));
80 
82 extern VOLK_API ${kern.pname} ${kern.name}_a __attribute__((deprecated));
83 
85 extern VOLK_API ${kern.pname} ${kern.name}_u __attribute__((deprecated));
86 
88 extern VOLK_API void ${kern.name}_manual(${kern.arglist_full}, const char* impl_name) __attribute__((deprecated));
89 
91 extern VOLK_API volk_func_desc_t ${kern.name}_get_func_desc(void) __attribute__((deprecated));
92 % else:
94 extern VOLK_API ${kern.pname} ${kern.name};
95 
97 extern VOLK_API ${kern.pname} ${kern.name}_a;
98 
100 extern VOLK_API ${kern.pname} ${kern.name}_u;
101 
103 extern VOLK_API void ${kern.name}_manual(${kern.arglist_full}, const char* impl_name);
104 
106 extern VOLK_API volk_func_desc_t ${kern.name}_get_func_desc(void);
107 % endif
108 
109 %endfor
110 
112 
113 #endif /*INCLUDED_VOLK_RUNTIME*/
VOLK_API const char * volk_get_machine(void)
Returns the name of the machine this instance will use.
Definition: volk.tmpl.c:65
VOLK_API
A function pointer to the fastest aligned implementation.
Definition: volk.tmpl.h:85
VOLK_API void volk_list_machines(void)
Prints a list of machines available.
Definition: volk.tmpl.c:51
size_t n_impls
Definition: volk.tmpl.h:30
#define __VOLK_DECL_BEGIN
Definition: volk_common.h:89
#define __VOLK_DECL_END
Definition: volk_common.h:90
const bool * impl_alignment
Definition: volk.tmpl.h:29
const char ** impl_names
Definition: volk.tmpl.h:27
const int * impl_deps
Definition: volk.tmpl.h:28
__VOLK_DECL_BEGIN struct volk_func_desc volk_func_desc_t
Get description parameters for this kernel.
Definition: volk.tmpl.h:91
VOLK_API size_t volk_get_alignment(void)
Get the machine alignment in bytes.
Definition: volk.tmpl.c:90
VOLK_API bool volk_is_aligned(const void *ptr)
Definition: volk.tmpl.c:96
<%deprecated_kernels=('volk_16i_x5_add_quad_16i_x4', 'volk_16i_branch_4_state_8', 'volk_16i_max_star_16i', 'volk_16i_max_star_horizontal_16i', 'volk_16i_permute_and_scalar_add', 'volk_16i_x4_quad_max_star_16i', 'volk_32fc_s32fc_multiply_32fc', 'volk_32fc_s32fc_x2_rotator_32fc', 'volk_32fc_x2_s32fc_multiply_conjugate_add_32fc') from platform import system if system()== 'Windows':deprecated_kernels=()%> for kern in kernels
Definition: volk.tmpl.h:79
<%this_machine=machine_dict[args[0]]%><%arch_names=this_machine.arch_names%> for arch in this_machine<%this_machine_name="\""+this_machine.name+"\""%> for kern in<%make_impl_name_list="{"+', '.join(['"%s"'%i.name for i in impls])+"}"%><%make_impl_deps_list="{"+', '.join(['| '.join(['(1<< LV_%s)'%d.upper() for d in i.deps]) for i in impls])+"}"%><%make_impl_align_list="{"+', '.join(['true'if i.is_aligned else 'false'for i in impls])+"}"%><%make_impl_fcn_list="{"+', '.join(['%s_%s'%(kern.name, i.name) for i in impls])+"}"%><%len_impls=len(impls)%> endfor
Definition: volk_machine_xxx.tmpl.c:47
Definition: volk.tmpl.h:25