scripts/gcc-plugins/gcc-generate-ipa-pass.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  * Generator for IPA pass related boilerplate code/data
0004  *
0005  * Supports gcc 4.5-6
0006  *
0007  * Usage:
0008  *
0009  * 1. before inclusion define PASS_NAME
0010  * 2. before inclusion define NO_* for unimplemented callbacks
0011  *    NO_GENERATE_SUMMARY
0012  *    NO_READ_SUMMARY
0013  *    NO_WRITE_SUMMARY
0014  *    NO_READ_OPTIMIZATION_SUMMARY
0015  *    NO_WRITE_OPTIMIZATION_SUMMARY
0016  *    NO_STMT_FIXUP
0017  *    NO_FUNCTION_TRANSFORM
0018  *    NO_VARIABLE_TRANSFORM
0019  *    NO_GATE
0020  *    NO_EXECUTE
0021  * 3. before inclusion define PROPERTIES_* and *TODO_FLAGS_* to override
0022  *    the default 0 values
0023  * 4. for convenience, all the above will be undefined after inclusion!
0024  * 5. the only exported name is make_PASS_NAME_pass() to register with gcc
0025  */
0026
0027 #ifndef PASS_NAME
0028 #error at least PASS_NAME must be defined
0029 #else
0030 #define __GCC_PLUGIN_STRINGIFY(n)   #n
0031 #define _GCC_PLUGIN_STRINGIFY(n)    __GCC_PLUGIN_STRINGIFY(n)
0032 #define _GCC_PLUGIN_CONCAT2(x, y)   x ## y
0033 #define _GCC_PLUGIN_CONCAT3(x, y, z)    x ## y ## z
0034
0035 #define __PASS_NAME_PASS_DATA(n)    _GCC_PLUGIN_CONCAT2(n, _pass_data)
0036 #define _PASS_NAME_PASS_DATA        __PASS_NAME_PASS_DATA(PASS_NAME)
0037
0038 #define __PASS_NAME_PASS(n)     _GCC_PLUGIN_CONCAT2(n, _pass)
0039 #define _PASS_NAME_PASS         __PASS_NAME_PASS(PASS_NAME)
0040
0041 #define _PASS_NAME_NAME         _GCC_PLUGIN_STRINGIFY(PASS_NAME)
0042
0043 #define __MAKE_PASS_NAME_PASS(n)    _GCC_PLUGIN_CONCAT3(make_, n, _pass)
0044 #define _MAKE_PASS_NAME_PASS        __MAKE_PASS_NAME_PASS(PASS_NAME)
0045
0046 #ifdef NO_GENERATE_SUMMARY
0047 #define _GENERATE_SUMMARY NULL
0048 #else
0049 #define __GENERATE_SUMMARY(n)       _GCC_PLUGIN_CONCAT2(n, _generate_summary)
0050 #define _GENERATE_SUMMARY       __GENERATE_SUMMARY(PASS_NAME)
0051 #endif
0052
0053 #ifdef NO_READ_SUMMARY
0054 #define _READ_SUMMARY NULL
0055 #else
0056 #define __READ_SUMMARY(n)       _GCC_PLUGIN_CONCAT2(n, _read_summary)
0057 #define _READ_SUMMARY           __READ_SUMMARY(PASS_NAME)
0058 #endif
0059
0060 #ifdef NO_WRITE_SUMMARY
0061 #define _WRITE_SUMMARY NULL
0062 #else
0063 #define __WRITE_SUMMARY(n)      _GCC_PLUGIN_CONCAT2(n, _write_summary)
0064 #define _WRITE_SUMMARY          __WRITE_SUMMARY(PASS_NAME)
0065 #endif
0066
0067 #ifdef NO_READ_OPTIMIZATION_SUMMARY
0068 #define _READ_OPTIMIZATION_SUMMARY NULL
0069 #else
0070 #define __READ_OPTIMIZATION_SUMMARY(n)  _GCC_PLUGIN_CONCAT2(n, _read_optimization_summary)
0071 #define _READ_OPTIMIZATION_SUMMARY  __READ_OPTIMIZATION_SUMMARY(PASS_NAME)
0072 #endif
0073
0074 #ifdef NO_WRITE_OPTIMIZATION_SUMMARY
0075 #define _WRITE_OPTIMIZATION_SUMMARY NULL
0076 #else
0077 #define __WRITE_OPTIMIZATION_SUMMARY(n) _GCC_PLUGIN_CONCAT2(n, _write_optimization_summary)
0078 #define _WRITE_OPTIMIZATION_SUMMARY __WRITE_OPTIMIZATION_SUMMARY(PASS_NAME)
0079 #endif
0080
0081 #ifdef NO_STMT_FIXUP
0082 #define _STMT_FIXUP NULL
0083 #else
0084 #define __STMT_FIXUP(n)         _GCC_PLUGIN_CONCAT2(n, _stmt_fixup)
0085 #define _STMT_FIXUP         __STMT_FIXUP(PASS_NAME)
0086 #endif
0087
0088 #ifdef NO_FUNCTION_TRANSFORM
0089 #define _FUNCTION_TRANSFORM NULL
0090 #else
0091 #define __FUNCTION_TRANSFORM(n)     _GCC_PLUGIN_CONCAT2(n, _function_transform)
0092 #define _FUNCTION_TRANSFORM     __FUNCTION_TRANSFORM(PASS_NAME)
0093 #endif
0094
0095 #ifdef NO_VARIABLE_TRANSFORM
0096 #define _VARIABLE_TRANSFORM NULL
0097 #else
0098 #define __VARIABLE_TRANSFORM(n)     _GCC_PLUGIN_CONCAT2(n, _variable_transform)
0099 #define _VARIABLE_TRANSFORM     __VARIABLE_TRANSFORM(PASS_NAME)
0100 #endif
0101
0102 #ifdef NO_GATE
0103 #define _GATE NULL
0104 #define _HAS_GATE false
0105 #else
0106 #define __GATE(n)           _GCC_PLUGIN_CONCAT2(n, _gate)
0107 #define _GATE               __GATE(PASS_NAME)
0108 #define _HAS_GATE true
0109 #endif
0110
0111 #ifdef NO_EXECUTE
0112 #define _EXECUTE NULL
0113 #define _HAS_EXECUTE false
0114 #else
0115 #define __EXECUTE(n)            _GCC_PLUGIN_CONCAT2(n, _execute)
0116 #define _EXECUTE            __EXECUTE(PASS_NAME)
0117 #define _HAS_EXECUTE true
0118 #endif
0119
0120 #ifndef PROPERTIES_REQUIRED
0121 #define PROPERTIES_REQUIRED 0
0122 #endif
0123
0124 #ifndef PROPERTIES_PROVIDED
0125 #define PROPERTIES_PROVIDED 0
0126 #endif
0127
0128 #ifndef PROPERTIES_DESTROYED
0129 #define PROPERTIES_DESTROYED 0
0130 #endif
0131
0132 #ifndef TODO_FLAGS_START
0133 #define TODO_FLAGS_START 0
0134 #endif
0135
0136 #ifndef TODO_FLAGS_FINISH
0137 #define TODO_FLAGS_FINISH 0
0138 #endif
0139
0140 #ifndef FUNCTION_TRANSFORM_TODO_FLAGS_START
0141 #define FUNCTION_TRANSFORM_TODO_FLAGS_START 0
0142 #endif
0143
0144 namespace {
0145 static const pass_data _PASS_NAME_PASS_DATA = {
0146         .type           = IPA_PASS,
0147         .name           = _PASS_NAME_NAME,
0148         .optinfo_flags      = OPTGROUP_NONE,
0149         .tv_id          = TV_NONE,
0150         .properties_required    = PROPERTIES_REQUIRED,
0151         .properties_provided    = PROPERTIES_PROVIDED,
0152         .properties_destroyed   = PROPERTIES_DESTROYED,
0153         .todo_flags_start   = TODO_FLAGS_START,
0154         .todo_flags_finish  = TODO_FLAGS_FINISH,
0155 };
0156
0157 class _PASS_NAME_PASS : public ipa_opt_pass_d {
0158 public:
0159     _PASS_NAME_PASS() : ipa_opt_pass_d(_PASS_NAME_PASS_DATA,
0160              g,
0161              _GENERATE_SUMMARY,
0162              _WRITE_SUMMARY,
0163              _READ_SUMMARY,
0164              _WRITE_OPTIMIZATION_SUMMARY,
0165              _READ_OPTIMIZATION_SUMMARY,
0166              _STMT_FIXUP,
0167              FUNCTION_TRANSFORM_TODO_FLAGS_START,
0168              _FUNCTION_TRANSFORM,
0169              _VARIABLE_TRANSFORM) {}
0170
0171 #ifndef NO_GATE
0172     virtual bool gate(function *) { return _GATE(); }
0173
0174     virtual opt_pass *clone() { return new _PASS_NAME_PASS(); }
0175
0176 #ifndef NO_EXECUTE
0177     virtual unsigned int execute(function *) { return _EXECUTE(); }
0178 #endif
0179 };
0180 }
0181
0182 opt_pass *_MAKE_PASS_NAME_PASS(void)
0183 {
0184     return new _PASS_NAME_PASS();
0185 }
0186 #else
0187 struct opt_pass *_MAKE_PASS_NAME_PASS(void)
0188 {
0189     return &_PASS_NAME_PASS.pass;
0190 }
0191 #endif
0192
0193 /* clean up user provided defines */
0194 #undef PASS_NAME
0195 #undef NO_GENERATE_SUMMARY
0196 #undef NO_WRITE_SUMMARY
0197 #undef NO_READ_SUMMARY
0198 #undef NO_WRITE_OPTIMIZATION_SUMMARY
0199 #undef NO_READ_OPTIMIZATION_SUMMARY
0200 #undef NO_STMT_FIXUP
0201 #undef NO_FUNCTION_TRANSFORM
0202 #undef NO_VARIABLE_TRANSFORM
0203 #undef NO_GATE
0204 #undef NO_EXECUTE
0205
0206 #undef FUNCTION_TRANSFORM_TODO_FLAGS_START
0207 #undef PROPERTIES_DESTROYED
0208 #undef PROPERTIES_PROVIDED
0209 #undef PROPERTIES_REQUIRED
0210 #undef TODO_FLAGS_FINISH
0211 #undef TODO_FLAGS_START
0212
0213 /* clean up generated defines */
0214 #undef _EXECUTE
0215 #undef __EXECUTE
0216 #undef _FUNCTION_TRANSFORM
0217 #undef __FUNCTION_TRANSFORM
0218 #undef _GATE
0219 #undef __GATE
0220 #undef _GCC_PLUGIN_CONCAT2
0221 #undef _GCC_PLUGIN_CONCAT3
0222 #undef _GCC_PLUGIN_STRINGIFY
0223 #undef __GCC_PLUGIN_STRINGIFY
0224 #undef _GENERATE_SUMMARY
0225 #undef __GENERATE_SUMMARY
0226 #undef _HAS_EXECUTE
0227 #undef _HAS_GATE
0228 #undef _MAKE_PASS_NAME_PASS
0229 #undef __MAKE_PASS_NAME_PASS
0230 #undef _PASS_NAME_NAME
0231 #undef _PASS_NAME_PASS
0232 #undef __PASS_NAME_PASS
0233 #undef _PASS_NAME_PASS_DATA
0234 #undef __PASS_NAME_PASS_DATA
0235 #undef _READ_OPTIMIZATION_SUMMARY
0236 #undef __READ_OPTIMIZATION_SUMMARY
0237 #undef _READ_SUMMARY
0238 #undef __READ_SUMMARY
0239 #undef _STMT_FIXUP
0240 #undef __STMT_FIXUP
0241 #undef _VARIABLE_TRANSFORM
0242 #undef __VARIABLE_TRANSFORM
0243 #undef _WRITE_OPTIMIZATION_SUMMARY
0244 #undef __WRITE_OPTIMIZATION_SUMMARY
0245 #undef _WRITE_SUMMARY
0246 #undef __WRITE_SUMMARY
0247
0248 #endif /* PASS_NAME */