NativeLauncher/launcher/lib/core_runtime.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 #include <dirent.h>
  21
  22 #include <string>
  23 #include <fstream>
  24 #include <vector>
  25 #include <sstream>
  26
  27 #include <locale>
  28 #include <codecvt>
  29
  30 #include <fcntl.h>
  31 #include <sys/stat.h>
  32 #include <sys/types.h>
  33 #include <sys/wait.h>
  34 #include <unistd.h>
  35 #include <linux/limits.h>
  36 #include <pthread.h>
  37
  38 #include <storage.h>
  39 #include <vconf.h>
  40 #include <app_common.h>
  41
  42 #include <Ecore.h>
  43
  44 #include "injection.h"
  45 #include "utils.h"
  46 #include "log.h"
  47 #include "core_runtime.h"
  48 #include "plugin_manager.h"
  49 #include "path_manager.h"
  50
  51 namespace tizen {
  52 namespace runtime {
  53 namespace dotnetcore {
  54
  55 static coreclr_initialize_ptr initializeClr = nullptr;
  56 static coreclr_execute_assembly_ptr executeAssembly = nullptr;
  57 static coreclr_shutdown_ptr shutdown = nullptr;
  58 static coreclr_create_delegate_ptr createDelegate = nullptr;
  59 static set_environment_variable_ptr setEnvironmentVariable = nullptr;
  60 static stop_profile_after_delay_ptr stopProfileAfterDelay = nullptr;
  61 static set_switch_ptr setSwitch = nullptr;
  62 static void* __coreclrLib = nullptr;
  63 static void* __hostHandle = nullptr;
  64 static unsigned int __domainId = -1;
  65 static bool __initialized = false;
  66 static bool __isProfileMode = false;
  67 PathManager* CoreRuntime::__pm = nullptr;
  68
  69 #define MAX_DELAY_SEC 100
  70
  71 static std::vector<std::string> __envList;
  72
  73 static void setEnvFromFile()
  74 {
  75         std::string envList;
  76         std::ifstream inFile(ENV_FILE_PATH);
  77
  78         __envList.clear();
  79
  80         if (inFile) {
  81                 _INFO("coreclr_env.list is found");
  82
  83                 std::string token;
  84                 while (std::getline(inFile, token, '\n')) {
  85                         if (!token.empty()) {
  86                                 __envList.push_back(token);
  87                         }
  88                 }
  89
  90                 for (unsigned int i = 0; i < __envList.size(); i++) {
  91                         putenv(const_cast<char *>(__envList[i].c_str()));
  92                 }
  93         } else {
  94                 _INFO("coreclr_env.list file is not found. skip");
  95         }
  96 }
  97
  98 #define _unused(x) ((void)(x))
  99
 100 struct sigaction sig_abrt_new;
 101 struct sigaction sig_abrt_old;
 102
 103 static bool checkOnSigabrt = false;
 104 static bool checkOnTerminate = false;
 105
 106 static void onSigabrt(int signum)
 107 {
 108         // use unused variable to avoid build warning
 109         ssize_t ret = write(STDERR_FILENO, "onSigabrt called\n", 17);
 110
 111         if (checkOnTerminate) {
 112                 ret = write(STDERR_FILENO, "onSigabrt called while terminate. go to exit\n", 45);
 113                 _unused(ret);
 114                 exit(0);
 115         }
 116
 117         if (checkOnSigabrt) {
 118                 ret = write(STDERR_FILENO, "onSigabrt called again. go to exit\n", 35);
 119                 _unused(ret);
 120                 exit(0);
 121         }
 122
 123         checkOnSigabrt = true;
 124         if (sigaction(SIGABRT, &sig_abrt_old, NULL) == 0) {
 125                 if (raise(signum) < 0) {
 126                         ret = write(STDERR_FILENO, "Fail to raise SIGABRT\n", 22);
 127                 }
 128         } else {
 129                 ret = write(STDERR_FILENO, "Fail to set original SIGABRT handler\n", 37);
 130         }
 131         _unused(ret);
 132 }
 133
 134 static void registerSigHandler()
 135 {
 136         sig_abrt_new.sa_handler = onSigabrt;
 137         if (sigemptyset(&sig_abrt_new.sa_mask) != 0) {
 138                 _ERR("Fail to sigemptyset");
 139         }
 140
 141         if (sigaction(SIGABRT, &sig_abrt_new, &sig_abrt_old) < 0) {
 142                 _ERR("Fail to add sig handler");
 143         }
 144 }
 145
 146 static bool storage_cb(int id, storage_type_e type, storage_state_e state, const char *path, void *user_data)
 147 {
 148         int* tmp = (int*)user_data;
 149         if (type == STORAGE_TYPE_INTERNAL)
 150         {
 151                 *tmp = id;
 152                 return false;
 153         }
 154
 155         return true;
 156 }
 157
 158 static void setSpecialFolder(storage_directory_e type, const char* key)
 159 {
 160         int error;
 161         char* path = NULL;
 162         static int __storageId = -1;
 163
 164         if (__storageId < 0) {
 165                 error = storage_foreach_device_supported(storage_cb, &__storageId);
 166                 if (error != STORAGE_ERROR_NONE) {
 167                         return;
 168                 }
 169         }
 170
 171         error = storage_get_directory(__storageId, type, &path);
 172         if (error == STORAGE_ERROR_NONE && path != NULL) {
 173                 setenv(key, const_cast<char *>(path), 1);
 174                 free(path);
 175         }
 176 }
 177
 178 static void initEnvForSpecialFolder()
 179 {
 180         if (getenv("XDG_PICTURES_DIR") == NULL) {
 181                 setSpecialFolder(STORAGE_DIRECTORY_IMAGES, "XDG_PICTURES_DIR");
 182         }
 183
 184         if (getenv("XDG_MUSIC_DIR") == NULL) {
 185                 setSpecialFolder(STORAGE_DIRECTORY_MUSIC, "XDG_MUSIC_DIR");
 186         }
 187
 188         if (getenv("XDG_VIDEOS_DIR") == NULL) {
 189                 setSpecialFolder(STORAGE_DIRECTORY_VIDEOS, "XDG_VIDEOS_DIR");
 190         }
 191 }
 192
 193 static void setLang()
 194 {
 195         char* lang = vconf_get_str(VCONFKEY_LANGSET);
 196         if (!lang) {
 197                 _ERR("Fail to get language from vconf");
 198                 return;
 199         }
 200
 201         // In order to operate ICU (used for globalization) normally, the following
 202         // environment variables must be set before using ICU API.
 203         // When running Applicaiton, the following environment variables are set by AppFW.
 204         // But when preloading the dll in the candidate process, the following environment variables are not set
 205         // As a result, CultureInfo is incorrectly generated and malfunctions.
 206         // For example, uloc_getDefault() returns en_US_POSIX, CultureInfo is set to invariant mode.
 207         setenv("LANG", const_cast<char *>(lang), 1);
 208         setlocale(LC_ALL, const_cast<char *>(lang));
 209
 210         free(lang);
 211 }
 212
 213 static std::string readSelfPath()
 214 {
 215         char buff[PATH_MAX];
 216         ssize_t len = ::readlink("/proc/self/exe", buff, sizeof(buff)-1);
 217         if (len != -1) {
 218                 buff[len] = '\0';
 219                 return std::string(buff);
 220         }
 221
 222         return "";
 223 }
 224
 225 static void removeDebugPipe()
 226 {
 227         DIR *dir;
 228         struct dirent* entry;
 229         char debugPipeFiles[PATH_MAX];;
 230         sprintf(debugPipeFiles, "/tmp/clr-debug-pipe-%d-", getpid());
 231
 232         dir = opendir("/tmp");
 233         if (dir == nullptr) {
 234                 _ERR("Fail to open /tmp directory");
 235                 return;
 236         }
 237
 238         while ((entry = readdir(dir)) != nullptr) {
 239                 std::string path = concatPath("/tmp", entry->d_name);
 240                 if (path.find(debugPipeFiles) != std::string::npos) {
 241                         if (!removeFile(path)) {
 242                                 _ERR("Fail to remove file (%s)", path.c_str());
 243                         }
 244                 }
 245         }
 246
 247         closedir(dir);
 248 }
 249
 250 void preload()
 251 {
 252         typedef void (*PreloadDelegate)();
 253         PreloadDelegate preloadDelegate;
 254
 255         int ret = createDelegate(__hostHandle,
 256                 __domainId,
 257                 "Tizen.Runtime",
 258                 "Tizen.Runtime.Preloader",
 259                 "Preload",
 260                 (void**)&preloadDelegate);
 261
 262         if (ret < 0) {
 263                 _ERR("Failed to create delegate for Tizen.Runtime Preload (0x%08x)", ret);
 264         } else {
 265                 preloadDelegate();
 266         }
 267
 268         pluginPreload();
 269 }
 270
 271 static pthread_t preloadThreadId = 0;
 272 static void* preloadThread(void* arg)
 273 {
 274         _INFO("PreloadThread START\n");
 275         preload();
 276         _INFO("PreloadThread END\n");
 277         pthread_exit(NULL);
 278 }
 279
 280 bool initializeCoreClr(PathManager* pm, const std::string& tpa)
 281 {
 282         bool ncdbStartupHook = isNCDBStartupHookProvided();
 283
 284         const char *propertyKeys[] = {
 285                 "TRUSTED_PLATFORM_ASSEMBLIES",
 286                 "APP_PATHS",
 287                 "APP_NI_PATHS",
 288                 "NATIVE_DLL_SEARCH_DIRECTORIES",
 289                 "AppDomainCompatSwitch",
 290                 ncdbStartupHook ? "STARTUP_HOOKS" : "" // must be the last one
 291         };
 292
 293         const char *propertyValues[] = {
 294                 tpa.c_str(),
 295                 pm->getAppPaths().c_str(),
 296                 pm->getAppNIPaths().c_str(),
 297                 pm->getNativeDllSearchingPaths().c_str(),
 298                 "UseLatestBehaviorWhenTFMNotSpecified",
 299                 ncdbStartupHook ? getNCDBStartupHook() : "" // must be the last one
 300         };
 301
 302         std::string selfPath = readSelfPath();
 303
 304         int st = initializeClr(selfPath.c_str(),
 305                                                         "TizenDotnetApp",
 306                                                         sizeof(propertyKeys) / sizeof(propertyKeys[0]) - (ncdbStartupHook ? 0 : 1),
 307                                                         propertyKeys,
 308                                                         propertyValues,
 309                                                         &__hostHandle,
 310                                                         &__domainId);
 311
 312         if (st < 0) {
 313                 _ERR("initialize core clr fail! (0x%08x)", st);
 314                 return false;
 315         }
 316
 317         pluginSetCoreclrInfo(__hostHandle, __domainId, createDelegate);
 318
 319         _INFO("Initialize core clr success");
 320         return true;
 321 }
 322
 323 int CoreRuntime::initialize(const char* appType, LaunchMode launchMode)
 324 {
 325         if (__initialized) {
 326                 _ERR("CoreRuntime is already initialized");
 327                 return -1;
 328         }
 329
 330         // Intiailize ecore first (signal handlers, etc.) before runtime init.
 331         ecore_init();
 332
 333         // set language environment to support ICU
 334         setLang();
 335
 336         char *env = nullptr;
 337         env = getenv("CORECLR_ENABLE_PROFILING");
 338         if (env != nullptr && !strcmp(env, "1")) {
 339                 _INFO("profiling mode on");
 340                 __isProfileMode = true;
 341         }
 342
 343         // plugin initialize should be called before creating threads.
 344         // In case of VD plugins, attaching secure zone is done in the plugin_initialize().
 345         // When attaching to a secure zone, if there is a created thread, it will failed.
 346         // So, plugin initialize should be called before creating threads.
 347         if (initializePluginManager(appType) < 0) {
 348                 _ERR("Failed to initialize PluginManager");
 349                 return -1;
 350         }
 351
 352         // checkInjection checks dotnet-launcher run mode
 353         // At the moment, this mechanism is used only when the Memory Profiler is started.
 354         int res = checkInjection();
 355         if (res != 0) {
 356                 _ERR("Failed to initnialize Memory Profiler");
 357                 return -1;
 358         }
 359
 360 #ifdef __arm__
 361         // libunwind library is used to unwind stack frame, but libunwind for ARM
 362         // does not support ARM vfpv3/NEON registers in DWARF format correctly.
 363         // Therefore let's disable stack unwinding using DWARF information
 364         // See https://github.com/dotnet/coreclr/issues/6698
 365         //
 366         // libunwind use following methods to unwind stack frame.
 367         // UNW_ARM_METHOD_ALL           0xFF
 368         // UNW_ARM_METHOD_DWARF         0x01
 369         // UNW_ARM_METHOD_FRAME         0x02
 370         // UNW_ARM_METHOD_EXIDX         0x04
 371         putenv(const_cast<char *>("UNW_ARM_UNWIND_METHOD=6"));
 372 #endif // __arm__
 373
 374         // Enable diagnostics.
 375         // clr create clr-debug-pipe-xxx and dotnet-diagnostics-xxx file under /tmp dir.
 376         putenv(const_cast<char *>("COMPlus_EnableDiagnostics=1"));
 377
 378         // Write Debug.WriteLine to stderr
 379         putenv(const_cast<char *>("COMPlus_DebugWriteToStdErr=1"));
 380
 381 #ifdef USE_DEFAULT_BASE_ADDR
 382         putenv(const_cast<char *>("COMPlus_UseDefaultBaseAddr=1"));
 383 #endif // USE_DEFAULT_BASE_ADDR
 384
 385         // Disable config cache to set environment after coreclr_initialize()
 386         putenv(const_cast<char *>("COMPlus_DisableConfigCache=1"));
 387
 388         // read string from external file and set them to environment value.
 389         setEnvFromFile();
 390
 391         try {
 392                 __pm = new PathManager();
 393         } catch (const std::exception& e) {
 394                 _ERR("Failed to create PathManager");
 395                 return -1;
 396         }
 397
 398         char* pluginDllPaths = pluginGetDllPath();
 399         if (pluginDllPaths && pluginDllPaths[0] != '\0') {
 400                 __pm->addPlatformAssembliesPaths(pluginDllPaths, true);
 401         }
 402
 403         char* pluginNativePaths = pluginGetNativeDllSearchingPath();
 404         if (pluginNativePaths && pluginNativePaths[0] != '\0') {
 405                 __pm->addNativeDllSearchingPaths(pluginNativePaths, true);
 406         }
 407
 408         char* pluginExtraDllPaths = pluginGetExtraDllPath();
 409         if (pluginExtraDllPaths && pluginExtraDllPaths[0] != '\0') {
 410                 __pm->setExtraDllPaths(pluginExtraDllPaths);
 411         }
 412
 413         pluginHasLogControl();
 414
 415         std::string libCoreclr(concatPath(__pm->getRuntimePath(), "libcoreclr.so"));
 416
 417         __coreclrLib = dlopen(libCoreclr.c_str(), RTLD_NOW | RTLD_LOCAL);
 418         if (__coreclrLib == nullptr) {
 419                 char *err = dlerror();
 420                 _ERR("dlopen failed to open libcoreclr.so with error %s", err);
 421                 return -1;
 422         }
 423
 424 #define CORELIB_RETURN_IF_NOSYM(type, variable, name) \
 425         do { \
 426                 variable = (type)dlsym(__coreclrLib, name); \
 427                 if (variable == nullptr) { \
 428                         _ERR(name " is not found in the libcoreclr.so"); \
 429                         return -1; \
 430                 } \
 431         } while (0)
 432
 433         CORELIB_RETURN_IF_NOSYM(coreclr_initialize_ptr, initializeClr, "coreclr_initialize");
 434         CORELIB_RETURN_IF_NOSYM(coreclr_execute_assembly_ptr, executeAssembly, "coreclr_execute_assembly");
 435         CORELIB_RETURN_IF_NOSYM(coreclr_shutdown_ptr, shutdown, "coreclr_shutdown");
 436         CORELIB_RETURN_IF_NOSYM(coreclr_create_delegate_ptr, createDelegate, "coreclr_create_delegate");
 437
 438 #undef CORELIB_RETURN_IF_NOSYM
 439
 440         _INFO("libcoreclr dlopen and dlsym success");
 441
 442         // Set environment for System.Environment.SpecialFolder
 443         // Below function creates dbus connection by callging storage API.
 444         // If dbus connection is created bofere fork(), forked process cannot use dbus.
 445         // To avoid gdbus blocking issue, below function should be called after fork()
 446         initEnvForSpecialFolder();
 447
 448         std::string tpa;
 449         char* pluginTPA = pluginGetTPA();
 450         if (pluginTPA && pluginTPA[0] != '\0') {
 451                 tpa = std::string(pluginTPA);
 452         } else {
 453                 addAssembliesFromDirectories(__pm->getPlatformAssembliesPaths(), tpa);
 454         }
 455
 456         if (!initializeCoreClr(__pm, tpa)) {
 457                 _ERR("Failed to initialize coreclr");
 458                 return -1;
 459         }
 460
 461         int st = createDelegate(__hostHandle, __domainId, "Tizen.Runtime", "Tizen.Runtime.Environment", "SetEnvironmentVariable", (void**)&setEnvironmentVariable);
 462         if (st < 0 || setEnvironmentVariable == nullptr) {
 463                 _ERR("Create delegate for Tizen.Runtime.dll -> Tizen.Runtime.Environment -> SetEnvironmentVariable failed (0x%08x)", st);
 464                 return -1;
 465         }
 466
 467         st = createDelegate(__hostHandle, __domainId, "Tizen.Runtime", "Tizen.Runtime.Profiler", "StopProfileAfterDelay", (void**)&stopProfileAfterDelay);
 468         if (st < 0 || stopProfileAfterDelay == nullptr) {
 469                 _ERR("Create delegate for Tizen.Runtime.dll -> Tizen.Runtime.Profiler -> StopProfileAfterDelay failed (0x%08x)", st);
 470                 return -1;
 471         }
 472
 473         st = createDelegate(__hostHandle, __domainId, "Tizen.Runtime", "Tizen.Runtime.AppSetting", "SetSwitch", (void**)&setSwitch);
 474         if (st < 0 || setSwitch == nullptr) {
 475                 _ERR("Create delegate for Tizen.Runtime.dll -> Tizen.Runtime.AppSetting -> SetSwitch failed (0x%08x)", st);
 476                 return -1;
 477         }
 478
 479         // preload libraries and manage dlls for optimizing startup time
 480         int err = pthread_create(&preloadThreadId, NULL, preloadThread, NULL);
 481         if (err) {
 482                 _ERR("PreloadThread Creation Failed: %s", strerror(err));
 483         }
 484
 485         if (launchMode == LaunchMode::loader) {
 486                 // The debug pipe created in the candidate process has a "User" label.
 487                 // As a result, smack deny occurs when app process try to access the debug pipe.
 488                 // Also, since debugging is performed only in standalone mode,
 489                 // the debug pipe doesnot be used in the candidate process.
 490                 // So, to avoid smack deny error, delete unused debug pipe files.
 491                 removeDebugPipe();
 492         }
 493
 494         __initialized = true;
 495
 496         _INFO("CoreRuntime initialize success");
 497
 498         return 0;
 499 }
 500
 501 void CoreRuntime::finalize()
 502 {
 503         // call plugin finalize function to notify finalize to plugin
 504         // dlclose shoud be done after coreclr shutdown to avoid breaking signal chain
 505         pluginFinalize();
 506
 507         // ignore the signal generated by an exception that occurred during shutdown
 508         checkOnTerminate = true;
 509
 510         // workaround : to prevent crash while process terminate on profiling mode,
 511         //                              kill process immediately.
 512         // see https://github.com/dotnet/coreclr/issues/26687
 513         if (__isProfileMode) {
 514                 _INFO("shutdown process immediately.");
 515                 _exit(0);
 516         }
 517
 518         if (__hostHandle != nullptr) {
 519                 int st = shutdown(__hostHandle, __domainId);
 520                 if (st < 0)
 521                         _ERR("shutdown core clr fail! (0x%08x)", st);
 522                 __hostHandle = nullptr;
 523         }
 524
 525         if (__coreclrLib != nullptr) {
 526                 if (dlclose(__coreclrLib) != 0) {
 527                         _ERR("libcoreclr.so close failed");
 528                 }
 529
 530                 __coreclrLib = nullptr;
 531         }
 532
 533         finalizePluginManager();
 534
 535         delete __pm;
 536         __pm = NULL;
 537
 538         __envList.clear();
 539
 540         _INFO("CoreRuntime finalized");
 541 }
 542
 543 int CoreRuntime::launch(const char* appId, const char* root, const char* path, int argc, char* argv[], bool profile)
 544 {
 545         if (!__initialized) {
 546                 _ERR("Runtime is not initialized");
 547                 return -1;
 548         }
 549
 550         if (path == nullptr) {
 551                 _ERR("executable path is null");
 552                 return -1;
 553         }
 554
 555         if (!isFile(path)) {
 556                 _ERR("File not exist : %s", path);
 557                 return -1;
 558         }
 559
 560         // VD has their own signal handler.
 561         if (!pluginHasLogControl()) {
 562                 registerSigHandler();
 563         }
 564
 565         pluginSetAppInfo(appId, path);
 566
 567         // temporal root path is overrided to real application root path
 568         __pm->setAppRootPath(root);
 569
 570         // set application data path to coreclr environment.
 571         // application data path can be changed by owner. So, we have to set data path just before launching.
 572         char* localDataPath = app_get_data_path();
 573         if (localDataPath != nullptr) {
 574                 setEnvironmentVariable("XDG_DATA_HOME", localDataPath);
 575
 576                 // set profile.data path and collect/use it if it non-exists/exists.
 577                 if (profile) {
 578                         char multiCoreJitProfile[strlen(localDataPath) + strlen(PROFILE_BASENAME) + 1];
 579                         memcpy(multiCoreJitProfile, localDataPath, strlen(localDataPath) + 1);
 580                         strncat(multiCoreJitProfile, PROFILE_BASENAME, strlen(PROFILE_BASENAME));
 581
 582                         setEnvironmentVariable("COMPlus_MultiCoreJitProfile", multiCoreJitProfile);
 583                         setEnvironmentVariable("COMPlus_MultiCoreJitMinNumCpus", "1");
 584
 585                         if (exist(multiCoreJitProfile)) {
 586                                 setEnvironmentVariable("COMPlus_MultiCoreJitNoProfileGather", "1");
 587                                 _INFO("MCJ playing start for %s", appId);
 588                         } else {
 589                                 setEnvironmentVariable("COMPlus_MultiCoreJitNoProfileGather", "0");
 590                                 // stop profiling and write collected data after delay if env value is set.
 591                                 char *env = getenv("CLR_MCJ_PROFILE_WRITE_DELAY");
 592                                 if (env != nullptr) {
 593                                         int delay = std::atoi(env);
 594                                         // To avoid undefined behavior by out-of-range input(atoi), set max delay value to 100.
 595                                         if (delay > 0) {
 596                                                 if (delay > MAX_DELAY_SEC) delay = MAX_DELAY_SEC;
 597                                                 stopProfileAfterDelay(delay);
 598                                         }
 599                                 }
 600                                 _INFO("MCJ recording start for %s", appId);
 601                         }
 602                 }
 603                 free(localDataPath);
 604         }
 605
 606         if (exist(__pm->getAppRootPath() + "/bin/" + DISABLE_IPV6_FILE)) {
 607                 setSwitch("System.Net.DisableIPv6", true);
 608         }
 609
 610         setSwitch("Switch.System.Diagnostics.StackTrace.ShowILOffsets", true);
 611
 612         pluginBeforeExecute();
 613
 614         _INFO("execute assembly : %s", path);
 615
 616         unsigned int ret = 0;
 617         int st = executeAssembly(__hostHandle, __domainId, argc, (const char**)argv, path, &ret);
 618         if (st < 0)
 619                 _ERR("Failed to Execute Assembly %s (0x%08x)", path, st);
 620         return ret;
 621 }
 622
 623 }  // namespace dotnetcore
 624 }  // namespace runtime
 625 }  // namespace tizen