# HG changeset patch
# User Frits van Bommel <fvbommel wxs.nl>
# Date 1241823015 -7200
# Node ID 4099548c80e094300722547d28f17e05026df7c4
# Parent  8c65217be813f01261c0fa0f18009b9aaa294367
Allocate objects on the stack if they (a) don't have a destructor, and
(b) don't override the delete operator (on top of the regular conditions for
stack allocation that also apply to arrays, structs, etc.).
The "no destructor" clause is not strictly necessary, but calling them at the
right time would be tricky to say the least; it would involve, among other
things, "manually" inserting a try-finally block around anything that might
throw exceptions not caught in the current function.

Note: objects with custom new operators are automatically ignored because they
don't use the regular allocation runtime call, so there's no need to pay special
attention to them.

diff -r 8c65217be813 -r 4099548c80e0 gen/metadata.h
--- a/gen/metadata.h	Fri May 08 16:00:44 2009 +0200
+++ b/gen/metadata.h	Sat May 09 00:50:15 2009 +0200
@@ -25,6 +25,21 @@
     TD_NumFields    /// The number of fields in TypeInfo metadata
 };
 
+
+// *** Metadata for ClassInfo instances ***
+#define CD_PREFIX "llvm.ldc.classinfo."
+
+/// The fields in the metadata node for a ClassInfo instance.
+/// (Its name will be CD_PREFIX ~ <Name of ClassInfo global>)
+enum ClassDataFields {
+    CD_BodyType,    /// A value of the LLVM type corresponding to the class body.
+    CD_Finalize,    /// True if this class (or a base class) has a destructor.
+    CD_CustomDelete,/// True if this class has an overridden delete operator.
+    
+    // Must be kept last
+    CD_NumFields    /// The number of fields in ClassInfo metadata
+};
+
 #endif
 
 #endif
diff -r 8c65217be813 -r 4099548c80e0 gen/passes/GarbageCollect2Stack.cpp
--- a/gen/passes/GarbageCollect2Stack.cpp	Fri May 08 16:00:44 2009 +0200
+++ b/gen/passes/GarbageCollect2Stack.cpp	Sat May 09 00:50:15 2009 +0200
@@ -180,6 +180,53 @@
             return alloca;
         }
     };
+    
+    // FunctionInfo for _d_allocclass
+    class AllocClassFI : public FunctionInfo {
+        public:
+        virtual bool analyze(CallSite CS, const Analysis& A) {
+            // This call contains no TypeInfo parameter, so don't call the
+            // base class implementation here...
+            if (CS.arg_size() != 1)
+                return false;
+            Value* arg = CS.getArgument(0)->stripPointerCasts();
+            GlobalVariable* ClassInfo = dyn_cast<GlobalVariable>(arg);
+            if (!ClassInfo)
+                return false;
+            
+            std::string metaname = CD_PREFIX;
+            metaname.append(ClassInfo->getNameStart(), ClassInfo->getNameEnd());
+            
+            GlobalVariable* global = A.M.getGlobalVariable(metaname);
+            if (!global || !global->hasInitializer())
+                return false;
+            
+            MDNode* node = dyn_cast<MDNode>(global->getInitializer());
+            if (!node || node->getNumOperands() != CD_NumFields)
+                return false;
+            
+            // Inserting destructor calls is not implemented yet, so classes
+            // with destructors are ignored for now.
+            Constant* hasDestructor = dyn_cast<Constant>(node->getOperand(CD_Finalize));
+            // We can't stack-allocate if the class has a custom deallocator
+            // (Custom allocators don't get turned into this runtime call, so
+            // those can be ignored)
+            Constant* hasCustomDelete = dyn_cast<Constant>(node->getOperand(CD_CustomDelete));
+            if (hasDestructor == NULL || hasCustomDelete == NULL)
+                return false;
+            
+            if (ConstantExpr::getOr(hasDestructor, hasCustomDelete)
+                    != ConstantInt::getFalse())
+                return false;
+            
+            Ty = node->getOperand(CD_BodyType)->getType();
+            return true;
+        }
+        
+        // The default promote() should be fine.
+        
+        AllocClassFI() : FunctionInfo(-1, true) {}
+    };
 }
 
 
@@ -197,6 +244,7 @@
         FunctionInfo AllocMemoryT;
         ArrayFI NewArrayVT;
         ArrayFI NewArrayT;
+        AllocClassFI AllocClass;
         
     public:
         static char ID; // Pass identification
@@ -233,6 +281,7 @@
     KnownFunctions["_d_allocmemoryT"] = &AllocMemoryT;
     KnownFunctions["_d_newarrayvT"] = &NewArrayVT;
     KnownFunctions["_d_newarrayT"] = &NewArrayT;
+    KnownFunctions["_d_allocclass"] = &AllocClass;
 }
 
 static void RemoveCall(Instruction* Inst) {
diff -r 8c65217be813 -r 4099548c80e0 ir/irclass.cpp
--- a/ir/irclass.cpp	Fri May 08 16:00:44 2009 +0200
+++ b/ir/irclass.cpp	Sat May 09 00:50:15 2009 +0200
@@ -11,6 +11,7 @@
 #include "gen/llvmhelpers.h"
 #include "gen/utils.h"
 #include "gen/arrays.h"
+#include "gen/metadata.h"
 
 #include "ir/irstruct.h"
 #include "ir/irtypeclass.h"
@@ -70,6 +71,29 @@
     classInfo = new llvm::GlobalVariable(
         tc->getPA().get(), false, _linkage, NULL, initname, gIR->module);
 
+#ifdef USE_METADATA
+    // Generate some metadata on this ClassInfo if it's for a class.
+    
+    ClassDeclaration* classdecl = aggrdecl->isClassDeclaration();
+    if (classdecl && !aggrdecl->isInterfaceDeclaration()) {
+        // Gather information
+        const LLType* type = DtoType(aggrdecl->type);
+        const LLType* bodyType = llvm::cast<LLPointerType>(type)->getElementType();
+        bool hasDestructor = (classdecl->dtor != NULL);
+        bool hasCustomDelete = (classdecl->aggDelete != NULL);
+        // Construct the fields
+        LLConstant* mdVals[CD_NumFields];
+        mdVals[CD_BodyType] = llvm::UndefValue::get(bodyType);
+        mdVals[CD_Finalize] = LLConstantInt::get(LLType::Int1Ty, hasDestructor);
+        mdVals[CD_CustomDelete] = LLConstantInt::get(LLType::Int1Ty, hasCustomDelete);
+        // Construct the metadata
+        llvm::MDNode* metadata = llvm::MDNode::get(mdVals, CD_NumFields);
+        // Insert it into the module
+        new llvm::GlobalVariable(metadata->getType(), true,
+            METADATA_LINKAGE_TYPE, metadata, CD_PREFIX + initname, gIR->module);
+    }
+#endif
+
     return classInfo;
 }