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 147 148 149 150 151 152 153 154 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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
use std::ffi::c_void;
use super::{
FunctionAnalysisManager, FunctionPassManager, ModuleAnalysisManager, ModulePassManager,
};
/// Main struct for registering callbacks.
pub struct PassBuilder {
inner: *mut c_void,
}
impl PassBuilder {
#[doc(hidden)]
pub unsafe fn from_raw(pass_builder: *mut c_void) -> Self {
Self {
inner: pass_builder,
}
}
/// Register a new pipeline parsing callback.
///
/// These callbacks can be used to parse a single pass name, and populate
/// the given [ModulePassManager] accordingly.
pub fn add_module_pipeline_parsing_callback<T>(&mut self, cb: T)
where
T: Fn(&str, &mut ModulePassManager) -> PipelineParsing,
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
name_ptr: *const u8,
name_len: usize,
manager: *mut c_void,
) -> bool
where
T: Fn(&str, &mut ModulePassManager) -> PipelineParsing,
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let name = unsafe { std::slice::from_raw_parts(name_ptr, name_len) };
let name = unsafe { std::str::from_utf8_unchecked(name) };
let mut manager = unsafe { ModulePassManager::from_raw(manager) };
let res = cb(name, &mut manager);
Box::into_raw(cb);
matches!(res, PipelineParsing::Parsed)
}
unsafe {
super::passBuilderAddModulePipelineParsingCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new pipeline parsing callback.
///
/// These callbacks can be used to parse a single pass name, and populate
/// the given [FunctionPassManager] accordingly.
pub fn add_function_pipeline_parsing_callback<T>(&mut self, cb: T)
where
T: Fn(&str, &mut FunctionPassManager) -> PipelineParsing,
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
name_ptr: *const u8,
name_len: usize,
manager: *mut c_void,
) -> bool
where
T: Fn(&str, &mut FunctionPassManager) -> PipelineParsing,
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let name = unsafe { std::slice::from_raw_parts(name_ptr, name_len) };
let name = unsafe { std::str::from_utf8_unchecked(name) };
let mut manager = unsafe { FunctionPassManager::from_raw(manager) };
let res = cb(name, &mut manager);
Box::into_raw(cb);
matches!(res, PipelineParsing::Parsed)
}
unsafe {
super::passBuilderAddFunctionPipelineParsingCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback for analysis registration.
///
/// These callbacks can be used to register custom analyses with the given
/// [ModuleAnalysisManager].
pub fn add_module_analysis_registration_callback<T>(&mut self, cb: T)
where
T: Fn(&mut ModuleAnalysisManager),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(cb: *const c_void, manager: *mut c_void)
where
T: Fn(&mut ModuleAnalysisManager),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { ModuleAnalysisManager::from_raw(manager, None) };
cb(&mut manager);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddModuleAnalysisRegistrationCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback for analysis registration.
///
/// These callbacks can be used to register custom analyses with the given
/// [FunctionAnalysisManager].
pub fn add_function_analysis_registration_callback<T>(&mut self, cb: T)
where
T: Fn(&mut FunctionAnalysisManager),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(cb: *const c_void, manager: *mut c_void)
where
T: Fn(&mut FunctionAnalysisManager),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { FunctionAnalysisManager::from_raw(manager, None) };
cb(&mut manager);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddFunctionAnalysisRegistrationCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback to be triggered at the peephole
/// extension point.
///
/// # From the LLVM documentation
///
/// This extension point allows adding passes that perform peephole
/// optimizations similar to the instruction combiner.
///
/// These passes will be inserted after each instance of the instruction
/// combiner pass.
pub fn add_peephole_ep_callback<T>(&mut self, cb: T)
where
T: Fn(&mut FunctionPassManager, OptimizationLevel),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
manager: *mut c_void,
opt: OptimizationLevel,
) where
T: Fn(&mut FunctionPassManager, OptimizationLevel),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { FunctionPassManager::from_raw(manager) };
cb(&mut manager, opt);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddPeepholeEPCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback to be triggered at the optimizer
/// late extension point.
///
/// # From the LLVM documentation
///
/// This extension point allows adding optimization passes after
/// most of the main optimizations, but before the last cleanup-ish
/// optimizations.
pub fn add_scalar_optimizer_late_ep_callback<T>(&mut self, cb: T)
where
T: Fn(&mut FunctionPassManager, OptimizationLevel),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
manager: *mut c_void,
opt: OptimizationLevel,
) where
T: Fn(&mut FunctionPassManager, OptimizationLevel),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { FunctionPassManager::from_raw(manager) };
cb(&mut manager, opt);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddScalarOptimizerLateEPCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback to be triggered at the vectorizer
/// start extension point.
///
/// # From the LLVM documentation
///
/// This extension point allows adding optimization passes before
/// the vectorizer and other highly target specific optimization
/// passes are executed.
pub fn add_vectorizer_start_ep_callback<T>(&mut self, cb: T)
where
T: Fn(&mut FunctionPassManager, OptimizationLevel),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
manager: *mut c_void,
opt: OptimizationLevel,
) where
T: Fn(&mut FunctionPassManager, OptimizationLevel),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { FunctionPassManager::from_raw(manager) };
cb(&mut manager, opt);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddVectorizerStartEPCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback to be triggered at the pipeline
/// start extension point.
///
/// # From the LLVM documentation
///
/// This extension point allows adding optimization once at the start
/// of the pipeline. This does not apply to 'backend' compiles (LTO and
/// ThinLTO link-time pipelines).
#[cfg(any(
feature = "llvm12-0",
feature = "llvm13-0",
feature = "llvm14-0",
feature = "llvm15-0",
feature = "llvm16-0",
))]
pub fn add_pipeline_start_ep_callback<T>(&mut self, cb: T)
where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
manager: *mut c_void,
opt: OptimizationLevel,
) where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { ModulePassManager::from_raw(manager) };
cb(&mut manager, opt);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddPipelineStartEPCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback to be triggered at the pipeline
/// early simplification extension point.
///
/// # From the LLVM documentation
///
/// This extension point allows adding optimization right after passes
/// that do basic simplification of the input IR.
#[cfg(any(
feature = "llvm12-0",
feature = "llvm13-0",
feature = "llvm14-0",
feature = "llvm15-0",
feature = "llvm16-0",
))]
pub fn add_pipeline_early_simplification_ep_callback<T>(&mut self, cb: T)
where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
manager: *mut c_void,
opt: OptimizationLevel,
) where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { ModulePassManager::from_raw(manager) };
cb(&mut manager, opt);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddPipelineEarlySimplificationEPCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback to be triggered at the optimizer
/// last extension point.
///
/// # From the LLVM documentation
///
/// This extension point allows adding passes that run after everything
/// else.
#[cfg(any(
feature = "llvm11-0",
feature = "llvm12-0",
feature = "llvm13-0",
feature = "llvm14-0",
feature = "llvm15-0",
feature = "llvm16-0",
))]
pub fn add_optimizer_last_ep_callback<T>(&mut self, cb: T)
where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
manager: *mut c_void,
opt: OptimizationLevel,
) where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { ModulePassManager::from_raw(manager) };
cb(&mut manager, opt);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddOptimizerLastEPCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback to be triggered at the full LTO
/// early extension point.
///
/// # From the LLVM documentation
///
/// This extension point allow adding passes that run at Link Time,
/// before Full Link Time Optimization.
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
pub fn add_full_lto_early_ep_callback<T>(&mut self, cb: T)
where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
manager: *mut c_void,
opt: OptimizationLevel,
) where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { ModulePassManager::from_raw(manager) };
cb(&mut manager, opt);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddFullLinkTimeOptimizationEarlyEPCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback to be triggered at the full LTO
/// last extension point.
///
/// # From the LLVM documentation
///
/// This extensions point allow adding passes that run at Link Time,
/// after Full Link Time Optimization.
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
pub fn add_full_lto_last_ep_callback<T>(&mut self, cb: T)
where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
manager: *mut c_void,
opt: OptimizationLevel,
) where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { ModulePassManager::from_raw(manager) };
cb(&mut manager, opt);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddFullLinkTimeOptimizationLastEPCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
/// Register a new callback to be triggered at the optimizer
/// early extension point.
///
/// # From the LLVM documentation
///
/// This extension point allows adding passes just before the main
/// module-level optimization passes.
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
pub fn add_optimizer_early_ep_callback<T>(&mut self, cb: T)
where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = Box::new(cb);
extern "C" fn callback_deleter<T>(cb: *const c_void) {
drop(unsafe { Box::<T>::from_raw(cb as *mut _) })
}
extern "C" fn callback_entrypoint<T>(
cb: *const c_void,
manager: *mut c_void,
opt: OptimizationLevel,
) where
T: Fn(&mut ModulePassManager, OptimizationLevel),
{
let cb = unsafe { Box::<T>::from_raw(cb as *mut _) };
let mut manager = unsafe { ModulePassManager::from_raw(manager) };
cb(&mut manager, opt);
Box::into_raw(cb);
}
unsafe {
super::passBuilderAddOptimizerEarlyEPCallback(
self.inner,
Box::into_raw(cb).cast(),
callback_deleter::<T>,
callback_entrypoint::<T>,
)
}
}
}
/// Enum describing whether a pipeline parsing callback
/// successfully parsed its given pipeline element.
#[derive(Clone, Copy)]
pub enum PipelineParsing {
/// The pipeline element was successfully parsed.
Parsed,
/// The pipeline element wasn't parsed.
NotParsed,
}
/// Enum for the LLVM-provided high-level optimization levels.
///
/// Each level has a specific goal and rationale.
#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub enum OptimizationLevel {
/// This level disables as many optimizations as possible.
O0,
/// This level optimizes quickly without destroying debuggability.
O1,
/// This level optimizes for fast execution as much as possible
/// without triggering significant incremental compile time or
/// code size growth.
O2,
/// This level optimizes for fast execution as much as possible.
O3,
/// This level is similar to **O2** but tries to optimize
/// for small code size instead of fast execution without
/// triggering significant incremental execution time slowdowns.
Os,
/// This level will optimize for code size at any and all costs.
Oz,
}