[#llvm-AliasSummary]
= xref:llvm.adoc[llvm]::AliasSummary
:relfileprefix: ../
:mrdocs:

Alias summary information.

== Synopsis

Declared in `<llvm/IR/ModuleSummaryIndex.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class AliasSummary
    : public xref:llvm/GlobalValueSummary.adoc[GlobalValueSummary]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/GlobalValueSummary.adoc[GlobalValueSummary]`
| Function and variable summary information to aid decisions and implementation of importing.
|===

== Types

[cols="1,4"]
|===
| Name| Description
| xref:llvm/GlobalValueSummary/GVFlags.adoc[`GVFlags`] 
| Group flags (Linkage, NotEligibleToImport, etc.) as a bitfield.
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:llvm/GlobalValueSummary/ImportKind.adoc[`ImportKind`] 
| Whether a value should be imported as a definition or a declaration.
| xref:llvm/GlobalValueSummary/SummaryKind.adoc[`SummaryKind`] 
| Subclass discriminator (for dyn_cast<> et al.)
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/AliasSummary/2constructor.adoc[`AliasSummary`]         [.small]#[constructor]#
| Construct an alias summary with the given flags.
| xref:llvm/GlobalValueSummary/canAutoHide.adoc[`canAutoHide`] 
| Return true if this value can be auto‐hidden.
| xref:llvm/GlobalValueSummary/flags-0f.adoc[`flags`] 
| Get the flags for this GlobalValue (see `struct` GVFlags).
| xref:llvm/AliasSummary/getAliasee-09.adoc[`getAliasee`] 
| `getAliasee` overloads
| xref:llvm/AliasSummary/getAliaseeGUID.adoc[`getAliaseeGUID`] 
| Return the GUID of the aliasee.
| xref:llvm/AliasSummary/getAliaseeVI.adoc[`getAliaseeVI`] 
| Return the ValueInfo for the aliasee.
| xref:llvm/GlobalValueSummary/getBaseObject-0a.adoc[`getBaseObject`] 
| `getBaseObject` overloads
| xref:llvm/GlobalValueSummary/getOriginalName.adoc[`getOriginalName`] 
| Returns the hash of the original name, it is identical to the GUID for externally visible symbols, but not for local ones.
| xref:llvm/GlobalValueSummary/getSummaryKind.adoc[`getSummaryKind`] 
| Which kind of summary subclass this is.
| xref:llvm/GlobalValueSummary/getVisibility.adoc[`getVisibility`] 
| Return the visibility recorded for this global value.
| xref:llvm/AliasSummary/hasAliasee.adoc[`hasAliasee`] 
| Return true if this alias has an associated aliasee summary.
| xref:llvm/GlobalValueSummary/importType.adoc[`importType`] 
| Return whether this value should be imported as definition or declaration.
| xref:llvm/GlobalValueSummary/isDSOLocal.adoc[`isDSOLocal`] 
| Return true if this symbol was resolved DSO‐locally.
| xref:llvm/GlobalValueSummary/isLive.adoc[`isLive`] 
| Return true if this global value is live.
| xref:llvm/GlobalValueSummary/linkage.adoc[`linkage`] 
| Return linkage type recorded for this global value.
| xref:llvm/GlobalValueSummary/modulePath-0a.adoc[`modulePath`] 
| Get the path to the module containing this function.
| xref:llvm/GlobalValueSummary/noRenameOnPromotion.adoc[`noRenameOnPromotion`] 
| Return true if promotion must not rename this static global.
| xref:llvm/GlobalValueSummary/notEligibleToImport.adoc[`notEligibleToImport`] 
| Return true if this global value can't be imported.
| xref:llvm/GlobalValueSummary/promote.adoc[`promote`] 
| Promote this local symbol to external linkage and mark it promoted.
| xref:llvm/GlobalValueSummary/refs.adoc[`refs`] 
| Return the list of values referenced by this global value definition.
| xref:llvm/AliasSummary/setAliasee.adoc[`setAliasee`] 
| Set the aliasee ValueInfo and summary for this alias.
| xref:llvm/GlobalValueSummary/setCanAutoHide.adoc[`setCanAutoHide`] 
| Set whether this value can be auto‐hidden.
| xref:llvm/GlobalValueSummary/setDSOLocal.adoc[`setDSOLocal`] 
| Set whether this symbol was resolved DSO‐locally.
| xref:llvm/GlobalValueSummary/setExternalLinkageForTest.adoc[`setExternalLinkageForTest`] 
| Set external linkage for testing without going through promote().
| xref:llvm/GlobalValueSummary/setImportKind.adoc[`setImportKind`] 
| Set whether to import this value as a definition or declaration.
| xref:llvm/GlobalValueSummary/setLinkage.adoc[`setLinkage`] 
| Sets the linkage to the value determined by global summary‐based optimization. Will be applied in the ThinLTO backends.
| xref:llvm/GlobalValueSummary/setLive.adoc[`setLive`] 
| Set whether this global value is live.
| xref:llvm/GlobalValueSummary/setModulePath.adoc[`setModulePath`] 
| Set the path to the module containing this function, for use in the combined index.
| xref:llvm/GlobalValueSummary/setNoRenameOnPromotion.adoc[`setNoRenameOnPromotion`] 
| Set whether promotion must not rename this static global.
| xref:llvm/GlobalValueSummary/setNotEligibleToImport.adoc[`setNotEligibleToImport`] 
| Flag that this global value cannot be imported.
| xref:llvm/GlobalValueSummary/setOriginalName.adoc[`setOriginalName`] 
| Initialize the original name hash in this summary.
| xref:llvm/GlobalValueSummary/setVisibility.adoc[`setVisibility`] 
| Set the visibility recorded for this global value.
| xref:llvm/GlobalValueSummary/shouldImportAsDecl.adoc[`shouldImportAsDecl`] 
| Return true if this value should be imported as a declaration.
| xref:llvm/GlobalValueSummary/wasPromoted.adoc[`wasPromoted`] 
| Return true if this symbol was promoted from local linkage.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/AliasSummary/classof.adoc[`classof`] 
| Check if this is an alias summary.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#