File: bli_plugin.h.in

package info (click to toggle)
blis 2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 41,904 kB
  • sloc: ansic: 351,996; fortran: 21,831; cpp: 10,947; sh: 9,392; makefile: 1,921; asm: 1,516; python: 695
file content (146 lines) | stat: -rw-r--r-- 4,663 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*

   BLIS
   An object-based framework for developing high-performance BLAS-like
   libraries.

   Copyright (C) 2023, Southern Methodist University

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions are
   met:
    - Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    - Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    - Neither the name(s) of the copyright holder(s) nor the names of its
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

#include "blis.h"

//
// Parameters passed to the plugin registration and initialization
// functions.
//

#define plugin_@plugin_name@_params \
\
       kerid_t* bszids, /* <----- Example arguments       */ \
       kerid_t* kerids, /* <----- for plugin registration */ \
       kerid_t* prefids /* <----- and initialization.     */

#define plugin_@plugin_name@_params_only \
\
       bszids, /* <----- We also sometimes need   */ \
       kerids, /* <----- the names of the         */ \
       prefids /* <----- arguments without types. */

// ---------------------------------------------------------------------------->
// -- Example blocksize, micro-kernel, and preference enumerations. ----------->
// ---------------------------------------------------------------------------->

enum
{
	MY_BLKSZ_1,
	MY_BLKSZ_2,

	MY_NUM_BLOCK_SIZES
};

enum
{
	MY_KERNEL_1,
	MY_KERNEL_2,

	MY_NUM_KERNELS
};

enum
{
	MY_PREF_1,
	MY_PREF_2,

	MY_NUM_KERNEL_PREFS
};

// <----------------------------------------------------------------------------
// <----------------------------------------------------------------------------
// <----------------------------------------------------------------------------

// ---------------------------------------------------------------------------->
// -- Example prototypes for kernel functions. -------------------------------->
// ---------------------------------------------------------------------------->

// Reference kernels for all data types
#undef GENTPROT
#define GENTPROT( ctype, ch, config_infix ) \
\
void PASTEMAC(ch,my_kernel_1,config_infix,BLIS_REF_SUFFIX) \
     ( \
             int    n, \
       const ctype* a, \
             ctype* x  \
     );

// Reference kernels for only complex data types
#undef GENTPROTCO
#define GENTPROTCO( ctype, ctyper, ch, chr, config_infix ) \
\
void PASTEMAC(ch,my_kernel_2,config_infix,BLIS_REF_SUFFIX) \
     ( \
       int    m, \
       int    n, \
       ctype* a  \
     );

// Optimized kernels
void bli_dmy_kernel_1_zen3
     (
             int    n,
       const double* a,
             double* x
     );

// Generate reference kernel prototypes for each configuration AND data type
#undef GENTCONF
#define GENTCONF( CONFIG, config ) \
\
INSERT_GENTPROT_BASIC( PASTECH(_,config) ) \
INSERT_GENTPROTCO_BASIC( PASTECH(_,config) )

INSERT_GENTCONF

// <----------------------------------------------------------------------------
// <----------------------------------------------------------------------------
// <----------------------------------------------------------------------------

//
// Registration and intialization function prototypes.
//

#undef GENTCONF
#define GENTCONF( CONFIG, config ) \
\
void PASTEMAC(plugin_init_@plugin_name@_,config)( plugin_@plugin_name@_params ); \
void PASTEMAC(plugin_init_@plugin_name@_,config,BLIS_REF_SUFFIX)( plugin_@plugin_name@_params );

INSERT_GENTCONF

BLIS_EXPORT_BLIS err_t bli_plugin_register_@plugin_name@( plugin_@plugin_name@_params );