volk.tmpl.h File Reference

#include <volk/volk_typedefs.h>
#include <volk/volk_config_fixed.h>
#include <volk/volk_common.h>
#include <volk/volk_complex.h>
#include <stdlib.h>
#include <stdbool.h>

Include dependency graph for volk.tmpl.h:

Go to the source code of this file.

Classes
struct	volk_func_desc
Defines
#define	VOLK_OR_PTR(ptr0, ptr1)   (const void *)(((intptr_t)(ptr0)) | ((intptr_t)(ptr1)))
Typedefs
typedef __VOLK_DECL_BEGIN struct volk_func_desc	volk_func_desc_t
Functions
VOLK_API size_t	volk_get_alignment (void)
	Get the machine alignment in bytes.
VOLK_API bool	volk_is_aligned (const void *ptr)
VOLK_API $kern	pname (kern.name) _a
	A function pointer to the fastest aligned implementation.
VOLK_API	void (kern.name) _manual($kern.arglist_full
	Call into a specific implementation given by name.
VOLK_API	volk_func_desc_t (kern.name) _get_func_desc(void)
	Get description paramaters for this kernel.
Variables
VOLK_API $kern pname $kern	name
	A function pointer to the dispatcher implementation.
VOLK_API const char *	impl_name

---

Define Documentation

#define VOLK_OR_PTR	(		ptr0,
			ptr1
	)		(const void *)(((intptr_t)(ptr0)) | ((intptr_t)(ptr1)))

The VOLK_OR_PTR macro is a convenience macro for checking the alignment of a set of pointers. Example usage: volk_is_aligned(VOLK_OR_PTR((VOLK_OR_PTR(p0, p1), p2)))

---

Typedef Documentation

typedef __VOLK_DECL_BEGIN struct volk_func_desc volk_func_desc_t

---

Function Documentation

VOLK_API $kern pname

(

kern.

name

)

A function pointer to the fastest aligned implementation.

A function pointer to the fastest unaligned implementation.

VOLK_API void

(

kern.

name

)

Call into a specific implementation given by name.

Referenced by gr::basic_block::check_topology(), is_complex(), gr::basic_block::message_port_is_hier(), gr::basic_block::message_port_is_hier_in(), and gr::basic_block::message_port_is_hier_out().

VOLK_API volk_func_desc_t

(

kern.

name

)

Get description paramaters for this kernel.

VOLK_API size_t volk_get_alignment

(

void

)

Get the machine alignment in bytes.

VOLK_API bool volk_is_aligned

(

const void *

ptr

)

Is the pointer on a machine alignment boundary?

Note: for performance reasons, this function is not usable until another volk API call is made which will perform certain initialization tasks.

Parameters:

ptr	the pointer to some memory buffer

Returns:

1 for alignment boundary, else 0

---

Variable Documentation

VOLK_API const char* impl_name

VOLK_API $kern pname $kern name

A function pointer to the dispatcher implementation.

Referenced by gr::thread::thread_body_wrapper< F >::thread_body_wrapper().