[memory-analysis] Added a field to CPPMethod to store memory-ownership information and this information effects kIsCreator flag of overload group , currently analyzer is not called, just attribute checker is called

Author: keremsahn

src/cpyrt/CPPMethod.cxx

@@ -749,6 +749,23 @@ PyObject* cpyrt::CPPMethod::GetArgDefault(int iarg, bool silent) {
 
 bool cpyrt::CPPMethod::IsConst() { return interop::IsConstMethod(GetMethod()); }
 
+//----------------------------------------------------------------------------
+// FIXME: For now every allocation is assumed to be done with `new`
+// will be fixed soon. Also the reason function returns an AllocType
+// instead of bool, IsAllocator function from CppInterOp changed a little,
+// but these changes did not merged to main yet, another reason is next PR
+// will add user-optional analyzer so the function needs to return allocation
+// way
+interop::AllocType cpyrt::CPPMethod::GetAllocBehaviour() {
+  if (fAllocType.has_value())
+    return *fAllocType;
+  if (interop::IsAllocator(GetMethod())) {
+    fAllocType = interop::AllocType::New;
+    return interop::AllocType::New;
+  }
+  fAllocType = interop::AllocType::None;
+  return interop::AllocType::None;
+}
 //----------------------------------------------------------------------------
 PyObject* cpyrt::CPPMethod::GetScopeProxy() {
   // Get or build the scope of this method.

src/cpyrt/CPPMethod.h

@@ -5,6 +5,7 @@
 #include "PyCallable.h"
 
 // Standard
+#include <optional>
 #include <string>
 #include <unordered_map>
 #include <vector>
@@ -63,6 +64,7 @@ class CPPMethod : public PyCallable {
   PyObject* GetCoVarNames() override;
   PyObject* GetArgDefault(int iarg, bool silent = true) override;
   bool IsConst() override;
+  cppjit::interop::AllocType GetAllocBehaviour() override;
 
   PyObject* GetScopeProxy() override;
   cppjit::interop::TCppFuncAddr_t GetFunctionAddress() override;
@@ -117,6 +119,7 @@ class CPPMethod : public PyCallable {
 protected:
   // cached value that doubles as initialized flag (uninitialized if -1)
   int fArgsRequired;
+  std::optional<cppjit::interop::AllocType> fAllocType;
 };
 
 } // namespace cppjit::cpyrt

src/cpyrt/CPPOverload.cxx

@@ -155,6 +155,12 @@ static inline PyObject* HandleReturn(CPPOverload* pymeth, CPPInstance* im_self,
     CPPInstance* cppres =
         (CPPInstance*)(CPPInstance_Check(result) ? result : nullptr);
 
+    interop::AllocType AT =
+        pymeth->fMethodInfo->fMethods[0]->GetAllocBehaviour();
+    if (AT != interop::AllocType::None && AT != interop::AllocType::Null &&
+        AT != interop::AllocType::Unknown)
+      pymeth->fMethodInfo->fFlags |= CallContext::kIsCreator;
+
     // if this method creates new objects, always take ownership
     if (IsCreator(pymeth->fMethodInfo->fFlags)) {
 

src/cpyrt/PyCallable.h

@@ -37,6 +37,9 @@ class PyCallable {
   virtual PyObject* GetCoVarNames() = 0;
   virtual PyObject* GetArgDefault(int /* iarg */, bool silent = true) = 0;
   virtual bool IsConst() { return false; }
+  virtual cppjit::interop::AllocType GetAllocBehaviour() {
+    return cppjit::interop::AllocType::None;
+  }
 
   virtual PyObject* GetScopeProxy() = 0;
   virtual cppjit::interop::TCppFuncAddr_t GetFunctionAddress() = 0;

src/cpyrt/cppjit_interop.h

@@ -92,6 +92,18 @@ struct ObjectRef {
   friend bool operator==(ObjectRef a, ObjectRef b) { return a.data == b.data; }
   friend bool operator!=(ObjectRef a, ObjectRef b) { return !(a == b); }
 };
+
+enum class AllocType : unsigned char {
+  None,
+  New,
+  NewArr,
+  Malloc,
+  Unknown,
+  CustomAlloc,
+  Null,
+  OperatorNew,
+  OperatorNewArr
+};
 } // namespace Cpp
 
 template <> struct std::hash<Cpp::DeclRef> {
@@ -122,6 +134,7 @@ typedef Cpp::ObjectRef TCppObject_t;
 typedef Cpp::FuncRef TCppMethod_t;
 typedef size_t TCppIndex_t;
 typedef void* TCppFuncAddr_t;
+typedef Cpp::AllocType AllocType;
 
 // direct interpreter access -------------------------------------------------
 CPPJIT_IMPORT
@@ -368,6 +381,8 @@ CPPJIT_IMPORT
 std::string GetDoxygenComment(TCppScope_t scope, bool strip_markers = true);
 CPPJIT_IMPORT
 bool IsConstMethod(TCppMethod_t);
+CPPJIT_IMPORT
+bool IsAllocator(TCppMethod_t);
 // Templated method/function reflection information
 // ------------------------------------
 CPPJIT_IMPORT

src/interop/cpp_cppjit.h

@@ -53,6 +53,7 @@ typedef Cpp::FuncRef TCppMethod_t;
 typedef Cpp::InterpRef TInterp_t;
 typedef size_t TCppIndex_t;
 typedef void* TCppFuncAddr_t;
+typedef Cpp::AllocType AllocType;
 
 // direct interpreter access -------------------------------------------------
 RPY_EXPORTED
@@ -306,6 +307,8 @@ RPY_EXPORTED
 std::string GetDoxygenComment(TCppScope_t scope, bool strip_markers = true);
 RPY_EXPORTED
 bool IsConstMethod(TCppMethod_t);
+RPY_EXPORTED
+bool IsAllocator(TCppMethod_t);
 // Templated method/function reflection information
 // ------------------------------------
 RPY_EXPORTED

src/interop/interop_wrapper.cxx

@@ -1184,6 +1184,11 @@ interop::TCppType_t interop::GetMethodReturnType(TCppMethod_t method) {
   return Cpp::GetFunctionReturnType(method);
 }
 
+bool interop::IsAllocator(TCppMethod_t method) {
+  std::lock_guard<std::recursive_mutex> Lock(InterOpMutex);
+  return Cpp::IsAllocator(method);
+}
+
 std::string interop::GetMethodReturnTypeAsString(TCppMethod_t method) {
   std::lock_guard<std::recursive_mutex> Lock(InterOpMutex);
   return Cpp::GetTypeAsString(

test/Makefile

@@ -10,6 +10,7 @@ dictnames = advancedcpp \
             doc_helper \
             example01 \
             fragile \
+            memory_analysis \
             operators \
             overloads \
             pythonizables \

test/cpp/memory_analysis.cxx

@@ -0,0 +1,9 @@
+#include "memory_analysis.h"
+__attribute__((malloc)) memAnalysisKlass* allocTest() {
+  return new memAnalysisKlass;
+}
+
+__attribute__((ownership_returns(malloc))) memAnalysisKlass*
+allocTestReturns() {
+  return new memAnalysisKlass;
+}

test/cpp/memory_analysis.h

@@ -0,0 +1,13 @@
+#ifndef MEMORY_ANALYSIS_H
+#define MEMORY_ANALYSIS_H
+
+#include <new>
+#include <stdlib.h>
+
+class memAnalysisKlass {
+  int val;
+};
+__attribute__((malloc)) memAnalysisKlass* allocTest();
+__attribute__((ownership_returns(malloc))) memAnalysisKlass* allocTestReturns();
+
+#endif // MEMORY_ANALYSIS_H