NativeLauncher/launcher/dotnet/dotnet_launcher.cc

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17
  18 #include <dlfcn.h>
  19 #include <signal.h>
  20
  21 #include <string>
  22 #include <fstream>
  23 #include <vector>
  24 #include <sstream>
  25
  26 #include <locale>
  27 #include <codecvt>
  28
  29 #include <fcntl.h>
  30 #include <sys/stat.h>
  31 #include <sys/types.h>
  32 #include <sys/wait.h>
  33 #include <unistd.h>
  34 #include <linux/limits.h>
  35
  36 #include <storage.h>
  37 #include <app_common.h>
  38
  39 #include "injection.h"
  40 #include "utils.h"
  41 #include "log.h"
  42 #include "launcher.h"
  43 #include "dotnet_launcher.h"
  44 #include "plugin_manager.h"
  45 #include "path_manager.h"
  46 #include "log_manager.h"
  47
  48 namespace tizen {
  49 namespace runtime {
  50 namespace dotnetcore {
  51
  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"};
  56
  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"};
  61
  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"};
  66
  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"};
  71
  72 #else
  73 #error "Unknown target"
  74 #endif
  75
  76 static std::string getExtraNativeLibDirs(const std::string& appRoot)
  77 {
  78         std::string candidate;
  79         for (unsigned int i = 0; i < RID_FALLBACK_GRAPH.size(); i++) {
  80                 if(!candidate.empty()) {
  81                         candidate += ":";
  82                 }
  83                 candidate += concatPath(appRoot, "bin/runtimes/" + RID_FALLBACK_GRAPH[i] + "/native");
  84         }
  85
  86         candidate = candidate + ":" + concatPath(appRoot, "lib/" ARCHITECTURE_IDENTIFIER);
  87         if (!strncmp(ARCHITECTURE_IDENTIFIER, "arm64", 5)) {
  88                 candidate = candidate + ":" + concatPath(appRoot, "lib/aarch64");
  89         }
  90
  91         return candidate;
  92 }
  93
  94
  95 static std::vector<std::string> __envList;
  96
  97 static void setEnvFromFile()
  98 {
  99         std::string envList;
 100         std::ifstream inFile(ENV_FILE_PATH);
 101
 102         __envList.clear();
 103
 104         if (inFile) {
 105                 _INFO("coreclr_env.list is found");
 106                 inFile >> envList;
 107
 108                 std::istringstream ss(envList);
 109                 std::string token;
 110
 111                 while (std::getline(ss, token, ':')) {
 112                         if (!token.empty()) {
 113                                 __envList.push_back(token);
 114                         }
 115                 }
 116
 117                 for (unsigned int i = 0; i < __envList.size(); i++) {
 118                         putenv(const_cast<char *>(__envList[i].c_str()));
 119                 }
 120         } else {
 121                 _INFO("coreclr_env.list file is not found. skip");
 122         }
 123 }
 124
 125 #define _unused(x) ((void)(x))
 126
 127 struct sigaction sig_abrt_new;
 128 struct sigaction sig_abrt_old;
 129
 130 static bool checkOnSigabrt = false;
 131 static bool checkOnTerminate = false;
 132
 133 static void onSigabrt(int signum)
 134 {
 135         // use unused variable to avoid build warning
 136         ssize_t ret = write(STDERR_FILENO, "onSigabrt called\n", 17);
 137
 138         if (checkOnTerminate) {
 139                 ret = write(STDERR_FILENO, "onSigabrt called while terminate. go to exit\n", 45);
 140                 _unused(ret);
 141                 exit(0);
 142         }
 143
 144         if (checkOnSigabrt) {
 145                 ret = write(STDERR_FILENO, "onSigabrt called again. go to exit\n", 35);
 146                 _unused(ret);
 147                 exit(0);
 148         }
 149
 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);
 154         }
 155
 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);
 160                 }
 161         } else {
 162                 ret = write(STDERR_FILENO, "Fail to set original SIGABRT handler\n", 37);
 163         }
 164         _unused(ret);
 165 }
 166
 167 static void registerSigHandler()
 168 {
 169         sig_abrt_new.sa_handler = onSigabrt;
 170         if (sigemptyset(&sig_abrt_new.sa_mask) != 0) {
 171                 _ERR("Fail to sigemptyset");
 172         }
 173
 174         if (sigaction(SIGABRT, &sig_abrt_new, &sig_abrt_old) < 0) {
 175                 _ERR("Fail to add sig handler");
 176         }
 177 }
 178
 179 static bool storage_cb(int id, storage_type_e type, storage_state_e state, const char *path, void *user_data)
 180 {
 181         int* tmp = (int*)user_data;
 182         if (type == STORAGE_TYPE_INTERNAL)
 183         {
 184                 *tmp = id;
 185                 return false;
 186         }
 187
 188         return true;
 189 }
 190
 191 static void initEnvForSpecialFolder()
 192 {
 193         int storageId;
 194         int error;
 195         char *path = NULL;
 196
 197         error = storage_foreach_device_supported(storage_cb, &storageId);
 198         if (error != STORAGE_ERROR_NONE) {
 199                 return;
 200         }
 201
 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);
 205                 free(path);
 206                 path = NULL;
 207         }
 208
 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);
 212                 free(path);
 213                 path = NULL;
 214         }
 215
 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);
 219                 free(path);
 220                 path = NULL;
 221         }
 222 }
 223
 224 void CoreRuntime::preloadTypes()
 225 {
 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");
 229                 return;
 230         }
 231
 232         typedef void (*InitDelegate)();
 233         InitDelegate initDelegate;
 234
 235         int ret = createDelegate(__hostHandle,
 236                 __domainId,
 237                 "Tizen.Init",
 238                 "Tizen.Init.TypeLoader",
 239                 "PreloadTypes",
 240                 (void**)&initDelegate);
 241
 242         if (ret < 0) {
 243                 _ERR("Failed to create delegate for PreloadTypes (0x%08x)", ret);
 244         } else {
 245                 initDelegate();
 246         }
 247 }
 248
 249 CoreRuntime::CoreRuntime(const char* mode) :
 250         initializeClr(nullptr),
 251         executeAssembly(nullptr),
 252         shutdown(nullptr),
 253         createDelegate(nullptr),
 254         setEnvironmentVariable(nullptr),
 255         preloadAssembly(nullptr),
 256         __coreclrLib(nullptr),
 257         __hostHandle(nullptr),
 258         __domainId(-1),
 259         fd(0),
 260         __initialized(false),
 261         __isProfileMode(false)
 262 {
 263         _INFO("Constructor called!!");
 264
 265         char *env = nullptr;
 266         env = getenv("CORECLR_ENABLE_PROFILING");
 267         if (env != nullptr && !strcmp(env, "1")) {
 268                 _INFO("profiling mode on");
 269                 __isProfileMode = true;
 270         }
 271
 272         // plugin initialize should be called before start loader mainloop.
 273         // In case of VD plugins, attaching secure zone is done in the plugin_initialize().
 274         // When attaching to a secure zone, if there is a created thread, it will failed.
 275         // So, plugin initialize should be called before mainloop start.
 276         if (initializePluginManager(mode) < 0) {
 277                 _ERR("Failed to initialize PluginManager");
 278         }
 279
 280         if (pluginHasLogControl()) {
 281                 __enableLogManager = false;
 282         } else {
 283                 __enableLogManager = true;
 284         }
 285 }
 286
 287 CoreRuntime::~CoreRuntime()
 288 {
 289         // workaround : to prevent crash while process terminate on profiling mode,
 290         //              kill process immediately.
 291         // see https://github.com/dotnet/coreclr/issues/26687
 292         if (__isProfileMode) {
 293                 _INFO("shutdown process immediately.");
 294                 _exit(0);
 295         }
 296
 297         dispose();
 298 }
 299
 300 int CoreRuntime::preinitialize(bool standalone)
 301 {
 302         // checkInjection checks dotnet-launcher run mode
 303         // At the moment, this mechanism is used only when the Memory Profiler is started.
 304         int res = checkInjection();
 305         if (res != 0) {
 306                 _ERR("Failed to initnialize Memory Profiler");
 307                 return -1;
 308         }
 309 #define __XSTR(x) #x
 310 #define __STR(x) __XSTR(x)
 311
 312 #ifdef NATIVE_LIB_DIR
 313         __nativeLibDirectory = __STR(NATIVE_LIB_DIR);
 314 #endif
 315
 316 #undef __STR
 317 #undef __XSTR
 318
 319 #ifdef __arm__
 320         // libunwind library is used to unwind stack frame, but libunwind for ARM
 321         // does not support ARM vfpv3/NEON registers in DWARF format correctly.
 322         // Therefore let's disable stack unwinding using DWARF information
 323         // See https://github.com/dotnet/coreclr/issues/6698
 324         //
 325         // libunwind use following methods to unwind stack frame.
 326         // UNW_ARM_METHOD_ALL          0xFF
 327         // UNW_ARM_METHOD_DWARF        0x01
 328         // UNW_ARM_METHOD_FRAME        0x02
 329         // UNW_ARM_METHOD_EXIDX        0x04
 330         putenv(const_cast<char *>("UNW_ARM_UNWIND_METHOD=6"));
 331 #endif // __arm__
 332
 333         // Disable debug pipes and semaphores creation in case of non-standlone mode
 334         if (!standalone)
 335                 putenv(const_cast<char *>("COMPlus_EnableDiagnostics=0"));
 336
 337         // Write Debug.WriteLine to stderr
 338         putenv(const_cast<char *>("COMPlus_DebugWriteToStdErr=1"));
 339
 340 #ifdef USE_DEFAULT_BASE_ADDR
 341         putenv(const_cast<char *>("COMPlus_UseDefaultBaseAddr=1"));
 342 #endif // USE_DEFAULT_BASE_ADDR
 343
 344         // read string from external file and set them to environment value.
 345         setEnvFromFile();
 346
 347         // Set environment for System.Environment.SpecialFolder
 348         initEnvForSpecialFolder();
 349
 350         if (initializePathManager(std::string(), std::string(), std::string()) < 0) {
 351                 _ERR("Failed to initialize PathManager");
 352                 return -1;
 353         }
 354
 355         std::string libCoreclr(concatPath(getRuntimeDir(), "libcoreclr.so"));
 356
 357         __coreclrLib = dlopen(libCoreclr.c_str(), RTLD_NOW | RTLD_LOCAL);
 358         if (__coreclrLib == nullptr) {
 359                 char *err = dlerror();
 360                 _ERR("dlopen failed to open libcoreclr.so with error %s", err);
 361                 if (access(libCoreclr.c_str(), R_OK) == -1)
 362                         _ERR("access '%s': %s\n", libCoreclr.c_str(), strerror(errno));
 363                 return -1;
 364         }
 365
 366 #define CORELIB_RETURN_IF_NOSYM(type, variable, name) \
 367         do { \
 368                 variable = (type)dlsym(__coreclrLib, name); \
 369                 if (variable == nullptr) { \
 370                         _ERR(name " is not found in the libcoreclr.so"); \
 371                         return -1; \
 372                 } \
 373         } while (0)
 374
 375         CORELIB_RETURN_IF_NOSYM(coreclr_initialize_ptr, initializeClr, "coreclr_initialize");
 376         CORELIB_RETURN_IF_NOSYM(coreclr_execute_assembly_ptr, executeAssembly, "coreclr_execute_assembly");
 377         CORELIB_RETURN_IF_NOSYM(coreclr_shutdown_ptr, shutdown, "coreclr_shutdown");
 378         CORELIB_RETURN_IF_NOSYM(coreclr_create_delegate_ptr, createDelegate, "coreclr_create_delegate");
 379         CORELIB_RETURN_IF_NOSYM(coreclr_preload_assembly_ptr, preloadAssembly, "coreclr_preload_assembly");
 380
 381 #undef CORELIB_RETURN_IF_NOSYM
 382
 383         _INFO("libcoreclr dlopen and dlsym success");
 384
 385 #define PRELOAD_IMAGE(path) \
 386         do { \
 387                 int st = preloadAssembly(path); \
 388                 if (st != 0) { \
 389                         _ERR("preload of %s failed! (0x%08x)", path, st); \
 390                 } else { \
 391                         _DBG("preload of %s succeded", path); \
 392                 } \
 393         } while (0)
 394
 395         if(!standalone) {
 396                 std::ifstream preloadList(AOT_PRELOAD_PATH);
 397                 if (preloadList) {
 398                         std::string path;
 399                         while (getline(preloadList, path)) {
 400                                 PRELOAD_IMAGE(absolutePath(path).c_str());
 401                         }
 402                 }
 403         }
 404
 405 #undef PRELOAD_IMAGE
 406
 407         return 0;
 408 }
 409
 410 int CoreRuntime::initialize(bool standalone)
 411 {
 412 #define __XSTR(x) #x
 413 #define __STR(x) __XSTR(x)
 414
 415 #ifdef NATIVE_LIB_DIR
 416         __nativeLibDirectory = __STR(NATIVE_LIB_DIR);
 417 #endif
 418
 419 #undef __STR
 420 #undef __XSTR
 421
 422         if (__enableLogManager) {
 423                 if (initializeLogManager() < 0) {
 424                         _ERR("Failed to initnialize LogManager");
 425                         return -1;
 426                 }
 427
 428                 if (redirectFD() < 0) {
 429                         _ERR("Failed to redirect FD");
 430                         return -1;
 431                 }
 432
 433                 if (runLoggingThread() < 0) {
 434                         _ERR("Failed to create and run logging thread to redicrect log");
 435                         return -1;
 436                 }
 437         }
 438
 439         if (!standalone)
 440                 pluginPreload();
 441
 442         fd = open("/proc/self", O_DIRECTORY);
 443         std::string appRoot = std::string("/proc/self/fd/") + std::to_string(fd);
 444         std::string appBin = concatPath(appRoot, "bin");
 445         std::string appLib = concatPath(appRoot, "lib");
 446         std::string appTac = concatPath(appBin, TAC_SYMLINK_SUB_DIR);
 447         std::string probePath = appBin + ":" + appLib + ":" + appTac;
 448         std::string NIprobePath = concatPath(appBin, APP_NI_SUB_DIR) + ":" + concatPath(appLib, APP_NI_SUB_DIR) + ":" + appTac;
 449         std::string tpa = getTPA();
 450         std::string runtimeDir = getRuntimeDir();
 451         std::string nativeLibPath = getExtraNativeLibDirs(appRoot) + ":" + appBin + ":" + appLib + ":" + __nativeLibDirectory + ":" + runtimeDir;
 452         std::string appName = std::string("dotnet-launcher-") + std::to_string(getpid());
 453
 454         if (!initializeCoreClr(appName.c_str(), probePath.c_str(), NIprobePath.c_str(), nativeLibPath.c_str(), tpa.c_str())) {
 455                 _ERR("Failed to initialize coreclr");
 456                 return -1;
 457         }
 458
 459         int st = createDelegate(__hostHandle, __domainId, "Dotnet.Launcher", "Dotnet.Launcher.Environment", "SetEnvironmentVariable", (void**)&setEnvironmentVariable);
 460         if (st < 0 || setEnvironmentVariable == nullptr) {
 461                 _ERR("Create delegate for Dotnet.Launcher.dll -> Dotnet.Launcher.Environment -> SetEnvironmentVariable failed (0x%08x)", st);
 462                 return -1;
 463         }
 464
 465         __initialized = true;
 466
 467         if (!standalone)
 468         {
 469                 // Preload common managed code.
 470                 preloadTypes();
 471
 472                 // This redundant call effectively reduces JIT overhead at launch time.
 473                 setEnvironmentVariable("XDG_DATA_HOME", "/");
 474         }
 475
 476         _INFO("CoreRuntime initialize success");
 477
 478         return 0;
 479 }
 480
 481 bool CoreRuntime::initializeCoreClr(const char* appId,
 482                                                                          const char* assemblyProbePaths,
 483                                                                          const char* NIProbePaths,
 484                                                                          const char* pinvokeProbePaths,
 485                                                                          const char* tpaList)
 486 {
 487         const char *propertyKeys[] = {
 488                 "TRUSTED_PLATFORM_ASSEMBLIES",
 489                 "APP_PATHS",
 490                 "APP_NI_PATHS",
 491                 "NATIVE_DLL_SEARCH_DIRECTORIES",
 492                 "AppDomainCompatSwitch"
 493         };
 494
 495         const char *propertyValues[] = {
 496                 tpaList,
 497                 assemblyProbePaths,
 498                 NIProbePaths,
 499                 pinvokeProbePaths,
 500                 "UseLatestBehaviorWhenTFMNotSpecified"
 501         };
 502
 503         std::string selfPath = readSelfPath();
 504
 505         int st = initializeClr(selfPath.c_str(),
 506                                                         appId,
 507                                                         sizeof(propertyKeys) / sizeof(propertyKeys[0]),
 508                                                         propertyKeys,
 509                                                         propertyValues,
 510                                                         &__hostHandle,
 511                                                         &__domainId);
 512
 513         if (st < 0) {
 514                 _ERR("initialize core clr fail! (0x%08x)", st);
 515                 return false;
 516         }
 517
 518         pluginSetCoreclrInfo(__hostHandle, __domainId, createDelegate);
 519
 520         _INFO("Initialize core clr success");
 521         return true;
 522 }
 523
 524 void CoreRuntime::dispose()
 525 {
 526         // call plugin finalize function to notify finalize to plugin
 527         // dlclose shoud be done after coreclr shutdown to avoid breaking signal chain
 528         pluginFinalize();
 529
 530         // ignore the signal generated by an exception that occurred during shutdown
 531         checkOnTerminate = true;
 532
 533         if (__hostHandle != nullptr) {
 534                 int st = shutdown(__hostHandle, __domainId);
 535                 if (st < 0)
 536                         _ERR("shutdown core clr fail! (0x%08x)", st);
 537                 __hostHandle = nullptr;
 538         }
 539
 540         if (__coreclrLib != nullptr) {
 541                 if (dlclose(__coreclrLib) != 0) {
 542                         _ERR("libcoreclr.so close failed");
 543                 }
 544
 545                 __coreclrLib = nullptr;
 546         }
 547
 548         finalizePluginManager();
 549         finalizePathManager();
 550
 551         __envList.clear();
 552
 553         _INFO("Dotnet runtime disposed");
 554 }
 555
 556 int CoreRuntime::launch(const char* appId, const char* root, const char* path, int argc, char* argv[])
 557 {
 558         if (!__initialized) {
 559                 _ERR("Runtime is not initialized");
 560                 return -1;
 561         }
 562
 563         if (path == nullptr) {
 564                 _ERR("executable path is null");
 565                 return -1;
 566         }
 567
 568         if (!isFileExist(path)) {
 569                 _ERR("File not exist : %s", path);
 570                 return -1;
 571         }
 572
 573         if (__enableLogManager) {
 574                 // launchpad override stdout and stderr to journalctl before launch application.
 575                 // we have to re-override that to input pipe for logging thread.
 576                 if (redirectFD() < 0) {
 577                         _ERR("Failed to redirect FD");
 578                         return -1;
 579                 }
 580
 581                 registerSigHandler();
 582         }
 583
 584         pluginSetAppInfo(appId, path);
 585
 586         int fd2 = open(root, O_DIRECTORY);
 587         dup3(fd2, fd, O_CLOEXEC);
 588         if (fd2 >= 0)
 589                 close(fd2);
 590
 591         // set application data path to coreclr environment.
 592         // application data path can be changed by owner. So, we have to set data path just before launching.
 593         char* localDataPath = app_get_data_path();
 594         if (localDataPath != nullptr) {
 595                 setEnvironmentVariable("XDG_DATA_HOME", localDataPath);
 596                 free(localDataPath);
 597         }
 598
 599         pluginBeforeExecute();
 600
 601         _INFO("execute assembly : %s", path);
 602
 603         unsigned int ret = 0;
 604         int st = executeAssembly(__hostHandle, __domainId, argc, (const char**)argv, path, &ret);
 605         if (st < 0)
 606                 _ERR("Failed to Execute Assembly %s (0x%08x)", path, st);
 607         return ret;
 608 }
 609
 610 }  // namespace dotnetcore
 611 }  // namespace runtime
 612 }  // namespace tizen