AnnotateInternalFunctionsPass Class Reference

#include <AnnotateInternalFunctionsPass.h>

Inheritance diagram for AnnotateInternalFunctionsPass:

Collaboration diagram for AnnotateInternalFunctionsPass:

Public Member Functions
	AnnotateInternalFunctionsPass ()
bool	runOnSCC (llvm::CallGraphSCC &SCC) override
llvm::StringRef	getPassName () const override

Static Public Attributes
static char	ID = 0

Static Private Member Functions
static bool	isInternalStatelessFunction (const llvm::StringRef &func_name)
static bool	isInternalMathFunction (const llvm::StringRef &func_name)

Static Private Attributes
static const std::set < std::string >	extension_functions
static const std::set < std::string >	math_builtins

Detailed Description

Annotates internal functions with function attributes designating the function as one which does not modify memory, does not throw, does not synchronize state with other functions/parts of the program, and is guaranteed to return. This allows the LLVM optimizer to more aggressively remove / reorder these functions and is particularly important for dead code elimination.

Definition at line 34 of file AnnotateInternalFunctionsPass.h.

Constructor & Destructor Documentation

AnnotateInternalFunctionsPass::AnnotateInternalFunctionsPass ( )

inline

Definition at line 37 of file AnnotateInternalFunctionsPass.h.

: CallGraphSCCPass(ID) {}

Member Function Documentation

llvm::StringRef AnnotateInternalFunctionsPass::getPassName ( ) const

inlineoverride

Definition at line 70 of file AnnotateInternalFunctionsPass.h.

{ return "AnnotateInternalFunctionsPass"; }

static bool AnnotateInternalFunctionsPass::isInternalMathFunction ( const llvm::StringRef &  func_name )

inlinestaticprivate

Definition at line 82 of file AnnotateInternalFunctionsPass.h.

References math_builtins.

Referenced by runOnSCC().

                                                                     {
    // include all math functions from ExtensionFunctions.hpp
    return math_builtins.count(func_name.str()) > 0;
  }

Here is the caller graph for this function:

static bool AnnotateInternalFunctionsPass::isInternalStatelessFunction ( const llvm::StringRef &  func_name )

inlinestaticprivate

Definition at line 75 of file AnnotateInternalFunctionsPass.h.

References extension_functions.

Referenced by runOnSCC().

                                                                          {
    // extension functions or non-inlined builtins which do not modify any state
    return extension_functions.count(func_name.str()) > 0;
  }

Here is the caller graph for this function:

bool AnnotateInternalFunctionsPass::runOnSCC ( llvm::CallGraphSCC &  SCC )

inlineoverride

Definition at line 39 of file AnnotateInternalFunctionsPass.h.

References CHECK, isInternalMathFunction(), and isInternalStatelessFunction().

                                                {
    bool updated_function_defs = false;

    // iterate the call graph
    for (auto& node : SCC) {
      CHECK(node);
      auto fcn = node->getFunction();
      if (!fcn) {
        continue;
      }
      if (isInternalStatelessFunction(fcn->getName()) ||
          isInternalMathFunction(fcn->getName())) {
        updated_function_defs = true;
        std::vector<llvm::Attribute::AttrKind> attrs{llvm::Attribute::NoFree,
                                                     llvm::Attribute::NoSync,
                                                     llvm::Attribute::NoUnwind,
                                                     llvm::Attribute::WillReturn,
                                                     llvm::Attribute::ReadNone,
                                                     llvm::Attribute::Speculatable};
        // WriteOnly is automatically added to all math functions in llvm 14.0
        // https://reviews.llvm.org/D116426 which is incompatible with ReadNone.
        fcn->removeFnAttr(llvm::Attribute::WriteOnly);
        for (const auto& attr : attrs) {
          fcn->addFnAttr(attr);
        }
      }
    }

    return updated_function_defs;
  }

Here is the call graph for this function:

Member Data Documentation

const std::set< std::string > AnnotateInternalFunctionsPass::extension_functions

staticprivate

Initial value:

=
    std::set<std::string>{"point_coord_array_is_null",
                          "decompress_x_coord_geoint",
                          "decompress_y_coord_geoint",
                          "compress_x_coord_geoint",
                          "compress_y_coord_geoint",
                          
                          "transform_4326_900913_x",
                          "transform_4326_900913_y",
                          "transform_900913_4326_x",
                          "transform_900913_4326_y",
                          
                          "conv_4326_900913_x",
                          "conv_4326_900913_y",
                          "distance_in_meters",
                          "approx_distance_in_meters",
                          "rect_pixel_bin_x",
                          "rect_pixel_bin_y",
                          "rect_pixel_bin_packed",
                          "reg_hex_horiz_pixel_bin_x",
                          "reg_hex_horiz_pixel_bin_y",
                          "reg_hex_horiz_pixel_bin_packed",
                          "reg_hex_vert_pixel_bin_x",
                          "reg_hex_vert_pixel_bin_y",
                          "reg_hex_vert_pixel_bin_packed",
                          "convert_meters_to_merc_pixel_width",
                          "convert_meters_to_merc_pixel_height",
                          "is_point_in_merc_view",
                          "is_point_size_in_merc_view"}

Definition at line 73 of file AnnotateInternalFunctionsPass.h.

Referenced by isInternalStatelessFunction().

char AnnotateInternalFunctionsPass::ID = 0

static

Definition at line 36 of file AnnotateInternalFunctionsPass.h.

const std::set< std::string > AnnotateInternalFunctionsPass::math_builtins

staticprivate

Initial value:

=
    std::set<std::string>{"Acos",  "Asin",    "Atan", "Atan2",    "Ceil",    "Cos",
                          "Cot",   "degrees", "Exp",  "Floor",    "ln",      "Log",
                          "Log10", "log",     "pi",   "power",    "radians", "Round",
                          "Sin",   "Tan",     "tan",  "Truncate", "is_nan",  "is_inf"}

Definition at line 80 of file AnnotateInternalFunctionsPass.h.

Referenced by isInternalMathFunction().

---

The documentation for this class was generated from the following file:

• /home/jenkins-slave/workspace/core-os-doxygen/QueryEngine/Optimization/AnnotateInternalFunctionsPass.h