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.
31 #include <sys/types.h>
34 #include <linux/limits.h>
37 #include <app_common.h>
39 #include "injection.h"
43 #include "dotnet_launcher.h"
44 #include "plugin_manager.h"
45 #include "path_manager.h"
46 #include "log_manager.h"
50 namespace dotnetcore {
52 #if defined (__aarch64__)
53 #define ARCHITECTURE_IDENTIFIER "arm64"
54 const static std::vector<std::string> RID_FALLBACK_GRAPH =
55 {"linux-arm64", "linux", "unix-arm64", "unix", "any", "base"};
57 #elif defined (__arm__)
58 #define ARCHITECTURE_IDENTIFIER "arm"
59 const static std::vector<std::string> RID_FALLBACK_GRAPH =
60 {"tizen.5.0.0-armel", "tizen.5.0.0", "tizen.4.0.0-armel", "tizen.4.0.0", "tizen-armel", "tizen", "linux-armel", "linux", "unix-armel", "unix", "any", "base"};
62 #elif defined (__x86_64__)
63 #define ARCHITECTURE_IDENTIFIER "x64"
64 const static std::vector<std::string> RID_FALLBACK_GRAPH =
65 {"linux-x64", "linux", "unix-x64", "unix", "any", "base"};
67 #elif defined (__i386__)
68 #define ARCHITECTURE_IDENTIFIER "x86"
69 const static std::vector<std::string> RID_FALLBACK_GRAPH =
70 {"tizen.5.0.0-x86", "tizen.5.0.0", "tizen.4.0.0-x86", "tizen.4.0.0", "tizen-x86", "tizen", "linux-x86", "linux", "unix-x86", "unix", "any", "base"};
73 #error "Unknown target"
76 static std::string getExtraNativeLibDirs(const std::string& appRoot)
78 std::string candidate;
79 for (unsigned int i = 0; i < RID_FALLBACK_GRAPH.size(); i++) {
80 if(!candidate.empty()) {
83 candidate += concatPath(appRoot, "bin/runtimes/" + RID_FALLBACK_GRAPH[i] + "/native");
86 candidate = candidate + ":" + concatPath(appRoot, "lib/" ARCHITECTURE_IDENTIFIER);
87 if (!strncmp(ARCHITECTURE_IDENTIFIER, "arm64", 5)) {
88 candidate = candidate + ":" + concatPath(appRoot, "lib/aarch64");
95 static std::vector<std::string> __envList;
97 static void setEnvFromFile()
100 std::ifstream inFile(ENV_FILE_PATH);
105 _INFO("coreclr_env.list is found");
108 std::istringstream ss(envList);
111 while (std::getline(ss, token, ':')) {
112 if (!token.empty()) {
113 __envList.push_back(token);
117 for (unsigned int i = 0; i < __envList.size(); i++) {
118 putenv(const_cast<char *>(__envList[i].c_str()));
121 _INFO("coreclr_env.list file is not found. skip");
125 #define _unused(x) ((void)(x))
127 struct sigaction sig_abrt_new;
128 struct sigaction sig_abrt_old;
130 static bool checkOnSigabrt = false;
131 static bool checkOnTerminate = false;
133 static void onSigabrt(int signum)
135 // use unused variable to avoid build warning
136 ssize_t ret = write(STDERR_FILENO, "onSigabrt called\n", 17);
138 if (checkOnTerminate) {
139 ret = write(STDERR_FILENO, "onSigabrt called while terminate. go to exit\n", 45);
144 if (checkOnSigabrt) {
145 ret = write(STDERR_FILENO, "onSigabrt called again. go to exit\n", 35);
150 if (hasException()) {
151 ret = write(STDERR_FILENO, "******************************************************\n", 55);
152 ret = write(STDERR_FILENO, "Unhandled exception is occured. check application code\n", 55);
153 ret = write(STDERR_FILENO, "******************************************************\n", 55);
156 checkOnSigabrt = true;
157 if (sigaction(SIGABRT, &sig_abrt_old, NULL) == 0) {
158 if (raise(signum) < 0) {
159 ret = write(STDERR_FILENO, "Fail to raise SIGABRT\n", 22);
162 ret = write(STDERR_FILENO, "Fail to set original SIGABRT handler\n", 37);
167 static void registerSigHandler()
169 sig_abrt_new.sa_handler = onSigabrt;
170 if (sigemptyset(&sig_abrt_new.sa_mask) != 0) {
171 _ERR("Fail to sigemptyset");
174 if (sigaction(SIGABRT, &sig_abrt_new, &sig_abrt_old) < 0) {
175 _ERR("Fail to add sig handler");
179 static bool storage_cb(int id, storage_type_e type, storage_state_e state, const char *path, void *user_data)
181 int* tmp = (int*)user_data;
182 if (type == STORAGE_TYPE_INTERNAL)
191 static void initEnvForSpecialFolder()
197 error = storage_foreach_device_supported(storage_cb, &storageId);
198 if (error != STORAGE_ERROR_NONE) {
202 error = storage_get_directory(storageId, STORAGE_DIRECTORY_IMAGES, &path);
203 if (error == STORAGE_ERROR_NONE && path != NULL) {
204 setenv("XDG_PICTURES_DIR", const_cast<char *>(path), 1);
209 error = storage_get_directory(storageId, STORAGE_DIRECTORY_MUSIC, &path);
210 if (error == STORAGE_ERROR_NONE && path != NULL) {
211 setenv("XDG_MUSIC_DIR", const_cast<char *>(path), 1);
216 error = storage_get_directory(storageId, STORAGE_DIRECTORY_VIDEOS, &path);
217 if (error == STORAGE_ERROR_NONE && path != NULL) {
218 setenv("XDG_VIDEOS_DIR", const_cast<char *>(path), 1);
224 void CoreRuntime::preloadTypes()
226 const static std::string initDllPath = "/usr/share/dotnet.tizen/framework/Tizen.Init.dll";
227 if (!isFileExist(initDllPath)) {
228 _ERR("Failed to locate Tizen.Init.dll");
232 typedef void (*InitDelegate)();
233 InitDelegate initDelegate;
235 int ret = createDelegate(__hostHandle,
238 "Tizen.Init.TypeLoader",
240 (void**)&initDelegate);
243 _ERR("Failed to create delegate for PreloadTypes (0x%08x)", ret);
249 CoreRuntime::CoreRuntime(const char* mode) :
250 initializeClr(nullptr),
251 executeAssembly(nullptr),
253 createDelegate(nullptr),
254 setEnvironmentVariable(nullptr),
255 __coreclrLib(nullptr),
256 __hostHandle(nullptr),
259 __initialized(false),
260 __isProfileMode(false)
262 _INFO("Constructor called!!");
265 env = getenv("CORECLR_ENABLE_PROFILING");
266 if (env != nullptr && !strcmp(env, "1")) {
267 _INFO("profiling mode on");
268 __isProfileMode = true;
271 // plugin initialize should be called before start loader mainloop.
272 // In case of VD plugins, attaching secure zone is done in the plugin_initialize().
273 // When attaching to a secure zone, if there is a created thread, it will failed.
274 // So, plugin initialize should be called before mainloop start.
275 if (initializePluginManager(mode) < 0) {
276 _ERR("Failed to initialize PluginManager");
279 if (pluginHasLogControl()) {
280 __enableLogManager = false;
282 __enableLogManager = true;
286 CoreRuntime::~CoreRuntime()
288 // workaround : to prevent crash while process terminate on profiling mode,
289 // kill process immediately.
290 // see https://github.com/dotnet/coreclr/issues/26687
291 if (__isProfileMode) {
292 _INFO("shutdown process immediately.");
299 int CoreRuntime::preinitialize(bool standalone)
301 // checkInjection checks dotnet-launcher run mode
302 // At the moment, this mechanism is used only when the Memory Profiler is started.
303 int res = checkInjection();
305 _ERR("Failed to initnialize Memory Profiler");
309 #define __STR(x) __XSTR(x)
311 #ifdef NATIVE_LIB_DIR
312 __nativeLibDirectory = __STR(NATIVE_LIB_DIR);
319 // libunwind library is used to unwind stack frame, but libunwind for ARM
320 // does not support ARM vfpv3/NEON registers in DWARF format correctly.
321 // Therefore let's disable stack unwinding using DWARF information
322 // See https://github.com/dotnet/coreclr/issues/6698
324 // libunwind use following methods to unwind stack frame.
325 // UNW_ARM_METHOD_ALL 0xFF
326 // UNW_ARM_METHOD_DWARF 0x01
327 // UNW_ARM_METHOD_FRAME 0x02
328 // UNW_ARM_METHOD_EXIDX 0x04
329 putenv(const_cast<char *>("UNW_ARM_UNWIND_METHOD=6"));
332 // Disable debug pipes and semaphores creation in case of non-standlone mode
334 putenv(const_cast<char *>("COMPlus_EnableDiagnostics=0"));
336 // Write Debug.WriteLine to stderr
337 putenv(const_cast<char *>("COMPlus_DebugWriteToStdErr=1"));
339 #ifdef USE_DEFAULT_BASE_ADDR
340 putenv(const_cast<char *>("COMPlus_UseDefaultBaseAddr=1"));
341 #endif // USE_DEFAULT_BASE_ADDR
343 // read string from external file and set them to environment value.
346 // Set environment for System.Environment.SpecialFolder
347 initEnvForSpecialFolder();
349 if (initializePathManager(std::string(), std::string(), std::string()) < 0) {
350 _ERR("Failed to initialize PathManager");
354 std::string libCoreclr(concatPath(getRuntimeDir(), "libcoreclr.so"));
356 __coreclrLib = dlopen(libCoreclr.c_str(), RTLD_NOW | RTLD_LOCAL);
357 if (__coreclrLib == nullptr) {
358 char *err = dlerror();
359 _ERR("dlopen failed to open libcoreclr.so with error %s", err);
360 if (access(libCoreclr.c_str(), R_OK) == -1)
361 _ERR("access '%s': %s\n", libCoreclr.c_str(), strerror(errno));
365 #define CORELIB_RETURN_IF_NOSYM(type, variable, name) \
367 variable = (type)dlsym(__coreclrLib, name); \
368 if (variable == nullptr) { \
369 _ERR(name " is not found in the libcoreclr.so"); \
374 CORELIB_RETURN_IF_NOSYM(coreclr_initialize_ptr, initializeClr, "coreclr_initialize");
375 CORELIB_RETURN_IF_NOSYM(coreclr_execute_assembly_ptr, executeAssembly, "coreclr_execute_assembly");
376 CORELIB_RETURN_IF_NOSYM(coreclr_shutdown_ptr, shutdown, "coreclr_shutdown");
377 CORELIB_RETURN_IF_NOSYM(coreclr_create_delegate_ptr, createDelegate, "coreclr_create_delegate");
379 #undef CORELIB_RETURN_IF_NOSYM
381 _INFO("libcoreclr dlopen and dlsym success");
386 int CoreRuntime::initialize(bool standalone)
389 #define __STR(x) __XSTR(x)
391 #ifdef NATIVE_LIB_DIR
392 __nativeLibDirectory = __STR(NATIVE_LIB_DIR);
398 if (__enableLogManager) {
399 if (initializeLogManager() < 0) {
400 _ERR("Failed to initnialize LogManager");
404 if (redirectFD() < 0) {
405 _ERR("Failed to redirect FD");
409 if (runLoggingThread() < 0) {
410 _ERR("Failed to create and run logging thread to redicrect log");
418 fd = open("/proc/self", O_DIRECTORY);
419 std::string appRoot = std::string("/proc/self/fd/") + std::to_string(fd);
420 std::string appBin = concatPath(appRoot, "bin");
421 std::string appLib = concatPath(appRoot, "lib");
422 std::string appTac = concatPath(appBin, TAC_SYMLINK_SUB_DIR);
423 std::string probePath = appBin + ":" + appLib + ":" + appTac;
424 std::string NIprobePath = concatPath(appBin, APP_NI_SUB_DIR) + ":" + concatPath(appLib, APP_NI_SUB_DIR) + ":" + appTac;
425 std::string tpa = getTPA();
426 std::string runtimeDir = getRuntimeDir();
427 std::string nativeLibPath = getExtraNativeLibDirs(appRoot) + ":" + appBin + ":" + appLib + ":" + __nativeLibDirectory + ":" + runtimeDir;
428 std::string appName = std::string("dotnet-launcher-") + std::to_string(getpid());
430 if (!initializeCoreClr(appName.c_str(), probePath.c_str(), NIprobePath.c_str(), nativeLibPath.c_str(), tpa.c_str())) {
431 _ERR("Failed to initialize coreclr");
435 int st = createDelegate(__hostHandle, __domainId, "Dotnet.Launcher", "Dotnet.Launcher.Environment", "SetEnvironmentVariable", (void**)&setEnvironmentVariable);
436 if (st < 0 || setEnvironmentVariable == nullptr) {
437 _ERR("Create delegate for Dotnet.Launcher.dll -> Dotnet.Launcher.Environment -> SetEnvironmentVariable failed (0x%08x)", st);
441 __initialized = true;
445 // Preload common managed code.
448 // This redundant call effectively reduces JIT overhead at launch time.
449 setEnvironmentVariable("XDG_DATA_HOME", "/");
452 _INFO("CoreRuntime initialize success");
457 bool CoreRuntime::initializeCoreClr(const char* appId,
458 const char* assemblyProbePaths,
459 const char* NIProbePaths,
460 const char* pinvokeProbePaths,
463 const char *propertyKeys[] = {
464 "TRUSTED_PLATFORM_ASSEMBLIES",
467 "NATIVE_DLL_SEARCH_DIRECTORIES",
468 "AppDomainCompatSwitch"
471 const char *propertyValues[] = {
476 "UseLatestBehaviorWhenTFMNotSpecified"
479 std::string selfPath = readSelfPath();
481 int st = initializeClr(selfPath.c_str(),
483 sizeof(propertyKeys) / sizeof(propertyKeys[0]),
490 _ERR("initialize core clr fail! (0x%08x)", st);
494 pluginSetCoreclrInfo(__hostHandle, __domainId, createDelegate);
496 _INFO("Initialize core clr success");
500 void CoreRuntime::dispose()
502 // call plugin finalize function to notify finalize to plugin
503 // dlclose shoud be done after coreclr shutdown to avoid breaking signal chain
506 // ignore the signal generated by an exception that occurred during shutdown
507 checkOnTerminate = true;
509 if (__hostHandle != nullptr) {
510 int st = shutdown(__hostHandle, __domainId);
512 _ERR("shutdown core clr fail! (0x%08x)", st);
513 __hostHandle = nullptr;
516 if (__coreclrLib != nullptr) {
517 if (dlclose(__coreclrLib) != 0) {
518 _ERR("libcoreclr.so close failed");
521 __coreclrLib = nullptr;
524 finalizePluginManager();
525 finalizePathManager();
529 _INFO("Dotnet runtime disposed");
532 int CoreRuntime::launch(const char* appId, const char* root, const char* path, int argc, char* argv[])
534 if (!__initialized) {
535 _ERR("Runtime is not initialized");
539 if (path == nullptr) {
540 _ERR("executable path is null");
544 if (!isFileExist(path)) {
545 _ERR("File not exist : %s", path);
549 if (__enableLogManager) {
550 // launchpad override stdout and stderr to journalctl before launch application.
551 // we have to re-override that to input pipe for logging thread.
552 if (redirectFD() < 0) {
553 _ERR("Failed to redirect FD");
557 registerSigHandler();
560 pluginSetAppInfo(appId, path);
562 int fd2 = open(root, O_DIRECTORY);
563 dup3(fd2, fd, O_CLOEXEC);
567 // set application data path to coreclr environment.
568 // application data path can be changed by owner. So, we have to set data path just before launching.
569 char* localDataPath = app_get_data_path();
570 if (localDataPath != nullptr) {
571 setEnvironmentVariable("XDG_DATA_HOME", localDataPath);
575 pluginBeforeExecute();
577 _INFO("execute assembly : %s", path);
579 unsigned int ret = 0;
580 int st = executeAssembly(__hostHandle, __domainId, argc, (const char**)argv, path, &ret);
582 _ERR("Failed to Execute Assembly %s (0x%08x)", path, st);
586 } // namespace dotnetcore
587 } // namespace runtime