2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <pkgmgr-info.h>
18 #include <pkgmgr_installer_info.h>
23 #include "pkgmgr_parser_plugin_interface.h"
29 #include <sys/resource.h>
43 #include "ni_common.h"
44 #include "db_manager.h"
45 #include "tac_common.h"
46 #include "path_manager.h"
47 #include "plugin_manager.h"
48 #include "r2r_checker.h"
53 #define LOG_TAG "DOTNET_INSTALLER_PLUGIN"
56 #define __STR(x) __XSTR(x)
57 #if defined(__arm__) || defined(__aarch64__)
58 static const char* __NATIVE_LIB_DIR = __STR(NATIVE_LIB_DIR);
60 static const char* __DOTNET_DIR = __STR(DOTNET_DIR);
61 static const char* __READ_ONLY_APP_UPDATE_DIR = __STR(READ_ONLY_APP_UPDATE_DIR);
63 #ifdef UNIQUE_DEFAULT_BASE_ADDR_SUPPORT
64 static const char* __SYSTEM_BASE_FILE = __STR(SYSTEM_BASE_FILE);
70 static std::string CORERUN_CMD = "/usr/share/dotnet.tizen/netcoreapp/corerun";
71 static std::string CROSSGEN2_PATH = "/usr/share/dotnet.tizen/netcoreapp/crossgen2/crossgen2.dll";
72 static std::string CLRJIT_PATH = "/usr/share/dotnet.tizen/netcoreapp/libclrjit.so";
73 static const char* CROSSGEN_OPT_JITPATH = "--jitpath";
74 static const char* CROSSGEN_OPT_TARGET_ARCH = "--targetarch";
75 static const char* CROSSGEN_OPT_OUT_NEAR_INPUT = "--out-near-input";
76 static const char* CROSSGEN_OPT_SINGLE_FILE_COMPILATION = "--single-file-compilation";
77 //static const char* CROSSGEN_OPT_PARALLELISM = "--parallelism";
78 //static const char* CROSSGEN_OPT_PARALLELISM_COUNT = "5";
79 static const char* CROSSGEN_OPT_RESILIENT = "--resilient";
80 //static const char* CROSSGEN_OPT_OPTIMIZE = "-O";
81 static const char* CROSSGEN_OPT_OPTIMIZE_TIME = "--Ot";
82 static const char* CROSSGEN_OPT_INPUTBUBBLE = "--inputbubble";
83 static const char* CROSSGEN_OPT_COMPILE_BUBBLE_GENERICS = "--compilebubblegenerics";
84 static const char* CROSSGEN_OPT_VERBOSE = "--verbose";
85 static std::vector<std::string> REF_VECTOR;
86 static std::vector<std::string> INPUTBUBBLE_REF_VECTOR;
87 static std::vector<std::string> MIBC_VECTOR;
89 static int __interval = 0;
90 static PathManager* __pm = nullptr;
92 static NIOption* __ni_option = nullptr;
95 NIOption* getNIOption()
97 if (__ni_option == nullptr) {
98 __ni_option = (NIOption*)calloc(sizeof(NIOption), 1);
99 if (__ni_option == nullptr) {
100 _SERR("Fail to create NIOption");
106 static void waitInterval()
108 // by the recommand, ignore small value for performance.
109 if (__interval > 10000) {
110 _SOUT("sleep %d usec", __interval);
115 #ifdef UNIQUE_DEFAULT_BASE_ADDR_SUPPORT
116 // Get next base address to be used for system ni image from file
117 // __SYSTEM_BASE_FILE should be checked for existance before calling this function
118 static uintptr_t getNextBaseAddrFromFile()
120 FILE *pFile = fopen(__SYSTEM_BASE_FILE, "r");
122 _SERR("Failed to open %s", __SYSTEM_BASE_FILE);
129 while (fscanf(pFile, "%" SCNxPTR " %" SCNuPTR "", &addr, &size) != EOF) {
137 // Get next base address to be used for system ni image
138 static uintptr_t getNextBaseAddr()
140 uintptr_t baseAddr = 0;
142 if (!isFile(__SYSTEM_BASE_FILE)) {
143 // This is the starting address for all default base addresses
144 baseAddr = DEFAULT_BASE_ADDR_START;
146 baseAddr = getNextBaseAddrFromFile();
148 // Round to a multple of 64K (see ZapImage::CalculateZapBaseAddress in CoreCLR)
149 uintptr_t BASE_ADDRESS_ALIGNMENT = 0xffff;
150 baseAddr = (baseAddr + BASE_ADDRESS_ALIGNMENT) & ~BASE_ADDRESS_ALIGNMENT;
156 // Save base address of system ni image to file
157 static void updateBaseAddrFile(const std::string& absNIPath, uintptr_t baseAddr)
159 uintptr_t niSize = getSizeOfImage(absNIPath);
161 _SERR("File %s doesn't exist", absNIPath.c_str());
165 // Write new entry to the file
166 FILE *pFile = fopen(__SYSTEM_BASE_FILE, "a");
168 _SERR("Failed to open %s", __SYSTEM_BASE_FILE);
172 fprintf(pFile, "%" PRIxPTR " %" PRIuPTR "\n", baseAddr, niSize);
176 // check if dll is listed in TPA
177 static bool isTPADll(const std::string& dllPath)
179 std::string absPath = getBaseName(getAbsolutePath(dllPath));
181 std::vector<std::string> paths = __pm->getPlatformAssembliesPaths();
182 for (unsigned int i = 0; i < paths.size(); i++) {
183 if (paths[i].find(getBaseName(absPath)) != std::string::npos) {
193 * @brief create the directory including parents directory, and
194 * copy ownership and smack labels to the created directory.
195 * @param[in] target directory path
196 * @param[in] source directory path to get ownership and smack label
197 * @return if directory created successfully, return true otherwise false
199 static bool createDirsAndCopyOwnerShip(std::string& target_path, const std::string& source)
202 mode_t mode = S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH;
204 for (std::string::iterator iter = target_path.begin(); iter != target_path.end();) {
205 std::string::iterator newIter = std::find(iter, target_path.end(), '/');
206 std::string newPath = std::string(target_path.begin(), newIter);
208 if (!newPath.empty()) {
209 if (stat(newPath.c_str(), &st) != 0) {
210 if (mkdir(newPath.c_str(), mode) != 0 && errno != EEXIST) {
211 _SERR("Fail to create app ni directory (%s)", newPath.c_str());
214 if (!source.empty()) {
215 copySmackAndOwnership(source, newPath);
218 if (!S_ISDIR(st.st_mode)) {
219 _SERR("Fail. path is not a dir (%s)", newPath.c_str());
225 if(newIter != target_path.end()) {
233 static std::string getNIFilePath(const std::string& absDllPath, NIOption* opt)
235 std::string dllPath = absDllPath;
236 std::string fileName = getFileName(absDllPath);
237 if (opt->flags & NI_FLAGS_APPNI) {
238 std::string niDirPath;
239 std::string niTmpDirPath;
240 std::string prevPath;
242 prevPath = getBaseName(absDllPath);
243 niDirPath = concatPath(prevPath, APP_NI_SUB_DIR);
244 niTmpDirPath = concatPath(prevPath, APP_NI_SUB_TMP_DIR);
246 if (opt->flags & NI_FLAGS_APP_UNDER_RO_AREA) {
247 niTmpDirPath = replaceAll(niTmpDirPath, getBaseName(__pm->getAppRootPath()), __READ_ONLY_APP_UPDATE_DIR);
248 niDirPath = replaceAll(niDirPath, getBaseName(__pm->getAppRootPath()), __READ_ONLY_APP_UPDATE_DIR);
249 _INFO("App is installed in RO area. Change NI path to RW area(%s).", niTmpDirPath.c_str());
252 if (!isDirectory(niDirPath)) {
253 if (!createDirsAndCopyOwnerShip(niTmpDirPath, prevPath)) {
254 niTmpDirPath = prevPath;
255 _SERR("fail to create dir (%s)", niTmpDirPath.c_str());
257 dllPath = concatPath(niTmpDirPath, fileName);
259 dllPath = concatPath(niDirPath, fileName);
261 } else if (opt->flags & NI_FLAGS_RESOURCE_NI) {
262 std::string rpkDir = concatPath(__pm->getAppRootPath(), APP_NI_SUB_DIR);
263 dllPath = createDir(rpkDir) ? concatPath(rpkDir, fileName) : concatPath(__pm->getAppRootPath(), fileName);
266 size_t index = dllPath.find_last_of(".");
267 if (index == std::string::npos) {
268 _SERR("File doesnot contain extension. fail to get NI file name");
271 std::string fName = dllPath.substr(0, index);
272 std::string fExt = dllPath.substr(index, dllPath.length());
274 // crossgen generate file with lower case extension only
275 std::transform(fExt.begin(), fExt.end(), fExt.begin(), ::tolower);
276 std::string niPath = fName + ".ni" + fExt;
281 static bool checkNIExistence(const std::string& absDllPath, NIOption* opt)
283 std::string absNIPath = getNIFilePath(absDllPath, opt);
284 if (absNIPath.empty()) {
288 if (isFile(absNIPath)) {
292 // native image of System.Private.CoreLib.dll should have to overwrite
293 // original file to support new coreclr
294 if (absDllPath.find("System.Private.CoreLib.dll") != std::string::npos) {
295 return isR2RImage(absDllPath);
301 static bool checkDllExistInDir(const std::string& path)
304 auto func = [&ret](const std::string& f_path, const std::string& f_name) {
305 if (isManagedAssembly(f_name) || isR2RImage(f_name)) {
310 scanFilesInDirectory(path, func, 0);
316 * Get the list of managed files in the specific directory (of Application)
317 * Absolute paths of managed files are stored at the result list.
318 * If native image already exist in the (same / .native_image) directory, managed file is ignored.
320 static ni_error_e getTargetDllList(const std::string& path, std::vector<std::string>& fileList, NIOption *opt)
322 if (!isDirectory(path)) {
323 return NI_ERROR_INVALID_PARAMETER;
326 auto func = [&fileList, opt](const std::string& f_path, const std::string& f_name) {
327 if (isManagedAssembly(f_path) && !checkNIExistence(f_path, opt)) {
328 fileList.push_back(getAbsolutePath(f_path));
332 scanFilesInDirectory(path, func, 0);
334 return NI_ERROR_NONE;
337 static void makeArgs(std::vector<const char*>& args, const std::vector<std::string>& refPaths, NIOption* opt)
339 args.push_back(CORERUN_CMD.c_str());
340 if (CROSSGEN2_PATH != "") {
341 args.push_back(CROSSGEN2_PATH.c_str());
343 args.push_back(CROSSGEN_OPT_JITPATH);
344 args.push_back(CLRJIT_PATH.c_str());
345 args.push_back(CROSSGEN_OPT_TARGET_ARCH);
346 args.push_back(ARCHITECTURE_IDENTIFIER);
348 //args.push_back(OPT_PARALLELISM);
349 //args.push_back(OPT_PARALLELISM_COUNT);
350 args.push_back(CROSSGEN_OPT_RESILIENT);
352 args.push_back(CROSSGEN_OPT_OPTIMIZE_TIME);
354 if (opt->flags & NI_FLAGS_INPUT_BUBBLE) {
355 args.push_back(CROSSGEN_OPT_INPUTBUBBLE);
356 args.push_back(CROSSGEN_OPT_COMPILE_BUBBLE_GENERICS);
358 INPUTBUBBLE_REF_VECTOR.clear();
359 for (const auto &path : opt->inputBubbleRefFiles) {
360 INPUTBUBBLE_REF_VECTOR.push_back("--inputbubbleref:" + path);
362 for (const auto &path : INPUTBUBBLE_REF_VECTOR) {
363 if (find(args.begin(), args.end(), path) == args.end()) {
364 args.push_back(path.c_str());
369 if (opt->flags & NI_FLAGS_MIBC) {
371 for (const auto &path : opt->mibcPath) {
372 MIBC_VECTOR.push_back("--mibc:" + path);
374 for (const auto &path : MIBC_VECTOR) {
375 if (find(args.begin(), args.end(), path) == args.end()) {
376 args.push_back(path.c_str());
381 if (opt->flags & NI_FLAGS_VERBOSE) {
382 args.push_back(CROSSGEN_OPT_VERBOSE);
387 // set reference path
388 for (const auto &path : opt->refFiles) {
389 REF_VECTOR.push_back("-r:" + path);
392 std::vector<std::string> paths = __pm->getPlatformAssembliesPaths();
393 for (const auto &path : paths) {
394 if (checkDllExistInDir(path)) {
395 REF_VECTOR.push_back("-r:" + path + "/*.dll");
399 if (opt->flags & NI_FLAGS_EXTRA_REF) {
400 for (const auto &erPath : opt->extraRefPath) {
401 std::string path = getAbsolutePath(erPath);
402 if (checkDllExistInDir(path)) {
403 REF_VECTOR.push_back("-r:" + path + "/*.dll");
408 for (const auto &path : refPaths) {
409 if (checkDllExistInDir(path)) {
410 REF_VECTOR.push_back("-r:" + path + "/*.dll");
414 for (const auto &path : REF_VECTOR) {
415 if (find(args.begin(), args.end(), path) == args.end()) {
416 args.push_back(path.c_str());
421 static void clearArgs(std::vector<const char*>& args)
427 static ni_error_e makePdbSymlinkForNI(std::string dllPath, std::string niPath)
429 std::string pdbPath = changeExtension(dllPath, ".dll", ".pdb");
431 if (exist(pdbPath)) {
432 std::string targetPDBPath = changeExtension(niPath, ".ni.dll", ".pdb");
433 if (!exist(targetPDBPath)) {
434 bf::create_symlink(pdbPath, targetPDBPath);
435 copySmackAndOwnership(pdbPath, targetPDBPath, true);
438 } catch (const bf::filesystem_error& error) {
439 _SERR("Fail to create symlink for %s", pdbPath.c_str());
440 return NI_ERROR_UNKNOWN;
443 return NI_ERROR_NONE;
446 static ni_error_e crossgen2PostAction(const std::string& dllPath, const std::string& niPath, NIOption* opt) {
447 std::string outFile = niPath;
448 if (!exist(outFile)) {
449 return NI_ERROR_NO_SUCH_FILE;
451 copySmackAndOwnership(dllPath, outFile);
453 // if AppNI then move ni.dll file to .native_image and copy pdb to .native_image
454 if (opt->flags & NI_FLAGS_APPNI) {
455 outFile = getNIFilePath(dllPath, opt);
456 makePdbSymlinkForNI(dllPath, outFile);
458 if (opt->flags & NI_FLAGS_INPUT_BUBBLE && opt->flags & NI_FLAGS_NO_PIPELINE) {
459 outFile = outFile + ".tmp";
462 if (niPath != outFile) {
463 moveFile(niPath, outFile);
467 if (opt->flags & NI_FLAGS_RM_ORIGIN_AFTER_NI) {
468 if (!removeFile(dllPath)) {
469 _SERR("Fail to remove original file : %s", dllPath.c_str());
473 if (opt->flags & NI_FLAGS_RESOURCE_NI) {
474 moveFile(niPath, changeExtension(dllPath, ".dll", ".ni.dll"));
475 removeAll(concatPath(__pm->getAppRootPath(), APP_NI_SUB_DIR));
478 if (!(opt->flags & NI_FLAGS_INPUT_BUBBLE && opt->flags & NI_FLAGS_NO_PIPELINE)) {
479 _SOUT("Native image %s generated successfully.", outFile.c_str());
482 return NI_ERROR_NONE;
485 void setPriority(NIOption* opt)
487 pid_t pid = getpid();
488 if (setpriority(PRIO_PROCESS, pid, opt->priority) == 0) {
489 std::string str = " ";
490 if (opt->priority <= -20) {
492 } else if (opt->priority >= 19) {
495 _SOUT("Success to set the%spriority of the process. pid : [%d], priority : [%d]", str.c_str(), pid, getpriority(PRIO_PROCESS, pid));
497 _SERR("Failed to set the priority of the process. pid : [%d], priority : [%d]", pid, getpriority(PRIO_PROCESS, pid));
501 static ni_error_e crossgen2PipeLine(const std::vector<std::string>& dllList, const std::vector<std::string>& refPaths, NIOption* opt)
506 return NI_ERROR_UNKNOWN;
510 waitpid(pid, &status, 0);
511 if (WIFEXITED(status)) {
512 for (auto& dllPath: dllList) {
513 ni_error_e ret = crossgen2PostAction(dllPath, changeExtension(dllPath, ".dll", ".ni.dll"), opt);
514 if (ret != NI_ERROR_NONE) {
519 _SERR("Failed. Forked process terminated abnormally");
520 return NI_ERROR_ABNORMAL_PROCESS_TERMINATION;
523 if (opt->flags & NI_FLAGS_SET_PRIORITY) {
526 std::vector<const char*> argv;
527 makeArgs(argv, refPaths, opt);
528 argv.push_back(CROSSGEN_OPT_OUT_NEAR_INPUT);
529 argv.push_back(CROSSGEN_OPT_SINGLE_FILE_COMPILATION);
531 // add input files at the end of parameter
532 for (const auto &input : dllList) {
533 argv.push_back(input.c_str());
534 _SOUT("+ %s", input.c_str());
538 argv.push_back(nullptr);
541 if (opt->flags & NI_FLAGS_PRINT_CMD) {
542 _SOUT("==================== NI Commands =========================");
543 for (auto &arg: argv) _SOUT("+ %s", arg);
546 execv(CORERUN_CMD.c_str(), const_cast<char* const*>(argv.data()));
552 return NI_ERROR_NONE;
555 static ni_error_e crossgen2NoPipeLine(const std::vector<std::string>& dllList, const std::vector<std::string>& refPaths, NIOption* opt)
557 for (auto& dllPath : dllList) {
559 niPath = getNIFilePath(dllPath, opt);
561 #ifdef UNIQUE_DEFAULT_BASE_ADDR_SUPPORT
562 uintptr_t baseAddr = 0;
563 if (isTPADll(dllPath)) {
564 baseAddr = getNextBaseAddr();
567 if (opt->flags & NI_FLAGS_INPUT_BUBBLE) {
574 return NI_ERROR_UNKNOWN;
578 waitpid(pid, &status, 0);
579 if (WIFEXITED(status)) {
580 ni_error_e ret = crossgen2PostAction(dllPath, niPath, opt);
581 if (ret != NI_ERROR_NONE) {
584 #ifdef UNIQUE_DEFAULT_BASE_ADDR_SUPPORT
586 updateBaseAddrFile(niPath, baseAddr);
590 _SERR("Failed. Forked process terminated abnormally");
591 _SERR("Crossgen2 was terminated by the OOM killer. Please check the system.");
592 removeFile(changeExtension(niPath, ".ni.dll", ".ni.dll.tmp"));
593 return NI_ERROR_ABNORMAL_PROCESS_TERMINATION;
596 if (opt->flags & NI_FLAGS_SET_PRIORITY) {
599 std::vector<const char*> argv;
600 makeArgs(argv, refPaths, opt);
602 #ifdef UNIQUE_DEFAULT_BASE_ADDR_SUPPORT
603 std::string baseAddrString;
605 argv.push_back("--imagebase");
606 std::stringstream ss;
607 ss << "0x" << std::hex << baseAddr;
608 baseAddrString = ss.str();
609 argv.push_back(baseAddrString.c_str());
612 argv.push_back("-o");
613 argv.push_back(niPath.c_str());
615 argv.push_back(dllPath.c_str());
616 _SOUT("+ %s", dllPath.c_str());
619 argv.push_back(nullptr);
622 if (opt->flags & NI_FLAGS_PRINT_CMD) {
623 _SOUT("==================== NI Commands =========================");
624 for (auto &arg: argv) _SOUT("+ %s", arg);
627 execv(CORERUN_CMD.c_str(), const_cast<char* const*>(argv.data()));
636 return NI_ERROR_NONE;
639 static ni_error_e createCoreLibNI(NIOption* opt)
641 std::string coreLib = concatPath(__pm->getRuntimePath(), "System.Private.CoreLib.dll");
642 std::string niCoreLib = concatPath(__pm->getRuntimePath(), "System.Private.CoreLib.ni.dll");
643 std::string niTmpCoreLib = concatPath(__pm->getRuntimePath(), "System.Private.CoreLib.ni.dll.tmp");
644 std::string coreLibBackup = concatPath(__pm->getRuntimePath(), "System.Private.CoreLib.dll.Backup");
646 std::vector<std::string> dllList;
647 std::vector<std::string> refPaths;
648 dllList.push_back(getAbsolutePath(coreLib));
650 if (!isFile(coreLibBackup) && !isR2RImage(coreLib)) {
651 if (crossgen2NoPipeLine(dllList, refPaths, opt) == NI_ERROR_NONE) {
652 if (opt->flags & NI_FLAGS_RM_ORIGIN_AFTER_NI) {
653 std::ofstream output(coreLibBackup);
654 if (!exist(coreLibBackup)) {
655 _SERR("Failed to create System.Private.CoreLib.dll.Backup");
656 return NI_ERROR_CORE_NI_FILE;
658 copySmackAndOwnership(__pm->getRuntimePath(), coreLibBackup, false);
660 } else if (rename(coreLib.c_str(), coreLibBackup.c_str())) {
661 _SERR("Failed to rename from System.Private.CoreLib.dll to System.Private.CoreLib.dll.Backup");
662 return NI_ERROR_CORE_NI_FILE;
664 if (opt->flags & NI_FLAGS_INPUT_BUBBLE) {
665 if (rename(niTmpCoreLib.c_str(), coreLib.c_str())) {
666 _SERR("Failed to rename from System.Private.CoreLib.ni.dll.tmp to Private.CoreLib.dll");
667 return NI_ERROR_CORE_NI_FILE;
670 if (rename(niCoreLib.c_str(), coreLib.c_str())) {
671 _SERR("Failed to rename from System.Private.CoreLib.ni.dll to Private.CoreLib.dll");
672 return NI_ERROR_CORE_NI_FILE;
676 _SERR("Failed to create native image for %s", coreLib.c_str());
677 return NI_ERROR_CORE_NI_FILE;
680 return NI_ERROR_NONE;
683 static void renameAppNITmpPath(NIOption* opt)
685 std::string niTmpPath = __pm->getAppRootPath() + "/bin/" + APP_NI_SUB_TMP_DIR;
686 std::string niPath = __pm->getAppRootPath() + "/bin/" + APP_NI_SUB_DIR;
688 if (opt->flags & NI_FLAGS_APP_UNDER_RO_AREA) {
689 niTmpPath = replaceAll(niTmpPath, getBaseName(__pm->getAppRootPath()), __READ_ONLY_APP_UPDATE_DIR);
690 niPath = replaceAll(niPath, getBaseName(__pm->getAppRootPath()), __READ_ONLY_APP_UPDATE_DIR);
693 if (isDirectory(niTmpPath)) {
694 if (rename(niTmpPath.c_str(), niPath.c_str())) {
695 _SERR("Fail to rename from .native_image_tmp to .native_image");
697 _SOUT("Success to rename from %s to %s", niTmpPath.c_str(), niPath.c_str());
702 static ni_error_e doAOTList(std::vector<std::string>& dllList, const std::string& refPaths, NIOption* opt)
704 ni_error_e ret = NI_ERROR_NONE;
706 if (dllList.empty()) {
707 return NI_ERROR_INVALID_PARAMETER;
709 // When performing AOT for one Dll, an error is returned when an error occurs.
710 // However, when processing multiple dlls at once, only the log for errors is output and skipped.
712 std::string coreLib = concatPath(__pm->getRuntimePath(), "System.Private.CoreLib.dll");
715 for (auto it = dllList.begin(); it != dllList.end(); it++) {
718 _SERR("dll file is not exist : %s", f.c_str());
721 else if (!isManagedAssembly(f)) {
722 _SERR("Input file is not a dll file : %s", f.c_str());
725 // handle System.Private.CoreLib.dll separately.
726 // dllList and path manager contain absolute path. So, there is no need to change path to absolute path
727 else if (f == coreLib) {
733 // Error : Multiple input files matching same simple name
734 // So, Remove dulicate files from dll list
735 std::sort(dllList.begin(), dllList.end());
736 dllList.erase(unique(dllList.begin(), dllList.end()), dllList.end());
738 // In the case of SPC, post-processing is required to change the name of the native image.
739 // In order to avoid repeatedly checking whether the generated native image is an SPC,
740 // the SPC native image generation is performed separately.
742 ret = createCoreLibNI(opt);
743 if (ret != NI_ERROR_NONE) {
748 // if there is no proper input after processing dll list
749 if (dllList.empty()) {
753 return NI_ERROR_INVALID_PARAMETER;
757 std::vector<std::string> paths;
758 splitPath(refPaths, paths);
760 if (opt->flags & NI_FLAGS_NO_PIPELINE) {
761 ret = crossgen2NoPipeLine(dllList, paths, opt);
763 std::vector<std::string> notCompiled;
764 ret = crossgen2PipeLine(dllList, paths, opt);
765 if (ret != NI_ERROR_NONE) {
766 _SERR("Crossgen2 is abnormally terminated. Regenerate native images that failed while running crossgen2.");
767 for (auto &dll : dllList) {
768 std::string tFile = changeExtension(dll, ".dll", ".ni.dll");
769 if (opt->flags & NI_FLAGS_INPUT_BUBBLE) {
773 notCompiled.push_back(dll);
776 _SERR("Retry running crossgen2 with --no-pipeline mode to avoid termination by OOM.");
777 ret = crossgen2NoPipeLine(notCompiled, paths, opt);
781 if (ret == NI_ERROR_NONE) {
782 if (opt->flags & NI_FLAGS_INPUT_BUBBLE) {
783 for (auto &dll : dllList) {
785 std::string niFile = getNIFilePath(dll, opt);
786 tmpFile = niFile + ".tmp";
788 if (exist(tmpFile)) {
789 moveFile(tmpFile, niFile);
790 _SOUT("Native image %s generated successfully.", niFile.c_str());
794 if (opt->flags & NI_FLAGS_APPNI) {
795 renameAppNITmpPath(opt);
802 static ni_error_e doAOTFile(const std::string& dllFile, const std::string& refPaths, NIOption* opt)
804 if (!isFile(dllFile)) {
805 _SERR("dll file is not exist : %s", dllFile.c_str());
806 return NI_ERROR_NO_SUCH_FILE;
809 if (checkNIExistence(dllFile, opt)) {
810 _SERR("Native image file is already exist : %s", dllFile.c_str());
811 return NI_ERROR_ALREADY_EXIST;
814 if (!isManagedAssembly(dllFile)) {
815 _SERR("Failed. Input parameter is not managed dll (%s)\n", dllFile.c_str());
816 return NI_ERROR_INVALID_PARAMETER;
819 std::vector<std::string> dllList;
820 dllList.push_back(getAbsolutePath(dllFile));
821 return doAOTList(dllList, refPaths, opt);
824 static ni_error_e removeAndCreateNI(const char* pkgId, NIOption* pOptions)
826 if (removeNIUnderPkgRoot(pkgId) != NI_ERROR_NONE) {
827 _SERR("Failed to remove previous dlls from [%s]", pkgId);
828 return NI_ERROR_UNKNOWN;
831 if (createNIUnderPkgRoot(pkgId, pOptions) != NI_ERROR_NONE) {
832 _SERR("Failed to generate NI file [%s]", pkgId);
833 return NI_ERROR_UNKNOWN;
836 _SOUT("Complete make native image for pkg (%s)", pkgId);
837 return NI_ERROR_NONE;
840 static bool isReadOnlyPkg(std::string pkgId)
843 bool readonly = false;
844 pkgmgrinfo_pkginfo_h handle;
846 ret = pkgmgrinfo_pkginfo_get_pkginfo(pkgId.c_str(), &handle);
847 if (ret != PMINFO_R_OK) {
848 _ERR("Fail to get pkginfo");
852 ret = pkgmgrinfo_pkginfo_is_readonly(handle, &readonly);
853 if (ret != PMINFO_R_OK) {
854 _ERR("Fail to get is_readonly");
855 pkgmgrinfo_pkginfo_destroy_pkginfo(handle);
859 pkgmgrinfo_pkginfo_destroy_pkginfo(handle);
863 // callback function of "pkgmgrinfo_appinfo_metadata_filter_foreach"
864 static int appAotCb(pkgmgrinfo_appinfo_h handle, void *userData)
867 int ret = pkgmgrinfo_appinfo_get_pkgid(handle, &pkgId);
868 if (ret != PMINFO_R_OK) {
869 _SERR("Failed to get pkgid");
873 std::vector<std::string> *pkgList = (std::vector<std::string> *)userData;
874 pkgList->push_back(pkgId);
879 // callback function of "pkgmgrinfo_pkginfo_metadata_filter_foreach"
880 static int pkgAotCb(pkgmgrinfo_pkginfo_h handle, void *userData)
883 int ret = pkgmgrinfo_pkginfo_get_pkgid(handle, &pkgId);
884 if (ret != PMINFO_R_OK) {
885 _SERR("Failed to get pkgid");
889 std::vector<std::string> *pkgList = (std::vector<std::string> *)userData;
890 pkgList->push_back(pkgId);
895 ni_error_e initNICommon()
897 #if defined(__arm__) || defined(__aarch64__)
900 env = getenv("MIC_CROSSGEN2_ENABLED");
901 if (env != nullptr && !strcmp(env, "1")) {
902 CORERUN_CMD = std::string("/opt/usr/dotnet/mic/crossgen2");
904 CLRJIT_PATH = std::string("/opt/usr/dotnet/mic/libclrjit_unix_") + ARCHITECTURE_IDENTIFIER + std::string("_x64.so");
907 // get interval value
908 const static std::string intervalFile = concatPath(__NATIVE_LIB_DIR, "crossgen_interval.txt");
909 std::ifstream inFile(intervalFile);
911 _SOUT("crossgen_interval.txt is found");
912 inFile >> __interval;
915 if (initializePluginManager("normal")) {
916 _SERR("Fail to initialize PluginManager");
917 return NI_ERROR_UNKNOWN;
921 __pm = new PathManager();
922 } catch (const std::exception& e) {
923 _SERR("Failed to create PathManager");
924 return NI_ERROR_UNKNOWN;
927 char* pluginDllPaths = pluginGetDllPath();
928 if (pluginDllPaths && pluginDllPaths[0] != '\0') {
929 __pm->addPlatformAssembliesPaths(pluginDllPaths, true);
932 char* pluginNativePaths = pluginGetNativeDllSearchingPath();
933 if (pluginNativePaths && pluginNativePaths[0] != '\0') {
934 __pm->addNativeDllSearchingPaths(pluginNativePaths, true);
937 return NI_ERROR_NONE;
939 _SERR("crossgen supports arm/arm64 architecture only. skip ni file generation");
940 return NI_ERROR_NOT_SUPPORTED;
944 void finalizeNICommon()
948 finalizePluginManager();
955 __ni_option = nullptr;
959 ni_error_e createNIPlatform(std::string& extraInputs, NIOption* opt)
961 extraInputs += ":" + __pm->getRuntimePath();
962 extraInputs += ":" + __pm->getTizenFXPath();
964 return createNIUnderDirs(extraInputs, opt);
967 ni_error_e createNIDll(const std::string& dllPath, NIOption* opt)
969 return doAOTFile(dllPath, std::string(), opt);
972 ni_error_e createNIUnderTAC(const std::string& targetPath, const std::string& refPaths, NIOption* opt)
976 // NI fils of TAC-related dlls under /opt/usr/dotnet should not be created under .native_image directory.
977 // So, unset NI_FLAGS_APPNI temporally and restore it after running AOT.
978 bool isAppNI = false;
979 if (opt->flags & NI_FLAGS_APPNI) {
980 opt->flags &= ~NI_FLAGS_APPNI;
984 if (opt->flags & NI_FLAGS_INPUT_BUBBLE) {
985 std::vector<std::string> refs;
986 splitPath(refPaths, refs);
987 for (auto &p: refs) {
988 if (isDirectory(p) && checkDllExistInDir(p)) {
989 opt->inputBubbleRefFiles.push_back(p + "/*.dll");
994 // get managed file list from targetPath
995 std::vector<std::string> dllList;
996 ret = getTargetDllList(targetPath, dllList, opt);
997 if (ret != NI_ERROR_NONE) {
1001 std::vector<std::string> needNIList;
1002 std::vector<std::string> niList;
1004 for (auto &dll : dllList) {
1005 if (!checkNIExistence(dll, opt)) {
1006 needNIList.push_back(dll);
1008 niList.push_back(getNIFilePath(dll, opt));
1011 if (!needNIList.empty()) {
1012 ret = doAOTList(needNIList, refPaths, opt);
1013 if (ret != NI_ERROR_NONE) {
1019 opt->flags |= NI_FLAGS_APPNI;
1020 for (auto &niPath : niList) {
1021 if (exist(niPath)) {
1022 std::string symNIPath = concatPath(targetPath, getFileName(niPath));
1023 if (!exist(symNIPath)) {
1024 bf::create_symlink(niPath, symNIPath);
1025 copySmackAndOwnership(targetPath.c_str(), symNIPath.c_str(), true);
1026 _SOUT("%s symbolic link file generated successfully.", symNIPath.c_str());
1027 _INFO("%s symbolic link file generated successfully.", symNIPath.c_str());
1033 return NI_ERROR_NONE;
1036 ni_error_e createNIUnderDirs(const std::string& rootPaths, NIOption* opt)
1038 ni_error_e ret = NI_ERROR_NONE;
1040 std::vector<std::string> fileList;
1041 std::vector<std::string> paths;
1042 splitPath(rootPaths, paths);
1044 if (opt->flags & NI_FLAGS_INPUT_BUBBLE) {
1045 for (auto &p: paths) {
1046 if (isDirectory(p) && checkDllExistInDir(p)) {
1047 opt->inputBubbleRefFiles.push_back(p + "/*.dll");
1052 for (const auto &path : paths) {
1057 if (path.find(TAC_SYMLINK_SUB_DIR) != std::string::npos) {
1058 ret = createNIUnderTAC(path, rootPaths, opt);
1059 if (ret != NI_ERROR_NONE) {
1063 ret = getTargetDllList(path, fileList, opt);
1064 if (ret != NI_ERROR_NONE) {
1070 if (fileList.empty()) {
1071 return NI_ERROR_NONE;
1074 return doAOTList(fileList, rootPaths, opt);
1077 ni_error_e createNIUnderPkgRoot(const std::string& pkgId, NIOption* opt)
1079 if (!isR2RImage(concatPath(__pm->getRuntimePath(), "System.Private.CoreLib.dll"))) {
1080 _SERR("The native image of System.Private.CoreLib does not exist.\n"
1081 "Run the command to create the native image\n"
1082 "# dotnettool --ni-dll /usr/share/dotnet.tizen/netcoreapp/System.Private.CoreLib.dll");
1083 return NI_ERROR_CORE_NI_FILE;
1086 std::string rootPath = getRootPath(pkgId);
1087 if (rootPath.empty()) {
1088 _SERR("Failed to get root path from [%s]", pkgId.c_str());
1089 return NI_ERROR_INVALID_PACKAGE;
1091 __pm->setAppRootPath(rootPath);
1093 char* extraDllPaths = pluginGetExtraDllPath();
1094 if (extraDllPaths && extraDllPaths[0] != '\0') {
1095 opt->flags |= NI_FLAGS_EXTRA_REF;
1096 splitPath(extraDllPaths, opt->extraRefPath);
1099 std::string targetDirs;
1101 opt->flags &= ~NI_FLAGS_APPNI; // added to exclude logic of APP_NI
1102 opt->flags |= NI_FLAGS_RESOURCE_NI; // added flag for RPK type
1103 opt->flags |= NI_FLAGS_NO_PIPELINE; // added the flag to set the output path
1105 std::string paths = getResourcePaths(rootPath);
1106 if (paths.empty()) {
1107 _SERR("Failed to get rpk paths from [%s]", pkgId.c_str());
1108 return NI_ERROR_UNKNOWN;
1112 opt->flags |= NI_FLAGS_APPNI;
1113 opt->flags &= ~NI_FLAGS_RESOURCE_NI; // added to exclude logic of RESOURCE_NI
1115 if (isReadOnlyArea(rootPath)) {
1116 opt->flags |= NI_FLAGS_APP_UNDER_RO_AREA;
1117 opt->flags |= NI_FLAGS_NO_PIPELINE;
1118 _SERR("Only no-pipeline mode supported for RO app. Set no-pipeline option forcibly");
1120 opt->flags &= ~NI_FLAGS_APP_UNDER_RO_AREA;
1123 targetDirs = __pm->getAppPaths();
1126 return createNIUnderDirs(targetDirs, opt);
1129 void removeNIPlatform()
1131 std::string coreLib = concatPath(__pm->getRuntimePath(), "System.Private.CoreLib.dll");
1132 std::string coreLibBackup = concatPath(__pm->getRuntimePath(), "System.Private.CoreLib.dll.Backup");
1134 if (isR2RImage(coreLib)) {
1135 if (!isFile(coreLibBackup)) {
1139 if (remove(coreLib.c_str())) {
1140 _SERR("Failed to remove System.Private.CoreLib native image file");
1142 if (rename(coreLibBackup.c_str(), coreLib.c_str())) {
1143 _SERR("Failed to rename System.Private.CoreLib.Backup to origin");
1147 #ifdef UNIQUE_DEFAULT_BASE_ADDR_SUPPORT
1148 if (isFile(__SYSTEM_BASE_FILE)) {
1149 if (remove(__SYSTEM_BASE_FILE)) {
1150 _SERR("Failed to remove %s", __SYSTEM_BASE_FILE);
1155 removeNIUnderDirs(__pm->getRuntimePath() + ":" + __pm->getTizenFXPath());
1158 void removeNIUnderDirs(const std::string& rootPaths)
1160 auto convert = [](const std::string& path, const std::string& filename) {
1161 if (isR2RImage(path)) {
1162 std::string assemblyPath = changeExtension(path, ".ni.dll", ".dll");
1163 if (exist(assemblyPath)) {
1164 if (remove(path.c_str())) {
1165 _SERR("Failed to remove %s", path.c_str());
1168 _SOUT("%s cannot be removed because there is no %s", path.c_str(), assemblyPath.c_str());
1173 std::vector<std::string> paths;
1174 splitPath(rootPaths, paths);
1175 for (const auto &path : paths) {
1176 scanFilesInDirectory(path, convert, -1);
1180 ni_error_e removeNIUnderPkgRoot(const std::string& pkgId)
1182 std::vector<std::string> paths;
1184 std::string rootPath = getRootPath(pkgId);
1185 if (rootPath.empty()) {
1186 _SERR("Failed to get root path from [%s]", pkgId.c_str());
1187 return NI_ERROR_INVALID_PACKAGE;
1191 std::string rpkPaths = getResourcePaths(rootPath);
1192 if (rpkPaths.empty()) {
1193 _SERR("Failed to get rpk path from [%s]", pkgId.c_str());
1194 return NI_ERROR_UNKNOWN;
1196 splitPath(rpkPaths, paths);
1197 for (const auto &path : paths) {
1198 if (isDirectory(path)) {
1199 removeNIUnderDirs(path);
1203 __pm->setAppRootPath(rootPath);
1205 // getAppNIPaths returns bin/.native_image, lib/.native_image and .tac_symlink.
1206 std::string appNIPaths = __pm->getAppNIPaths();
1207 splitPath(appNIPaths, paths);
1208 for (const auto &path : paths) {
1209 if (!isReadOnlyArea(path)) {
1210 // Only the native image inside the TAC should be removed.
1211 if (strstr(path.c_str(), TAC_SYMLINK_SUB_DIR) != NULL) {
1212 removeNIUnderDirs(path);
1214 if (isDirectory(path)) {
1215 if (!removeAll(path.c_str())) {
1216 _SERR("Failed to remove app ni dir [%s]", path.c_str());
1223 // In special cases, the ni file may exist in the dll location.
1224 // The code below is to avoid this exceptional case.
1225 std::string appPaths = __pm->getAppPaths();
1226 splitPath(appPaths, paths);
1227 for (const auto &path : paths) {
1228 if (isDirectory(path)) {
1229 removeNIUnderDirs(path);
1234 return NI_ERROR_NONE;
1237 ni_error_e regeneratePkgNI(NIOption* opt)
1239 std::vector<std::string> pkgList;
1240 ni_error_e ret = NI_ERROR_NONE;
1242 // iterates for Packages's metadata (RPK)
1243 pkgmgrinfo_pkginfo_metadata_filter_h pkgHandle;
1244 if (pkgmgrinfo_pkginfo_metadata_filter_create(&pkgHandle) == PMINFO_R_OK) {
1245 if (pkgmgrinfo_pkginfo_metadata_filter_add(pkgHandle, AOT_METADATA_KEY, METADATA_VALUE_TRUE) == PMINFO_R_OK) {
1246 if (pkgmgrPkgMDFilterForeach(pkgHandle, pkgAotCb, &pkgList) != 0) {
1247 ret = NI_ERROR_UNKNOWN;
1248 _ERR("pkgmgrPkgMDFilterForeach failed");
1251 ret = NI_ERROR_UNKNOWN;
1252 _ERR("pkgmgrinfo_pkginfo_metadata_filter_add failed");
1254 pkgmgrinfo_pkginfo_metadata_filter_destroy(pkgHandle);
1256 ret = NI_ERROR_UNKNOWN;
1257 _ERR("pkgmgrinfo_pkginfo_metadata_filter_create failed");
1260 // iterate for App's metadata
1261 pkgmgrinfo_appinfo_metadata_filter_h appHandle;
1262 if (pkgmgrinfo_appinfo_metadata_filter_create(&appHandle) == PMINFO_R_OK) {
1263 if (pkgmgrinfo_appinfo_metadata_filter_add(appHandle, AOT_METADATA_KEY, METADATA_VALUE_TRUE) == PMINFO_R_OK) {
1264 if (pkgmgrAppMDFilterForeach(appHandle, appAotCb, &pkgList) != 0) {
1265 ret = NI_ERROR_UNKNOWN;
1266 _ERR("pkgmgrAppMDFilterForeach failed");
1269 ret = NI_ERROR_UNKNOWN;
1270 _ERR("pkgmgrinfo_appinfo_metadata_filter_add failed");
1272 pkgmgrinfo_appinfo_metadata_filter_destroy(appHandle);
1274 ret = NI_ERROR_UNKNOWN;
1275 _ERR("pkgmgrinfo_appinfo_metadata_filter_create failed");
1278 // remove duplicated pkg in the list.
1279 // If one package has multiple apps, there can be duplicate values.
1280 std::sort(pkgList.begin(), pkgList.end());
1281 pkgList.erase(unique(pkgList.begin(), pkgList.end()), pkgList.end());
1283 for (auto pkg : pkgList) {
1284 if (isReadOnlyPkg(pkg) && opt->flags & NI_FLAGS_SKIP_RO_APP) {
1288 if (removeAndCreateNI(pkg.c_str(), opt) != NI_ERROR_NONE) {
1289 _SERR("Failed to remove previous dlls from [%s]", pkg.c_str());
1290 ret = NI_ERROR_UNKNOWN;
1292 _SOUT("Complete make application to native image");
1299 // callback function of "pkgmgrinfo_appinfo_metadata_filter_foreach"
1300 static int regenTacCb(pkgmgrinfo_appinfo_h handle, void *userData)
1304 NIOption **pOpt = (NIOption**)userData;
1306 int ret = pkgmgrinfo_appinfo_get_pkgid(handle, &pkgId);
1307 if (ret != PMINFO_R_OK || pkgId == NULL) {
1308 _SERR("Failed to get pkgid");
1312 ret = pkgmgrinfo_appinfo_get_root_path(handle, &root);
1313 if (ret != PMINFO_R_OK) {
1314 _SERR("Failed to get root path");
1318 std::string binPath = concatPath(std::string(root), "bin");
1319 if (exist(concatPath(binPath, PRE_COMPILED_PACKAGE_FILE))) {
1320 _INFO("The %s is a Pre-Compiled package. So, skip the TAC", pkgId);
1324 sqlite3 *tac_db = openDB(TAC_APP_LIST_DB);
1326 _SERR("Sqlite open error");
1329 sqlite3_exec(tac_db, "BEGIN;", NULL, NULL, NULL);
1331 char *sql = sqlite3_mprintf("SELECT * FROM TAC WHERE PKGID = %Q;", pkgId);
1332 std::vector<std::string> nugets = selectDB(tac_db, sql);
1340 std::string nugetPaths;
1341 for (const auto &nuget : nugets) {
1342 if (!nugetPaths.empty()) {
1345 nugetPaths += concatPath(__DOTNET_DIR, nuget);
1348 for (auto& nuget : nugets) {
1349 createNIUnderTAC(concatPath(__DOTNET_DIR, nuget), nugetPaths, *pOpt);
1355 ni_error_e regenerateTACNI(NIOption* opt)
1357 removeNIUnderDirs(__DOTNET_DIR);
1359 pkgmgrinfo_appinfo_metadata_filter_h handle;
1360 int ret = pkgmgrinfo_appinfo_metadata_filter_create(&handle);
1361 if (ret != PMINFO_R_OK) {
1362 return NI_ERROR_UNKNOWN;
1365 ret = pkgmgrinfo_appinfo_metadata_filter_add(handle, TAC_METADATA_KEY, METADATA_VALUE_TRUE);
1366 if (ret != PMINFO_R_OK) {
1367 pkgmgrinfo_appinfo_metadata_filter_destroy(handle);
1368 return NI_ERROR_UNKNOWN;
1371 ret = pkgmgrAppMDFilterForeach(handle, regenTacCb, &opt);
1373 pkgmgrinfo_appinfo_metadata_filter_destroy(handle);
1374 return NI_ERROR_UNKNOWN;
1377 pkgmgrinfo_appinfo_metadata_filter_destroy(handle);
1379 return NI_ERROR_NONE;