Compiler.h Source File (original) (raw)

15#ifndef LLVM_SUPPORT_COMPILER_H

16#define LLVM_SUPPORT_COMPILER_H

18#include "llvm/Config/llvm-config.h"

20#include <stddef.h>

22#if defined(_MSC_VER)

23#include <sal.h>

24#endif

26#ifndef __has_feature

27# define __has_feature(x) 0

28#endif

30#ifndef __has_extension

31# define __has_extension(x) 0

32#endif

34#ifndef __has_attribute

35# define __has_attribute(x) 0

36#endif

38#ifndef __has_builtin

39# define __has_builtin(x) 0

40#endif

42#ifndef __has_warning

43# define __has_warning(x) 0

44#endif

48#ifndef LLVM_HAS_CPP_ATTRIBUTE

49#if defined(__cplusplus) && defined(__has_cpp_attribute)

50# define LLVM_HAS_CPP_ATTRIBUTE(x) __has_cpp_attribute(x)

51#else

52# define LLVM_HAS_CPP_ATTRIBUTE(x) 0

53#endif

54#endif

59#ifndef LLVM_GNUC_PREREQ

60# if defined(__GNUC__) && defined(__GNUC_MINOR__) && defined(__GNUC_PATCHLEVEL__)

61# define LLVM_GNUC_PREREQ(maj, min, patch) \

62 ((__GNUC__ << 20) + (__GNUC_MINOR__ << 10) + __GNUC_PATCHLEVEL__ >= \

63 ((maj) << 20) + ((min) << 10) + (patch))

64# elif defined(__GNUC__) && defined(__GNUC_MINOR__)

65# define LLVM_GNUC_PREREQ(maj, min, patch) \

66 ((__GNUC__ << 20) + (__GNUC_MINOR__ << 10) >= ((maj) << 20) + ((min) << 10))

67# else

68# define LLVM_GNUC_PREREQ(maj, min, patch) 0

69# endif

70#endif

93#ifdef _MSC_VER

94#define LLVM_MSC_PREREQ(version) (_MSC_VER >= (version))

97#if !defined(LLVM_FORCE_USE_OLD_TOOLCHAIN)

98#if !LLVM_MSC_PREREQ(1920)

99#error LLVM requires at least VS 2019.

100#endif

101#endif

102

103#else

104#define LLVM_MSC_PREREQ(version) 0

105#endif

106

107

108

109

110

111

112

113

114

115

116

117#if LLVM_HAS_CPP_ATTRIBUTE(gnu::visibility) && defined(__GNUC__) && \

118 !defined(__clang__)

119#define LLVM_ATTRIBUTE_VISIBILITY_HIDDEN [[gnu::visibility("hidden")]]

120#define LLVM_ATTRIBUTE_VISIBILITY_DEFAULT [[gnu::visibility("default")]]

121#elif __has_attribute(visibility)

122#define LLVM_ATTRIBUTE_VISIBILITY_HIDDEN __attribute__((visibility("hidden")))

123#define LLVM_ATTRIBUTE_VISIBILITY_DEFAULT __attribute__((visibility("default")))

124#else

125#define LLVM_ATTRIBUTE_VISIBILITY_HIDDEN

126#define LLVM_ATTRIBUTE_VISIBILITY_DEFAULT

127#endif

128

129#if defined(LLVM_BUILD_LLVM_DYLIB) || defined(LLVM_BUILD_SHARED_LIBS)

130#define LLVM_EXTERNAL_VISIBILITY LLVM_ATTRIBUTE_VISIBILITY_DEFAULT

131#else

132#define LLVM_EXTERNAL_VISIBILITY

133#endif

134

135#if (!(defined(_WIN32) || defined(__CYGWIN__)) || \

136 ((defined(__MINGW32__) || defined(__CYGWIN__)) && defined(__clang__)))

137#define LLVM_LIBRARY_VISIBILITY LLVM_ATTRIBUTE_VISIBILITY_HIDDEN

138

139

140#if defined(__clang__) && __clang_major__ < 15

141#define LLVM_LIBRARY_VISIBILITY_NAMESPACE [[gnu::visibility("hidden")]]

142#else

143#define LLVM_LIBRARY_VISIBILITY_NAMESPACE LLVM_ATTRIBUTE_VISIBILITY_HIDDEN

144#endif

145#define LLVM_ALWAYS_EXPORT LLVM_ATTRIBUTE_VISIBILITY_DEFAULT

146#elif defined(_WIN32)

147#define LLVM_ALWAYS_EXPORT __declspec(dllexport)

148#define LLVM_LIBRARY_VISIBILITY

149#define LLVM_LIBRARY_VISIBILITY_NAMESPACE

150#else

151#define LLVM_LIBRARY_VISIBILITY

152#define LLVM_ALWAYS_EXPORT

153#define LLVM_LIBRARY_VISIBILITY_NAMESPACE

154#endif

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179#ifndef LLVM_ABI_GENERATING_ANNOTATIONS

180

181

182#define LLVM_ABI_NOT_EXPORTED

183

184

185#if defined(LLVM_ENABLE_LLVM_EXPORT_ANNOTATIONS) && !defined(LLVM_BUILD_STATIC)

186#if defined(_WIN32) && !defined(__MINGW32__)

187#if defined(LLVM_EXPORTS)

188#define LLVM_ABI __declspec(dllexport)

189#define LLVM_TEMPLATE_ABI

190#define LLVM_EXPORT_TEMPLATE __declspec(dllexport)

191#else

192#define LLVM_ABI __declspec(dllimport)

193#define LLVM_TEMPLATE_ABI __declspec(dllimport)

194#define LLVM_EXPORT_TEMPLATE

195#endif

196#define LLVM_ABI_EXPORT __declspec(dllexport)

197#elif __has_attribute(visibility)

198#if defined(__ELF__) || defined(__MINGW32__) || defined(_AIX) || \

199 defined(__MVS__) || defined(__CYGWIN__)

200#define LLVM_ABI __attribute__((visibility("default")))

201#define LLVM_TEMPLATE_ABI LLVM_ABI

202#define LLVM_EXPORT_TEMPLATE

203#define LLVM_ABI_EXPORT LLVM_ABI

204#elif defined(__MACH__) || defined(__WASM__) || defined(__EMSCRIPTEN__)

205#define LLVM_ABI __attribute__((visibility("default")))

206#define LLVM_TEMPLATE_ABI

207#define LLVM_EXPORT_TEMPLATE

208#define LLVM_ABI_EXPORT LLVM_ABI

209#endif

210#endif

211#endif

212#if !defined(LLVM_ABI)

213#define LLVM_ABI

214#define LLVM_TEMPLATE_ABI

215#define LLVM_EXPORT_TEMPLATE

216#define LLVM_ABI_EXPORT

217#endif

218#define LLVM_ABI_FOR_TEST LLVM_ABI

219#endif

220

221#if defined(__GNUC__)

222#define LLVM_PREFETCH(addr, rw, locality) __builtin_prefetch(addr, rw, locality)

223#else

224#define LLVM_PREFETCH(addr, rw, locality)

225#endif

226

227#if __has_attribute(uninitialized)

228#define LLVM_ATTRIBUTE_UNINITIALIZED __attribute__((uninitialized))

229#else

230#define LLVM_ATTRIBUTE_UNINITIALIZED

231#endif

232

233#if __has_attribute(used)

234#define LLVM_ATTRIBUTE_USED __attribute__((__used__))

235#else

236#define LLVM_ATTRIBUTE_USED

237#endif

238

239

240

241

242

243#if defined(__clang__) && __has_attribute(retain)

244#define LLVM_ATTRIBUTE_RETAIN __attribute__((__retain__))

245#else

246#define LLVM_ATTRIBUTE_RETAIN

247#endif

248

249#if defined(__clang__)

250#define LLVM_DEPRECATED(MSG, FIX) __attribute__((deprecated(MSG, FIX)))

251#else

252#define LLVM_DEPRECATED(MSG, FIX) [[deprecated(MSG)]]

253#endif

254

255

256#if defined(__clang__) || defined(__GNUC__)

257#define LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_PUSH \

258 _Pragma("GCC diagnostic push") \

259 _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")

260#define LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_POP \

261 _Pragma("GCC diagnostic pop")

262#elif defined(_MSC_VER)

263#define LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_PUSH \

264 _Pragma("warning(push)") \

265 _Pragma("warning(disable : 4996)")

266#define LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_POP \

267 _Pragma("warning(pop)")

268#else

269#define LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_PUSH

270#define LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_POP

271#endif

272

273

274

275

276

277

278

279

280

281#if LLVM_HAS_CPP_ATTRIBUTE(clang::reinitializes)

282#define LLVM_ATTRIBUTE_REINITIALIZES [[clang::reinitializes]]

283#else

284#define LLVM_ATTRIBUTE_REINITIALIZES

285#endif

286

287

288

289

290

291

292

293

294

295#if __has_attribute(unused)

296#define LLVM_ATTRIBUTE_UNUSED __attribute__((__unused__))

297#else

298#define LLVM_ATTRIBUTE_UNUSED

299#endif

300

301

302#if __has_attribute(weak) && !defined(__MINGW32__) && !defined(__CYGWIN__) && \

303 !defined(_WIN32)

304#define LLVM_ATTRIBUTE_WEAK __attribute__((__weak__))

305#else

306#define LLVM_ATTRIBUTE_WEAK

307#endif

308

309

310

311#if defined(__clang__) || defined(__GNUC__)

312

313#define LLVM_READNONE __attribute__((__const__))

314#else

315#define LLVM_READNONE

316#endif

317

318#if __has_attribute(pure) || defined(__GNUC__)

319

320#define LLVM_READONLY __attribute__((__pure__))

321#else

322#define LLVM_READONLY

323#endif

324

325#if __has_attribute(minsize)

326#define LLVM_ATTRIBUTE_MINSIZE __attribute__((minsize))

327#else

328#define LLVM_ATTRIBUTE_MINSIZE

329#endif

330

331#if __has_builtin(__builtin_expect) || defined(__GNUC__)

332#define LLVM_LIKELY(EXPR) __builtin_expect((bool)(EXPR), true)

333#define LLVM_UNLIKELY(EXPR) __builtin_expect((bool)(EXPR), false)

334#else

335#define LLVM_LIKELY(EXPR) (EXPR)

336#define LLVM_UNLIKELY(EXPR) (EXPR)

337#endif

338

339

340

341#if __has_attribute(noinline)

342#define LLVM_ATTRIBUTE_NOINLINE __attribute__((noinline))

343#elif defined(_MSC_VER)

344#define LLVM_ATTRIBUTE_NOINLINE __declspec(noinline)

345#else

346#define LLVM_ATTRIBUTE_NOINLINE

347#endif

348

349

350

351#if __has_attribute(always_inline)

352#define LLVM_ATTRIBUTE_ALWAYS_INLINE inline __attribute__((always_inline))

353#elif defined(_MSC_VER)

354#define LLVM_ATTRIBUTE_ALWAYS_INLINE __forceinline

355#else

356#define LLVM_ATTRIBUTE_ALWAYS_INLINE inline

357#endif

358

359

360

361

362#if __has_attribute(nodebug)

363#define LLVM_ATTRIBUTE_NODEBUG __attribute__((nodebug))

364#else

365#define LLVM_ATTRIBUTE_NODEBUG

366#endif

367

368#if __has_attribute(returns_nonnull)

369#define LLVM_ATTRIBUTE_RETURNS_NONNULL __attribute__((returns_nonnull))

370#elif defined(_MSC_VER)

371#define LLVM_ATTRIBUTE_RETURNS_NONNULL _Ret_notnull_

372#else

373#define LLVM_ATTRIBUTE_RETURNS_NONNULL

374#endif

375

376

377

378#if defined(__clang__) || defined(__GNUC__) || defined(_MSC_VER)

379#define LLVM_ATTRIBUTE_RESTRICT __restrict

380#else

381#define LLVM_ATTRIBUTE_RESTRICT

382#endif

383

384

385

386#ifdef __GNUC__

387#define LLVM_ATTRIBUTE_RETURNS_NOALIAS __attribute__((__malloc__))

388#elif defined(_MSC_VER)

389#define LLVM_ATTRIBUTE_RETURNS_NOALIAS __declspec(restrict)

390#else

391#define LLVM_ATTRIBUTE_RETURNS_NOALIAS

392#endif

393

394

395#if defined(__cplusplus) && __cplusplus > 201402L && LLVM_HAS_CPP_ATTRIBUTE(fallthrough)

396#define LLVM_FALLTHROUGH [[fallthrough]]

397#elif LLVM_HAS_CPP_ATTRIBUTE(gnu::fallthrough)

398#define LLVM_FALLTHROUGH [[gnu::fallthrough]]

399#elif __has_attribute(fallthrough)

400#define LLVM_FALLTHROUGH __attribute__((fallthrough))

401#elif LLVM_HAS_CPP_ATTRIBUTE(clang::fallthrough)

402#define LLVM_FALLTHROUGH [[clang::fallthrough]]

403#else

404#define LLVM_FALLTHROUGH

405#endif

406

407

408

409#if LLVM_HAS_CPP_ATTRIBUTE(clang::require_constant_initialization)

410#define LLVM_REQUIRE_CONSTANT_INITIALIZATION \

411 [[clang::require_constant_initialization]]

412#else

413#define LLVM_REQUIRE_CONSTANT_INITIALIZATION

414#endif

415

416

417

418#if LLVM_HAS_CPP_ATTRIBUTE(gsl::Owner)

419#define LLVM_GSL_OWNER [[gsl::Owner]]

420#else

421#define LLVM_GSL_OWNER

422#endif

423

424

425

426#if LLVM_HAS_CPP_ATTRIBUTE(gsl::Pointer)

427#define LLVM_GSL_POINTER [[gsl::Pointer]]

428#else

429#define LLVM_GSL_POINTER

430#endif

431

432#if LLVM_HAS_CPP_ATTRIBUTE(clang::lifetimebound)

433#define LLVM_LIFETIME_BOUND [[clang::lifetimebound]]

434#else

435#define LLVM_LIFETIME_BOUND

436#endif

437

438#if LLVM_HAS_CPP_ATTRIBUTE(nodiscard) >= 201907L

439#define LLVM_CTOR_NODISCARD [[nodiscard]]

440#else

441#define LLVM_CTOR_NODISCARD

442#endif

443

444

445

446#ifdef __GNUC__

447#define LLVM_EXTENSION __extension__

448#else

449#define LLVM_EXTENSION

450#endif

451

452

453

454

455

456

457

458

459#if __has_builtin(__builtin_unreachable) || defined(__GNUC__)

460# define LLVM_BUILTIN_UNREACHABLE __builtin_unreachable()

461#elif defined(_MSC_VER)

462# define LLVM_BUILTIN_UNREACHABLE __assume(false)

463#endif

464

465

466

467#if __has_builtin(__builtin_trap) || defined(__GNUC__)

468# define LLVM_BUILTIN_TRAP __builtin_trap()

469#elif defined(_MSC_VER)

470

471

472

473

474# define LLVM_BUILTIN_TRAP __debugbreak()

475#else

476# define LLVM_BUILTIN_TRAP *(volatile int*)0x11 = 0

477#endif

478

479

480

481

482#if __has_builtin(__builtin_debugtrap)

483# define LLVM_BUILTIN_DEBUGTRAP __builtin_debugtrap()

484#elif defined(_MSC_VER)

485

486

487

488# define LLVM_BUILTIN_DEBUGTRAP __debugbreak()

489#else

490

491

492

493# define LLVM_BUILTIN_DEBUGTRAP

494#endif

495

496

497

498#if __has_builtin(__builtin_assume_aligned) || defined(__GNUC__)

499# define LLVM_ASSUME_ALIGNED(p, a) __builtin_assume_aligned(p, a)

500#elif defined(LLVM_BUILTIN_UNREACHABLE)

501# define LLVM_ASSUME_ALIGNED(p, a) \

502 (((uintptr_t(p) % (a)) == 0) ? (p) : (LLVM_BUILTIN_UNREACHABLE, (p)))

503#else

504# define LLVM_ASSUME_ALIGNED(p, a) (p)

505#endif

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525#ifdef _MSC_VER

526# define LLVM_PACKED(d) __pragma(pack(push, 1)) d __pragma(pack(pop))

527# define LLVM_PACKED_START __pragma(pack(push, 1))

528# define LLVM_PACKED_END __pragma(pack(pop))

529#else

530# define LLVM_PACKED(d) d __attribute__((packed))

531# define LLVM_PACKED_START _Pragma("pack(push, 1)")

532# define LLVM_PACKED_END _Pragma("pack(pop)")

533#endif

534

535

536

537#if __has_feature(memory_sanitizer)

538# define LLVM_MEMORY_SANITIZER_BUILD 1

539# include <sanitizer/msan_interface.h>

540# define LLVM_NO_SANITIZE_MEMORY_ATTRIBUTE __attribute__((no_sanitize_memory))

541#else

542# define LLVM_MEMORY_SANITIZER_BUILD 0

543# define __msan_allocated_memory(p, size)

544# define __msan_unpoison(p, size)

545# define LLVM_NO_SANITIZE_MEMORY_ATTRIBUTE

546#endif

547

548

549

550#if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__)

551# define LLVM_ADDRESS_SANITIZER_BUILD 1

552#if __has_include(<sanitizer/asan_interface.h>)

553# include <sanitizer/asan_interface.h>

554#else

555

556

557#ifdef __cplusplus

558extern "C" {

559#endif

562#ifdef __cplusplus

563}

564#endif

565#endif

566#else

567# define LLVM_ADDRESS_SANITIZER_BUILD 0

568# define __asan_poison_memory_region(p, size)

569# define __asan_unpoison_memory_region(p, size)

570#endif

571

572

573

574#if __has_feature(hwaddress_sanitizer)

575#define LLVM_HWADDRESS_SANITIZER_BUILD 1

576#else

577#define LLVM_HWADDRESS_SANITIZER_BUILD 0

578#endif

579

580

581

582#if __has_feature(thread_sanitizer) || defined(__SANITIZE_THREAD__)

583# define LLVM_THREAD_SANITIZER_BUILD 1

584#else

585# define LLVM_THREAD_SANITIZER_BUILD 0

586#endif

587

588#if LLVM_THREAD_SANITIZER_BUILD

589

590

591

592#ifdef __cplusplus

593extern "C" {

594#endif

595void AnnotateHappensAfter(const char *file, int line, const volatile void *cv);

596void AnnotateHappensBefore(const char *file, int line, const volatile void *cv);

597void AnnotateIgnoreWritesBegin(const char *file, int line);

598void AnnotateIgnoreWritesEnd(const char *file, int line);

599#ifdef __cplusplus

600}

601#endif

602

603

604

605

606# define TsanHappensBefore(cv) AnnotateHappensBefore(__FILE__, __LINE__, cv)

607

608

609# define TsanHappensAfter(cv) AnnotateHappensAfter(__FILE__, __LINE__, cv)

610

611

612# define TsanIgnoreWritesBegin() AnnotateIgnoreWritesBegin(__FILE__, __LINE__)

613

614

615# define TsanIgnoreWritesEnd() AnnotateIgnoreWritesEnd(__FILE__, __LINE__)

616#else

617# define TsanHappensBefore(cv)

618# define TsanHappensAfter(cv)

619# define TsanIgnoreWritesBegin()

620# define TsanIgnoreWritesEnd()

621#endif

622

623

624

625#if __has_attribute(no_sanitize)

626#define LLVM_NO_SANITIZE(KIND) __attribute__((no_sanitize(KIND)))

627#else

628#define LLVM_NO_SANITIZE(KIND)

629#endif

630

631

632

633

634

635

636

637#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)

638#define LLVM_DUMP_METHOD \

639 LLVM_ATTRIBUTE_NOINLINE LLVM_ATTRIBUTE_USED LLVM_ATTRIBUTE_RETAIN

640#else

641#define LLVM_DUMP_METHOD LLVM_ATTRIBUTE_NOINLINE

642#endif

643

644

645

646

647

648

649#if defined(_MSC_VER)

650#define LLVM_PRETTY_FUNCTION __FUNCSIG__

651#elif defined(__GNUC__) || defined(__clang__)

652#define LLVM_PRETTY_FUNCTION __PRETTY_FUNCTION__

653#else

654#define LLVM_PRETTY_FUNCTION __func__

655#endif

656

657

658

659

660

661

662

663

664

665

666

667

668#if LLVM_ENABLE_THREADS

669#if __has_feature(cxx_thread_local) || defined(_MSC_VER)

670#define LLVM_THREAD_LOCAL thread_local

671#else

672

673

674#define LLVM_THREAD_LOCAL __thread

675#endif

676#else

677

678

679#define LLVM_THREAD_LOCAL

680#endif

681

682

683

684#if __has_feature(cxx_exceptions)

685#define LLVM_ENABLE_EXCEPTIONS 1

686#elif defined(__GNUC__) && defined(__EXCEPTIONS)

687#define LLVM_ENABLE_EXCEPTIONS 1

688#elif defined(_MSC_VER) && defined(_CPPUNWIND)

689#define LLVM_ENABLE_EXCEPTIONS 1

690#endif

691

692

693

694#if __has_attribute(no_profile_instrument_function)

695#define LLVM_NO_PROFILE_INSTRUMENT_FUNCTION \

696 __attribute__((no_profile_instrument_function))

697#else

698#define LLVM_NO_PROFILE_INSTRUMENT_FUNCTION

699#endif

700

701

702

703#if __has_attribute(preferred_type)

704#define LLVM_PREFERRED_TYPE(T) __attribute__((preferred_type(T)))

705#else

706#define LLVM_PREFERRED_TYPE(T)

707#endif

708

709#if LLVM_HAS_CPP_ATTRIBUTE(clang::ptrauth_vtable_pointer) && \

710 (defined(__PTRAUTH__) || __has_feature(ptrauth_calls))

711#define LLVM_MOVABLE_POLYMORPHIC_TYPE \

712 [[clang::ptrauth_vtable_pointer(default_key, no_address_discrimination, \

713 default_extra_discrimination)]]

714#else

715#define LLVM_MOVABLE_POLYMORPHIC_TYPE

716#endif

717

718

719

720

721

722

723

724#if defined(__clang__)

725

726 #if __has_warning("-Wunnecessary-virtual-specifier")

727 #define LLVM_DECLARE_VIRTUAL_ANCHOR_FUNCTION() \

728 _Pragma("clang diagnostic push") \

729 _Pragma("clang diagnostic ignored \"-Wunnecessary-virtual-specifier\"") \

730 virtual void anchor() \

731 _Pragma("clang diagnostic pop")

732 #else

733 #define LLVM_DECLARE_VIRTUAL_ANCHOR_FUNCTION() \

734 virtual void anchor()

735 #endif

736#else

737 #define LLVM_DECLARE_VIRTUAL_ANCHOR_FUNCTION() \

738 virtual void anchor()

739#endif

740

741

742#endif

#define __asan_poison_memory_region(p, size)

Definition Compiler.h:568

#define __asan_unpoison_memory_region(p, size)

Definition Compiler.h:569

dot regions Print regions of function to dot file(with no function bodies)"