Vector Optimized Library of Kernels 2.5.1
Architecture-tuned implementations of math kernels
volk.tmpl.h
Go to the documentation of this file.
1/*
2 * Copyright 2011-2020 Free Software Foundation, Inc.
3 *
4 * This file is part of GNU Radio
5 *
6 * GNU Radio is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3, or (at your option)
9 * any later version.
10 *
11 * GNU Radio is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with GNU Radio; see the file COPYING. If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street,
19 * Boston, MA 02110-1301, USA.
20 */
21
22#ifndef INCLUDED_VOLK_RUNTIME
23#define INCLUDED_VOLK_RUNTIME
24
25#include <volk/volk_typedefs.h>
26#include <volk/volk_config_fixed.h>
27#include <volk/volk_common.h>
28#include <volk/volk_complex.h>
29#include <volk/volk_malloc.h>
30#include <volk/volk_version.h>
31
32#include <stdlib.h>
33#include <stdbool.h>
34
36
37typedef struct volk_func_desc
38{
39 const char **impl_names;
40 const int *impl_deps;
41 const bool *impl_alignment;
42 size_t n_impls;
44
47
49VOLK_API const char* volk_get_machine(void);
50
52VOLK_API size_t volk_get_alignment(void);
53
60#define VOLK_OR_PTR(ptr0, ptr1) \
61 (const void *)(((intptr_t)(ptr0)) | ((intptr_t)(ptr1)))
62
73VOLK_API bool volk_is_aligned(const void *ptr);
74
75// Just drop the deprecated attribute in case we are on Windows. Clang and GCC support `__attribute__`.
76// We just assume the compiler and the system are tight together as far as Mako templates are concerned.
77<%
78deprecated_kernels = ('volk_16i_x5_add_quad_16i_x4', 'volk_16i_branch_4_state_8',
79 'volk_16i_max_star_16i', 'volk_16i_max_star_horizontal_16i',
80 'volk_16i_permute_and_scalar_add', 'volk_16i_x4_quad_max_star_16i')
81from platform import system
82if system() == 'Windows':
83 deprecated_kernels = ()
84%>
85%for kern in kernels:
86
87% if kern.name in deprecated_kernels:
89extern VOLK_API ${kern.pname} ${kern.name} __attribute__((deprecated));
90
92extern VOLK_API ${kern.pname} ${kern.name}_a __attribute__((deprecated));
93
95extern VOLK_API ${kern.pname} ${kern.name}_u __attribute__((deprecated));
96
98extern VOLK_API void ${kern.name}_manual(${kern.arglist_full}, const char* impl_name) __attribute__((deprecated));
99
101extern VOLK_API volk_func_desc_t ${kern.name}_get_func_desc(void) __attribute__((deprecated));
102% else:
104extern VOLK_API ${kern.pname} ${kern.name};
105
107extern VOLK_API ${kern.pname} ${kern.name}_a;
108
110extern VOLK_API ${kern.pname} ${kern.name}_u;
111
113extern VOLK_API void ${kern.name}_manual(${kern.arglist_full}, const char* impl_name);
114
116extern VOLK_API volk_func_desc_t ${kern.name}_get_func_desc(void);
117% endif
118
119%endfor
120
122
123#endif /*INCLUDED_VOLK_RUNTIME*/
Definition: volk.tmpl.h:38
const char ** impl_names
Definition: volk.tmpl.h:39
size_t n_impls
Definition: volk.tmpl.h:42
const bool * impl_alignment
Definition: volk.tmpl.h:41
const int * impl_deps
Definition: volk.tmpl.h:40
<% 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') from platform import system if system()=='Windows':deprecated_kernels=() %> for kern in kernels
Definition: volk.tmpl.h:89
__VOLK_DECL_BEGIN struct volk_func_desc volk_func_desc_t
VOLK_API void volk_list_machines(void)
Prints a list of machines available.
Definition: volk.tmpl.c:63
VOLK_API $
A function pointer to the fastest aligned implementation.
Definition: volk.tmpl.h:95
VOLK_API bool volk_is_aligned(const void *ptr)
Definition: volk.tmpl.c:108
VOLK_API const char * volk_get_machine(void)
Returns the name of the machine this instance will use.
Definition: volk.tmpl.c:77
VOLK_API size_t volk_get_alignment(void)
Get the machine alignment in bytes.
Definition: volk.tmpl.c:102
#define __VOLK_DECL_END
Definition: volk_common.h:85
#define VOLK_API
Definition: volk_common.h:95
#define __VOLK_DECL_BEGIN
Definition: volk_common.h:84
<% 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:61