LLVMCodeBuilder: Implement sin operator

Author: adazem009

src/dev/engine/internal/icodebuilder.h

@@ -43,6 +43,7 @@ class ICodeBuilder
         virtual void createFloor() = 0;
         virtual void createCeil() = 0;
         virtual void createSqrt() = 0;
+        virtual void createSin() = 0;
 
         virtual void beginIfStatement() = 0;
         virtual void beginElseBranch() = 0;

src/dev/engine/internal/llvmcodebuilder.cpp

@@ -250,6 +250,24 @@ std::shared_ptr<ExecutableCode> LLVMCodeBuilder::finalize()
                 break;
             }
 
+            case Step::Type::Sin: {
+                assert(step.args.size() == 1);
+                const auto &arg = step.args[0];
+                // round(sin(x * pi / 180.0) * 1e10) / 1e10 + 0.0
+                // +0.0 to avoid -0.0
+                llvm::Constant *zero = llvm::ConstantFP::get(m_ctx, llvm::APFloat(0.0));
+                llvm::Constant *pi = llvm::ConstantFP::get(m_ctx, llvm::APFloat(std::acos(-1.0)));
+                llvm::Constant *piDeg = llvm::ConstantFP::get(m_ctx, llvm::APFloat(180.0));
+                llvm::Constant *factor = llvm::ConstantFP::get(m_ctx, llvm::APFloat(1e10));
+                llvm::Function *sinFunc = llvm::Intrinsic::getDeclaration(m_module.get(), llvm::Intrinsic::sin, m_builder.getDoubleTy());
+                llvm::Function *roundFunc = llvm::Intrinsic::getDeclaration(m_module.get(), llvm::Intrinsic::round, m_builder.getDoubleTy());
+                llvm::Value *num = removeNaN(castValue(arg.second, arg.first));
+                llvm::Value *sinResult = m_builder.CreateCall(sinFunc, m_builder.CreateFDiv(m_builder.CreateFMul(num, pi), piDeg)); // sin(x * pi / 180)
+                llvm::Value *rounded = m_builder.CreateCall(roundFunc, m_builder.CreateFMul(sinResult, factor));                    // round(sin(x * 180) * 1e10)
+                step.functionReturnReg->value = m_builder.CreateFAdd(m_builder.CreateFDiv(rounded, factor), zero);
+                break;
+            }
+
             case Step::Type::Yield:
                 if (!m_warp) {
                     freeHeap();
@@ -648,6 +666,11 @@ void LLVMCodeBuilder::createSqrt()
     createOp(Step::Type::Sqrt, Compiler::StaticType::Number, Compiler::StaticType::Number, 1);
 }
 
+void LLVMCodeBuilder::createSin()
+{
+    createOp(Step::Type::Sin, Compiler::StaticType::Number, Compiler::StaticType::Number, 1);
+}
+
 void LLVMCodeBuilder::beginIfStatement()
 {
     Step step(Step::Type::BeginIf);

src/dev/engine/internal/llvmcodebuilder.h

@@ -45,6 +45,7 @@ class LLVMCodeBuilder : public ICodeBuilder
         void createFloor() override;
         void createCeil() override;
         void createSqrt() override;
+        void createSin() override;
 
         void beginIfStatement() override;
         void beginElseBranch() override;
@@ -94,6 +95,7 @@ class LLVMCodeBuilder : public ICodeBuilder
                     Floor,
                     Ceil,
                     Sqrt,
+                    Sin,
                     Yield,
                     BeginIf,
                     BeginElse,

test/dev/llvm/llvmcodebuilder_test.cpp

@@ -1322,6 +1322,53 @@ TEST_F(LLVMCodeBuilderTest, Sqrt)
     addOpTest(nan, 0);
 }
 
+TEST_F(LLVMCodeBuilderTest, Sin)
+{
+    std::string expected;
+
+    auto addOpTest = [this, &expected](Value v1, double expectedResult) {
+        createBuilder(true);
+
+        m_builder->addConstValue(v1);
+        m_builder->createSin();
+        m_builder->addFunctionCall("test_print_number", Compiler::StaticType::Void, { Compiler::StaticType::Number });
+
+        m_builder->addConstValue(v1);
+        m_builder->addFunctionCall("test_const_number", Compiler::StaticType::Number, { Compiler::StaticType::Number });
+        m_builder->createSin();
+        m_builder->addFunctionCall("test_print_number", Compiler::StaticType::Void, { Compiler::StaticType::Number });
+
+        std::stringstream stream;
+        stream << expectedResult;
+        std::string str = stream.str() + '\n';
+        std::string expected = str + str;
+
+        auto code = m_builder->finalize();
+        auto ctx = code->createExecutionContext(&m_target);
+
+        testing::internal::CaptureStdout();
+        code->run(ctx.get());
+        const std::string quotes1 = v1.isString() ? "\"" : "";
+        ASSERT_THAT(testing::internal::GetCapturedStdout(), Eq(expected)) << quotes1 << v1.toString() << quotes1;
+    };
+
+    static const double inf = std::numeric_limits<double>::infinity();
+    static const double nan = std::numeric_limits<double>::quiet_NaN();
+
+    addOpTest(30.0, 0.5);
+    addOpTest(90.0, 1.0);
+    addOpTest(2.8e-9, 0.0);
+    addOpTest(2.9e-9, 1e-10);
+    addOpTest(570.0, -0.5);
+    addOpTest(-30.0, -0.5);
+    addOpTest(-90.0, -1.0);
+    addOpTest(0.0, 0.0);
+    addOpTest(-0.0, 0.0);
+    addOpTest(inf, -nan); // negative NaN shouldn't be a problem
+    addOpTest(-inf, -nan);
+    addOpTest(nan, 0);
+}
+
 TEST_F(LLVMCodeBuilderTest, Yield)
 {
     auto build = [this]() {

test/mocks/codebuildermock.h

@@ -33,6 +33,7 @@ class CodeBuilderMock : public ICodeBuilder
         MOCK_METHOD(void, createFloor, (), (override));
         MOCK_METHOD(void, createCeil, (), (override));
         MOCK_METHOD(void, createSqrt, (), (override));
+        MOCK_METHOD(void, createSin, (), (override));
 
         MOCK_METHOD(void, beginIfStatement, (), (override));
         MOCK_METHOD(void, beginElseBranch, (), (override));