BsMonoAssembly.cpp 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. #include "BsMonoAssembly.h"
  2. #include "BsMonoClass.h"
  3. #include "BsMonoManager.h"
  4. #include "BsMonoUtil.h"
  5. #include "BsFileSystem.h"
  6. #include "BsDataStream.h"
  7. #include "BsException.h"
  8. #include <mono/metadata/debug-helpers.h>
  9. #include <mono/metadata/tokentype.h>
  10. #include <mono/metadata/mono-debug.h>
  11. namespace BansheeEngine
  12. {
  13. inline size_t MonoAssembly::ClassId::Hash::operator()(const MonoAssembly::ClassId& v) const
  14. {
  15. size_t genInstanceAddr = (size_t)v.genericInstance;
  16. size_t seed = 0;
  17. hash_combine(seed, v.namespaceName);
  18. hash_combine(seed, v.name);
  19. hash_combine(seed, genInstanceAddr);
  20. return seed;
  21. }
  22. inline bool MonoAssembly::ClassId::Equals::operator()(const MonoAssembly::ClassId& a, const MonoAssembly::ClassId& b) const
  23. {
  24. return a.name == b.name && a.namespaceName == b.namespaceName && a.genericInstance == b.genericInstance;
  25. }
  26. MonoAssembly::ClassId::ClassId(const String& namespaceName, String name, ::MonoClass* genericInstance)
  27. :namespaceName(namespaceName), name(name), genericInstance(genericInstance)
  28. {
  29. }
  30. MonoAssembly::MonoAssembly(const String& path, const String& name)
  31. :mIsLoaded(false), mMonoImage(nullptr), mMonoAssembly(nullptr), mIsDependency(false), mHaveCachedClassList(false),
  32. mPath(path), mName(name)
  33. {
  34. }
  35. MonoAssembly::~MonoAssembly()
  36. {
  37. unload();
  38. }
  39. void MonoAssembly::load(MonoDomain* domain)
  40. {
  41. if (mIsLoaded)
  42. unload();
  43. // Load assembly from memory because mono_domain_assembly_open keeps a lock on the file
  44. DataStreamPtr assemblyStream = FileSystem::openFile(mPath, true);
  45. if (assemblyStream == nullptr)
  46. {
  47. LOGERR("Cannot load assembly at path \"" + mPath + "\" because the file doesn't exist");
  48. return;
  49. }
  50. UINT32 assemblySize = (UINT32)assemblyStream->size();
  51. char* assemblyData = (char*)bs_stack_alloc(assemblySize);
  52. assemblyStream->read(assemblyData, assemblySize);
  53. MonoImageOpenStatus status;
  54. MonoImage* image = mono_image_open_from_data_with_name(assemblyData, assemblySize, true, &status, false, mPath.c_str());
  55. bs_stack_free(assemblyData);
  56. if (status != MONO_IMAGE_OK || image == nullptr)
  57. {
  58. LOGERR("Failed loading image data for assembly \"" + mPath + "\"");
  59. return;
  60. }
  61. // Load MDB file
  62. Path mdbPath = mPath + ".mdb";
  63. if (FileSystem::exists(mdbPath))
  64. {
  65. DataStreamPtr mdbStream = FileSystem::openFile(mdbPath, true);
  66. if (mdbStream != nullptr)
  67. {
  68. UINT32 mdbSize = (UINT32)mdbStream->size();
  69. mono_byte* mdbData = (mono_byte*)bs_stack_alloc(mdbSize);
  70. mdbStream->read(mdbData, mdbSize);
  71. mono_debug_open_image_from_memory(image, mdbData, mdbSize);
  72. bs_stack_free(mdbData);
  73. }
  74. }
  75. mMonoAssembly = mono_assembly_load_from_full(image, mPath.c_str(), &status, false);
  76. if (status != MONO_IMAGE_OK || mMonoAssembly == nullptr)
  77. {
  78. LOGERR("Failed loading assembly \"" + mPath + "\"");
  79. return;
  80. }
  81. mMonoImage = image;
  82. if(mMonoImage == nullptr)
  83. {
  84. BS_EXCEPT(InvalidParametersException, "Cannot get script assembly image.");
  85. }
  86. mono_jit_exec(domain, mMonoAssembly, 0, nullptr);
  87. mIsLoaded = true;
  88. mIsDependency = false;
  89. }
  90. void MonoAssembly::loadFromImage(MonoImage* image)
  91. {
  92. ::MonoAssembly* monoAssembly = mono_image_get_assembly(image);
  93. if(monoAssembly == nullptr)
  94. {
  95. BS_EXCEPT(InvalidParametersException, "Cannot get assembly from image.");
  96. }
  97. mMonoAssembly = monoAssembly;
  98. mMonoImage = image;
  99. mIsLoaded = true;
  100. mIsDependency = true;
  101. }
  102. void MonoAssembly::unload()
  103. {
  104. if(!mIsLoaded)
  105. return;
  106. for(auto& entry : mClassesByRaw)
  107. bs_delete(entry.second);
  108. mClasses.clear();
  109. mClassesByRaw.clear();
  110. mCachedClassList.clear();
  111. if(mMonoImage != nullptr && !mIsDependency)
  112. {
  113. // Note: I used to call mono_image_close and mono_assembly_close here but those
  114. // didn't seem to be necessary and were just crashing the program.
  115. mMonoImage = nullptr;
  116. }
  117. mIsLoaded = false;
  118. mIsDependency = false;
  119. mMonoAssembly = nullptr;
  120. mHaveCachedClassList = false;
  121. }
  122. void MonoAssembly::invoke(const String& functionName)
  123. {
  124. MonoMethodDesc* methodDesc = mono_method_desc_new(functionName.c_str(), false);
  125. if(methodDesc != nullptr)
  126. {
  127. ::MonoMethod* entry = mono_method_desc_search_in_image(methodDesc, mMonoImage);
  128. if(entry != nullptr)
  129. {
  130. MonoObject* exception = nullptr;
  131. mono_runtime_invoke(entry, nullptr, nullptr, &exception);
  132. MonoUtil::throwIfException(exception);
  133. }
  134. }
  135. }
  136. MonoClass* MonoAssembly::getClass(const String& namespaceName, const String& name) const
  137. {
  138. if(!mIsLoaded)
  139. BS_EXCEPT(InvalidStateException, "Trying to use an unloaded assembly.");
  140. MonoAssembly::ClassId classId(namespaceName, name);
  141. auto iterFind = mClasses.find(classId);
  142. if(iterFind != mClasses.end())
  143. return iterFind->second;
  144. ::MonoClass* monoClass = mono_class_from_name(mMonoImage, namespaceName.c_str(), name.c_str());
  145. if(monoClass == nullptr)
  146. return nullptr;
  147. MonoClass* newClass = new (bs_alloc<MonoClass>()) MonoClass(namespaceName, name, monoClass, this);
  148. mClasses[classId] = newClass;
  149. mClassesByRaw[monoClass] = newClass;
  150. return newClass;
  151. }
  152. MonoClass* MonoAssembly::getClass(::MonoClass* rawMonoClass) const
  153. {
  154. if(!mIsLoaded)
  155. BS_EXCEPT(InvalidStateException, "Trying to use an unloaded assembly.");
  156. if(rawMonoClass == nullptr)
  157. return nullptr;
  158. auto iterFind = mClassesByRaw.find(rawMonoClass);
  159. if(iterFind != mClassesByRaw.end())
  160. return iterFind->second;
  161. String ns;
  162. String typeName;
  163. MonoUtil::getClassName(rawMonoClass, ns, typeName);
  164. MonoClass* newClass = new (bs_alloc<MonoClass>()) MonoClass(ns, typeName, rawMonoClass, this);
  165. mClassesByRaw[rawMonoClass] = newClass;
  166. if(!isGenericClass(typeName)) // No point in referencing generic types by name as all instances share it
  167. {
  168. MonoAssembly::ClassId classId(ns, typeName);
  169. mClasses[classId] = newClass;
  170. }
  171. return newClass;
  172. }
  173. MonoClass* MonoAssembly::getClass(const String& ns, const String& typeName, ::MonoClass* rawMonoClass) const
  174. {
  175. if (!mIsLoaded)
  176. BS_EXCEPT(InvalidStateException, "Trying to use an unloaded assembly.");
  177. if (rawMonoClass == nullptr)
  178. return nullptr;
  179. auto iterFind = mClassesByRaw.find(rawMonoClass);
  180. if (iterFind != mClassesByRaw.end())
  181. return iterFind->second;
  182. MonoClass* newClass = new (bs_alloc<MonoClass>()) MonoClass(ns, typeName, rawMonoClass, this);
  183. mClassesByRaw[rawMonoClass] = newClass;
  184. if (!isGenericClass(typeName)) // No point in referencing generic types by name as all instances share it
  185. {
  186. MonoAssembly::ClassId classId(ns, typeName);
  187. mClasses[classId] = newClass;
  188. }
  189. return newClass;
  190. }
  191. const Vector<MonoClass*>& MonoAssembly::getAllClasses() const
  192. {
  193. if(mHaveCachedClassList)
  194. return mCachedClassList;
  195. mCachedClassList.clear();
  196. Stack<MonoClass*> todo;
  197. int numRows = mono_image_get_table_rows (mMonoImage, MONO_TABLE_TYPEDEF);
  198. for(int i = 1; i < numRows; i++) // Skip Module
  199. {
  200. ::MonoClass* monoClass = mono_class_get (mMonoImage, (i + 1) | MONO_TOKEN_TYPE_DEF);
  201. String ns;
  202. String type;
  203. MonoUtil::getClassName(monoClass, ns, type);
  204. MonoClass* curClass = getClass(ns, type);
  205. if (curClass != nullptr)
  206. {
  207. // Get nested types if it has any
  208. todo.push(curClass);
  209. while (!todo.empty())
  210. {
  211. MonoClass* curNestedClass = todo.top();
  212. todo.pop();
  213. void* iter = nullptr;
  214. do
  215. {
  216. ::MonoClass* rawNestedClass = rawNestedClass = mono_class_get_nested_types(curNestedClass->_getInternalClass(), &iter);
  217. if (rawNestedClass == nullptr)
  218. break;
  219. String nestedType = curNestedClass->getTypeName() + "+" + mono_class_get_name(rawNestedClass);
  220. MonoClass* nestedClass = getClass(ns, nestedType, rawNestedClass);
  221. if (nestedClass != nullptr)
  222. {
  223. mCachedClassList.push_back(nestedClass);
  224. todo.push(nestedClass);
  225. }
  226. } while (true);
  227. }
  228. mCachedClassList.push_back(curClass);
  229. }
  230. }
  231. mHaveCachedClassList = true;
  232. return mCachedClassList;
  233. }
  234. bool MonoAssembly::isGenericClass(const String& name) const
  235. {
  236. // By CIL convention generic classes have ` separating their name and
  237. // number of generic parameters
  238. auto iterFind = std::find(name.rbegin(), name.rend(), '`');
  239. return iterFind != name.rend();
  240. }
  241. }