volk.tmpl.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2011-2020 Free Software Foundation, Inc.
 *
 * This file is part of VOLK
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later
 */
 
#ifndef INCLUDED_VOLK_RUNTIME
#define INCLUDED_VOLK_RUNTIME
 
#include <volk/volk_typedefs.h>
#include <volk/volk_config_fixed.h>
#include <volk/volk_common.h>
#include <volk/volk_complex.h>
#include <volk/volk_malloc.h>
#include <volk/volk_version.h>
 
#include <stdlib.h>
#include <stdbool.h>
 
__VOLK_DECL_BEGIN
 
typedef struct volk_func_desc
{
    const char **impl_names;
    const int *impl_deps;
    const bool *impl_alignment;
    size_t n_impls;
} volk_func_desc_t;
 
VOLK_API void volk_list_machines(void);
 
VOLK_API const char* volk_get_machine(void);
 
VOLK_API size_t volk_get_alignment(void);
 
#define VOLK_OR_PTR(ptr0, ptr1) \
    (const void *)(((intptr_t)(ptr0)) | ((intptr_t)(ptr1)))
 
VOLK_API bool volk_is_aligned(const void *ptr);
 
// Just drop the deprecated attribute in case we are on Windows. Clang and GCC support `__attribute__`.
// We just assume the compiler and the system are tight together as far as Mako templates are concerned.
<%
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:
 
% if kern.name in deprecated_kernels:
extern VOLK_API ${kern.pname} ${kern.name} __attribute__((deprecated));
 
extern VOLK_API ${kern.pname} ${kern.name}_a __attribute__((deprecated));
 
extern VOLK_API ${kern.pname} ${kern.name}_u __attribute__((deprecated));
 
extern VOLK_API void ${kern.name}_manual(${kern.arglist_full}, const char* impl_name) __attribute__((deprecated));
 
extern VOLK_API volk_func_desc_t ${kern.name}_get_func_desc(void) __attribute__((deprecated));
% else:
extern VOLK_API ${kern.pname} ${kern.name};
 
extern VOLK_API ${kern.pname} ${kern.name}_a;
 
extern VOLK_API ${kern.pname} ${kern.name}_u;
 
extern VOLK_API void ${kern.name}_manual(${kern.arglist_full}, const char* impl_name);
 
extern VOLK_API volk_func_desc_t ${kern.name}_get_func_desc(void);
% endif
 
%endfor
 
__VOLK_DECL_END
 
#endif /*INCLUDED_VOLK_RUNTIME*/