dart-sdk/runtime/docs/pragmas.md
Teagan Strickland f822dfa3ea Reland "[vm/compiler] Implement new inlining pragmas."
This change introduces two new pragmas:

* `@pragma('vm:never-inline')`
* `@pragma('vm:prefer-inline')`

These replaces the old way of specifying AlwaysInline or NeverInline
annotations when the (now removed) --enable-inlining-annotations flag
was used.

Bug: https://github.com/dart-lang/sdk/issues/36571
Change-Id: Iee152c1d67abde8d58c58fa967449d36e77c8c93
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/110440
Commit-Queue: Teagan Strickland <sstrickl@google.com>
Reviewed-by: Samir Jindel <sjindel@google.com>
2019-07-30 12:01:06 +00:00

1.7 KiB

VM-Specific Pragma Annotations

Pragmas for general use

These pragmas are part of the VM's API and are safe for use in external code.

Pragma Meaning
vm:entry-point Defining entry-points into Dart code for an embedder or native methods
vm:never-inline Never inline a function or method
vm:prefer-inline Inline a function or method when possible

Pragmas for internal use

These pragmas can cause unsound behavior if used incorrectly and therefore are only allowed within the core SDK libraries.

Pragma Meaning
vm:exact-result-type Declaring an exact result type of a method

Pragmas for internal testing

These pragmas are used for inspecting or modifying internal VM state and should be used exclusively by SDK tests. They must be enabled with the --enable-testing-pragmas flag. The names of these pragmas are prefixed with "testing". Additionally, they are categorized into "safe" and "unsafe" forms: "safe" pragmas should not affect the behavior of the program and can be safely added anywhere, whereas "unsafe" pragmas may change the code's behavior or may cause the VM to crash if used improperly.

Pragma Meaning
vm:testing.unsafe.trace-entrypoints-fn Observing which flow-graph-level entry-point was used when a function was called