StarPU Handbook
starpufft.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2010,2012,2014,2015,2017,2019 CNRS
4  * Copyright (C) 2009,2011,2014,2019 Université de Bordeaux
5  * Copyright (C) 2012 Inria
6  *
7  * StarPU is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser General Public License as published by
9  * the Free Software Foundation; either version 2.1 of the License, or (at
10  * your option) any later version.
11  *
12  * StarPU is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15  *
16  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
17  */
18 
19 // The documentation for this file is in doc/doxygen/chapters/api/fft_support.doxy
20 
21 #ifndef __STARPU_FFT_H__
22 #define __STARPU_FFT_H__
23 
24 #include <stdio.h>
25 #include <complex.h>
26 #include <starpu.h>
27 #ifdef STARPU_USE_CUDA
28 #include <cufft.h>
29 #define STARPU_CUFFT_REPORT_ERROR(status) STARPUFFT(report_error)(__starpu_func__, __FILE__, __LINE__, status)
30 #endif /* !STARPU_USE_CUDA */
31 
32 #define STARPUFFT_FORWARD -1
33 #define STARPUFFT_INVERSE 1
34 
35 #define __STARPUFFT(name) starpufft_##name
36 #define __STARPUFFTF(name) starpufftf_##name
37 #define __STARPUFFTL(name) starpufftl_##name
38 
39 #define __STARPUFFT_INTERFACE(starpufft,real) \
40 typedef real _Complex starpufft(complex); \
41 \
42 typedef struct starpufft(plan) *starpufft(plan); \
43 \
44 starpufft(plan) starpufft(plan_dft_1d)(int n, int sign, unsigned flags); \
45 starpufft(plan) starpufft(plan_dft_2d)(int n, int m, int sign, unsigned flags); \
46 starpufft(plan) starpufft(plan_dft_3d)(int n, int m, int p, int sign, unsigned flags); \
47 starpufft(plan) starpufft(plan_dft_r2c_1d)(int n, unsigned flags); \
48 starpufft(plan) starpufft(plan_dft_c2r_1d)(int n, unsigned flags); \
49 \
50 void *starpufft(malloc)(size_t n); \
51 void starpufft(free)(void *p); \
52 \
53 int starpufft(execute)(starpufft(plan) p, void *in, void *out); \
54 struct starpu_task *starpufft(start)(starpufft(plan) p, void *in, void *out); \
55 \
56 int starpufft(execute_handle)(starpufft(plan) p, starpu_data_handle_t in, starpu_data_handle_t out); \
57 struct starpu_task *starpufft(start_handle)(starpufft(plan) p, starpu_data_handle_t in, starpu_data_handle_t out); \
58 \
59 void starpufft(cleanup)(starpufft(plan) p); \
60 void starpufft(destroy_plan)(starpufft(plan) p); \
61 \
62 void starpufft(startstats)(void); \
63 void starpufft(stopstats)(void); \
64 void starpufft(showstats)(FILE *out);
65 
66 __STARPUFFT_INTERFACE(__STARPUFFT, double)
67 __STARPUFFT_INTERFACE(__STARPUFFTF, float)
68 __STARPUFFT_INTERFACE(__STARPUFFTL, long double)
69 
70 /* Internal use */
71 extern int starpufft_last_plan_number;
72 
73 #endif // __STARPU_FFT_H__
starpu.h