MemoryMappedFile.cpp 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  1. #include "il2cpp-config.h"
  2. #if !IL2CPP_USE_GENERIC_MEMORY_MAPPED_FILE && IL2CPP_TARGET_POSIX && !RUNTIME_TINY
  3. #include <sys/mman.h>
  4. #include <map>
  5. #include "os/File.h"
  6. #include "os/MemoryMappedFile.h"
  7. #include "os/Mutex.h"
  8. #include "utils/Memory.h"
  9. #include "FileHandle.h"
  10. #include <unistd.h>
  11. #include <fcntl.h>
  12. #ifdef DEFFILEMODE
  13. #define DEFAULT_FILEMODE DEFFILEMODE
  14. #else
  15. #define DEFAULT_FILEMODE 0666
  16. #endif
  17. #ifndef MAP_32BIT
  18. #define MAP_32BIT 0
  19. #endif
  20. namespace il2cpp
  21. {
  22. namespace os
  23. {
  24. enum MemoryMappedFileFlags
  25. {
  26. /* protection */
  27. MONO_MMAP_NONE = 0,
  28. MONO_MMAP_READ = 1 << 0,
  29. MONO_MMAP_WRITE = 1 << 1,
  30. MONO_MMAP_EXEC = 1 << 2,
  31. /* make the OS discard the dirty data and fill with 0 */
  32. MONO_MMAP_DISCARD = 1 << 3,
  33. /* other flags (add commit, sync) */
  34. MONO_MMAP_PRIVATE = 1 << 4,
  35. MONO_MMAP_SHARED = 1 << 5,
  36. MONO_MMAP_ANON = 1 << 6,
  37. MONO_MMAP_FIXED = 1 << 7,
  38. MONO_MMAP_32BIT = 1 << 8
  39. };
  40. static bool IsSpecialZeroSizeFile(struct stat *buf)
  41. {
  42. return buf->st_size == 0 && (buf->st_mode & (S_IFCHR | S_IFBLK | S_IFIFO | S_IFSOCK)) != 0;
  43. }
  44. static int64_t GetPageSize()
  45. {
  46. static int64_t page_size = getpagesize();
  47. return page_size;
  48. }
  49. static int64_t AlignUpToPageSize(int64_t size)
  50. {
  51. const int64_t page_size = GetPageSize();
  52. return (size + page_size - 1) & ~(page_size - 1);
  53. }
  54. static int64_t AlignDownToPageSize(int64_t size)
  55. {
  56. const int64_t page_size = GetPageSize();
  57. return size & ~(page_size - 1);
  58. }
  59. static int ConvertAccessToMemoryMappedFileFlags(int access)
  60. {
  61. switch (access)
  62. {
  63. case MMAP_FILE_ACCESS_READ_WRITE:
  64. return MONO_MMAP_WRITE | MONO_MMAP_READ | MONO_MMAP_SHARED;
  65. case MMAP_FILE_ACCESS_WRITE:
  66. return MONO_MMAP_WRITE | MONO_MMAP_SHARED;
  67. case MMAP_FILE_ACCESS_COPY_ON_WRITE:
  68. return MONO_MMAP_WRITE | MONO_MMAP_READ | MONO_MMAP_PRIVATE;
  69. case MMAP_FILE_ACCESS_READ_EXECUTE:
  70. return MONO_MMAP_EXEC | MONO_MMAP_PRIVATE | MONO_MMAP_SHARED;
  71. case MMAP_FILE_ACCESS_READ_WRITE_EXECUTE:
  72. return MONO_MMAP_WRITE | MONO_MMAP_READ | MONO_MMAP_EXEC | MONO_MMAP_SHARED;
  73. case MMAP_FILE_ACCESS_READ:
  74. return MONO_MMAP_READ | MONO_MMAP_SHARED;
  75. default:
  76. IL2CPP_ASSERT("unknown MemoryMappedFileAccess");
  77. }
  78. return 0;
  79. }
  80. static int ConvertFileModeToUnix(int mode)
  81. {
  82. switch (mode)
  83. {
  84. case FILE_MODE_CREATE_NEW:
  85. return O_CREAT | O_EXCL;
  86. case FILE_MODE_CREATE:
  87. return O_CREAT | O_TRUNC;
  88. case FILE_MODE_OPEN:
  89. return 0;
  90. case FILE_MODE_OPEN_OR_CREATE:
  91. return O_CREAT;
  92. case FILE_MODE_TRUNCATE:
  93. return O_TRUNC;
  94. case FILE_MODE_APPEND:
  95. return O_APPEND;
  96. default:
  97. IL2CPP_ASSERT("unknown FileMode");
  98. }
  99. return 0;
  100. }
  101. static int ConvertAccessModeToUnix(int access)
  102. {
  103. switch (access)
  104. {
  105. case MMAP_FILE_ACCESS_READ_WRITE:
  106. case MMAP_FILE_ACCESS_COPY_ON_WRITE:
  107. case MMAP_FILE_ACCESS_READ_WRITE_EXECUTE:
  108. return O_RDWR;
  109. case MMAP_FILE_ACCESS_READ:
  110. case MMAP_FILE_ACCESS_READ_EXECUTE:
  111. return O_RDONLY;
  112. case MMAP_FILE_ACCESS_WRITE:
  113. return O_WRONLY;
  114. default:
  115. IL2CPP_ASSERT("unknown MemoryMappedFileAccess");
  116. }
  117. return 0;
  118. }
  119. static int ConvertFlagsToProt(int flags)
  120. {
  121. int prot = PROT_NONE;
  122. /* translate the protection bits */
  123. if (flags & MONO_MMAP_READ)
  124. prot |= PROT_READ;
  125. if (flags & MONO_MMAP_WRITE)
  126. prot |= PROT_WRITE;
  127. if (flags & MONO_MMAP_EXEC)
  128. prot |= PROT_EXEC;
  129. return prot;
  130. }
  131. FileHandle* MemoryMappedFile::Create(FileHandle* file, const char* mapName, int32_t mode, int64_t *capacity, MemoryMappedFileAccess access, int32_t options, MemoryMappedFileError* error)
  132. {
  133. struct stat buf;
  134. int result, fd;
  135. if (file != NULL)
  136. result = fstat(file->fd, &buf);
  137. else
  138. result = stat(mapName, &buf);
  139. if (mode == FILE_MODE_TRUNCATE || mode == FILE_MODE_APPEND || mode == FILE_MODE_OPEN)
  140. {
  141. if (result == -1)
  142. {
  143. if (error != NULL)
  144. *error = FILE_NOT_FOUND;
  145. return NULL;
  146. }
  147. }
  148. if (mode == FILE_MODE_CREATE_NEW && result == 0)
  149. {
  150. if (error != NULL)
  151. *error = FILE_ALREADY_EXISTS;
  152. return NULL;
  153. }
  154. if (result == 0)
  155. {
  156. if (*capacity == 0)
  157. {
  158. /**
  159. * Special files such as FIFOs, sockets, and devices can have a size of 0. Specifying a capacity for these
  160. * also makes little sense, so don't do the check if th file is one of these.
  161. */
  162. if (buf.st_size == 0 && !IsSpecialZeroSizeFile(&buf))
  163. {
  164. if (error != NULL)
  165. *error = CAPACITY_SMALLER_THAN_FILE_SIZE;
  166. return NULL;
  167. }
  168. *capacity = buf.st_size;
  169. }
  170. else if (*capacity < buf.st_size)
  171. {
  172. if (error != NULL)
  173. *error = CAPACITY_SMALLER_THAN_FILE_SIZE;
  174. return NULL;
  175. }
  176. }
  177. else
  178. {
  179. if (mode == FILE_MODE_CREATE_NEW && *capacity == 0)
  180. {
  181. if (error != NULL)
  182. *error = CAPACITY_SMALLER_THAN_FILE_SIZE;
  183. return NULL;
  184. }
  185. }
  186. bool ownsFd = true;
  187. if (file != NULL)
  188. {
  189. #if IL2CPP_HAS_DUP
  190. fd = dup(file->fd);
  191. #else
  192. fd = file->fd;
  193. ownsFd = false;
  194. #endif
  195. }
  196. else
  197. {
  198. fd = open(mapName, ConvertFileModeToUnix(mode) | ConvertAccessModeToUnix(access), DEFAULT_FILEMODE);
  199. }
  200. if (fd == -1)
  201. {
  202. if (error != NULL)
  203. *error = COULD_NOT_OPEN;
  204. return NULL;
  205. }
  206. if (result != 0 || *capacity > buf.st_size)
  207. {
  208. int result = ftruncate(fd, (off_t)*capacity);
  209. IL2CPP_ASSERT(result == 0);
  210. NO_UNUSED_WARNING(result);
  211. }
  212. if (ownsFd)
  213. {
  214. FileHandle* handle = new FileHandle;
  215. handle->fd = fd;
  216. handle->doesNotOwnFd = !ownsFd;
  217. return handle;
  218. }
  219. else
  220. {
  221. file->doesNotOwnFd = true;
  222. return file;
  223. }
  224. }
  225. MemoryMappedFile::MemoryMappedFileHandle MemoryMappedFile::View(FileHandle* mappedFileHandle, int64_t* length, int64_t offset, MemoryMappedFileAccess access, int64_t* actualOffset, MemoryMappedFileError* error)
  226. {
  227. IL2CPP_ASSERT(actualOffset != NULL);
  228. int64_t mmap_offset = 0;
  229. int64_t eff_size = *length;
  230. struct stat buf = { 0 };
  231. fstat(mappedFileHandle->fd, &buf);
  232. if (offset > buf.st_size || ((eff_size + offset) > buf.st_size && !IsSpecialZeroSizeFile(&buf)))
  233. {
  234. if (error != NULL)
  235. *error = ACCESS_DENIED;
  236. return NULL;
  237. }
  238. /**
  239. * We use the file size if one of the following conditions is true:
  240. * -input size is zero
  241. * -input size is bigger than the file and the file is not a magical zero size file such as /dev/mem.
  242. */
  243. if (eff_size == 0)
  244. eff_size = AlignUpToPageSize(buf.st_size) - offset;
  245. mmap_offset = AlignDownToPageSize(offset);
  246. eff_size += (offset - mmap_offset);
  247. *length = eff_size;
  248. *actualOffset = mmap_offset;
  249. int flags = ConvertAccessToMemoryMappedFileFlags(access);
  250. int prot = ConvertFlagsToProt(flags);
  251. /* translate the flags */
  252. int mflags = 0;
  253. if (flags & MONO_MMAP_PRIVATE)
  254. mflags |= MAP_PRIVATE;
  255. if (flags & MONO_MMAP_SHARED)
  256. mflags |= MAP_SHARED;
  257. if (flags & MONO_MMAP_FIXED)
  258. mflags |= MAP_FIXED;
  259. if (flags & MONO_MMAP_32BIT)
  260. mflags |= MAP_32BIT;
  261. void* address = mmap(NULL, eff_size, prot, mflags, mappedFileHandle->fd, mmap_offset);
  262. if (address == MAP_FAILED)
  263. {
  264. if (error != NULL)
  265. *error = COULD_NOT_MAP_MEMORY;
  266. return NULL;
  267. }
  268. return address;
  269. }
  270. void MemoryMappedFile::Flush(MemoryMappedFileHandle memoryMappedFileData, int64_t length)
  271. {
  272. if (memoryMappedFileData != NULL)
  273. {
  274. int error = msync(memoryMappedFileData, length, MS_SYNC);
  275. IL2CPP_ASSERT(error == 0);
  276. NO_UNUSED_WARNING(error);
  277. }
  278. }
  279. bool MemoryMappedFile::UnmapView(MemoryMappedFileHandle memoryMappedFileData, int64_t length)
  280. {
  281. int error = munmap(memoryMappedFileData, (size_t)length);
  282. return error == 0;
  283. }
  284. bool MemoryMappedFile::Close(FileHandle* file)
  285. {
  286. bool result = true;
  287. if (!file->doesNotOwnFd)
  288. {
  289. int error = 0;
  290. os::File::Close(file, &error);
  291. if (error != 0)
  292. result = false;
  293. }
  294. return result;
  295. }
  296. void MemoryMappedFile::ConfigureHandleInheritability(FileHandle* file, bool inheritability)
  297. {
  298. #if IL2CPP_HAS_CLOSE_EXEC
  299. int flags = fcntl(file->fd, F_GETFD, 0);
  300. if (inheritability)
  301. flags &= ~FD_CLOEXEC;
  302. else
  303. flags |= FD_CLOEXEC;
  304. int result = fcntl(file->fd, F_SETFD, flags);
  305. IL2CPP_ASSERT(result != -1);
  306. NO_UNUSED_WARNING(result);
  307. #endif
  308. }
  309. bool MemoryMappedFile::OwnsDuplicatedFileHandle(FileHandle* file)
  310. {
  311. return !file->doesNotOwnFd;
  312. }
  313. }
  314. }
  315. #endif