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         //To reduce search overhead of libicuuc.so.xx
 196         setenv("CLR_ICU_VERSION_OVERRIDE", "build", 1);
 197
 198         char* lang = vconf_get_str(VCONFKEY_LANGSET);
 199         if (!lang) {
 200                 _ERR("Fail to get language from vconf");
 201                 return;
 202         }
 203
 204         // In order to operate ICU (used for globalization) normally, the following
 205         // environment variables must be set before using ICU API.
 206         // When running Applicaiton, the following environment variables are set by AppFW.
 207         // But when preloading the dll in the candidate process, the following environment variables are not set
 208         // As a result, CultureInfo is incorrectly generated and malfunctions.
 209         // For example, uloc_getDefault() returns en_US_POSIX, CultureInfo is set to invariant mode.
 210         setenv("LANG", const_cast<char *>(lang), 1);
 211         setlocale(LC_ALL, const_cast<char *>(lang));
 212
 213         free(lang);
 214 }
 215
 216 static std::string readSelfPath()
 217 {
 218         char buff[PATH_MAX];
 219         ssize_t len = ::readlink("/proc/self/exe", buff, sizeof(buff)-1);
 220         if (len != -1) {
 221                 buff[len] = '\0';
 222                 return std::string(buff);
 223         }
 224
 225         return "";
 226 }
 227
 228 static void removeDebugPipe()
 229 {
 230         DIR *dir;
 231         struct dirent* entry;
 232         char debugPipeFiles[PATH_MAX];;
 233         sprintf(debugPipeFiles, "/tmp/clr-debug-pipe-%d-", getpid());
 234
 235         dir = opendir("/tmp");
 236         if (dir == nullptr) {
 237                 _ERR("Fail to open /tmp directory");
 238                 return;
 239         }
 240
 241         while ((entry = readdir(dir)) != nullptr) {
 242                 std::string path = concatPath("/tmp", entry->d_name);
 243                 if (path.find(debugPipeFiles) != std::string::npos) {
 244                         if (!removeFile(path)) {
 245                                 _ERR("Fail to remove file (%s)", path.c_str());
 246                         }
 247                 }
 248         }
 249
 250         closedir(dir);
 251 }
 252
 253 void preload()
 254 {
 255         typedef void (*PreloadDelegate)();
 256         PreloadDelegate preloadDelegate;
 257
 258         int ret = createDelegate(__hostHandle,
 259                 __domainId,
 260                 "Tizen.Runtime",
 261                 "Tizen.Runtime.Preloader",
 262                 "Preload",
 263                 (void**)&preloadDelegate);
 264
 265         if (ret < 0) {
 266                 _ERR("Failed to create delegate for Tizen.Runtime Preload (0x%08x)", ret);
 267         } else {
 268                 preloadDelegate();
 269         }
 270
 271         pluginPreload();
 272 }
 273
 274 bool initializeCoreClr(PathManager* pm, const std::string& tpa)
 275 {
 276         bool ncdbStartupHook = isNCDBStartupHookProvided();
 277
 278         const char *propertyKeys[] = {
 279                 "TRUSTED_PLATFORM_ASSEMBLIES",
 280                 "APP_PATHS",
 281                 "APP_NI_PATHS",
 282                 "NATIVE_DLL_SEARCH_DIRECTORIES",
 283                 "AppDomainCompatSwitch",
 284                 ncdbStartupHook ? "STARTUP_HOOKS" : "" // must be the last one
 285         };
 286
 287         const char *propertyValues[] = {
 288                 tpa.c_str(),
 289                 pm->getAppPaths().c_str(),
 290                 pm->getAppNIPaths().c_str(),
 291                 pm->getNativeDllSearchingPaths().c_str(),
 292                 "UseLatestBehaviorWhenTFMNotSpecified",
 293                 ncdbStartupHook ? getNCDBStartupHook() : "" // must be the last one
 294         };
 295
 296         std::string selfPath = readSelfPath();
 297
 298         int st = initializeClr(selfPath.c_str(),
 299                                                         "TizenDotnetApp",
 300                                                         sizeof(propertyKeys) / sizeof(propertyKeys[0]) - (ncdbStartupHook ? 0 : 1),
 301                                                         propertyKeys,
 302                                                         propertyValues,
 303                                                         &__hostHandle,
 304                                                         &__domainId);
 305
 306         if (st < 0) {
 307                 _ERR("initialize core clr fail! (0x%08x)", st);
 308                 return false;
 309         }
 310
 311         pluginSetCoreclrInfo(__hostHandle, __domainId, createDelegate);
 312
 313         _INFO("Initialize core clr success");
 314         return true;
 315 }
 316
 317 int CoreRuntime::initialize(const char* appType, LaunchMode launchMode)
 318 {
 319         if (__initialized) {
 320                 _ERR("CoreRuntime is already initialized");
 321                 return -1;
 322         }
 323
 324         // set language environment to support ICU
 325         setLang();
 326
 327         char *env = nullptr;
 328         env = getenv("CORECLR_ENABLE_PROFILING");
 329         if (env != nullptr && !strcmp(env, "1")) {
 330                 _INFO("profiling mode on");
 331                 __isProfileMode = true;
 332         }
 333
 334         // plugin initialize should be called before creating threads.
 335         // In case of VD plugins, attaching secure zone is done in the plugin_initialize().
 336         // When attaching to a secure zone, if there is a created thread, it will failed.
 337         // So, plugin initialize should be called before creating threads.
 338         if (initializePluginManager(appType) < 0) {
 339                 _ERR("Failed to initialize PluginManager");
 340                 return -1;
 341         }
 342
 343         // checkInjection checks dotnet-launcher run mode
 344         // At the moment, this mechanism is used only when the Memory Profiler is started.
 345         int res = checkInjection();
 346         if (res != 0) {
 347                 _ERR("Failed to initnialize Memory Profiler");
 348                 return -1;
 349         }
 350
 351 #ifdef __arm__
 352         // libunwind library is used to unwind stack frame, but libunwind for ARM
 353         // does not support ARM vfpv3/NEON registers in DWARF format correctly.
 354         // Therefore let's disable stack unwinding using DWARF information
 355         // See https://github.com/dotnet/coreclr/issues/6698
 356         //
 357         // libunwind use following methods to unwind stack frame.
 358         // UNW_ARM_METHOD_ALL           0xFF
 359         // UNW_ARM_METHOD_DWARF         0x01
 360         // UNW_ARM_METHOD_FRAME         0x02
 361         // UNW_ARM_METHOD_EXIDX         0x04
 362         putenv(const_cast<char *>("UNW_ARM_UNWIND_METHOD=6"));
 363 #endif // __arm__
 364
 365         // Enable diagnostics.
 366         // clr create clr-debug-pipe-xxx and dotnet-diagnostics-xxx file under /tmp dir.
 367         putenv(const_cast<char *>("COMPlus_EnableDiagnostics=1"));
 368
 369         // Write Debug.WriteLine to stderr
 370         putenv(const_cast<char *>("COMPlus_DebugWriteToStdErr=1"));
 371
 372 #ifdef USE_DEFAULT_BASE_ADDR
 373         putenv(const_cast<char *>("COMPlus_UseDefaultBaseAddr=1"));
 374 #endif // USE_DEFAULT_BASE_ADDR
 375
 376         // Disable config cache to set environment after coreclr_initialize()
 377         putenv(const_cast<char *>("COMPlus_DisableConfigCache=1"));
 378
 379         // read string from external file and set them to environment value.
 380         setEnvFromFile();
 381
 382         try {
 383                 __pm = new PathManager();
 384         } catch (const std::exception& e) {
 385                 _ERR("Failed to create PathManager");
 386                 return -1;
 387         }
 388
 389         char* pluginDllPaths = pluginGetDllPath();
 390         if (pluginDllPaths && pluginDllPaths[0] != '\0') {
 391                 __pm->addPlatformAssembliesPaths(pluginDllPaths, true);
 392         }
 393
 394         char* pluginNativePaths = pluginGetNativeDllSearchingPath();
 395         if (pluginNativePaths && pluginNativePaths[0] != '\0') {
 396                 __pm->addNativeDllSearchingPaths(pluginNativePaths, true);
 397         }
 398
 399         char* pluginExtraDllPaths = pluginGetExtraDllPath();
 400         if (pluginExtraDllPaths && pluginExtraDllPaths[0] != '\0') {
 401                 __pm->setExtraDllPaths(pluginExtraDllPaths);
 402         }
 403
 404         pluginHasLogControl();
 405
 406         std::string libCoreclr(concatPath(__pm->getRuntimePath(), "libcoreclr.so"));
 407
 408         __coreclrLib = dlopen(libCoreclr.c_str(), RTLD_NOW | RTLD_LOCAL);
 409         if (__coreclrLib == nullptr) {
 410                 char *err = dlerror();
 411                 _ERR("dlopen failed to open libcoreclr.so with error %s", err);
 412                 return -1;
 413         }
 414
 415 #define CORELIB_RETURN_IF_NOSYM(type, variable, name) \
 416         do { \
 417                 variable = (type)dlsym(__coreclrLib, name); \
 418                 if (variable == nullptr) { \
 419                         _ERR(name " is not found in the libcoreclr.so"); \
 420                         return -1; \
 421                 } \
 422         } while (0)
 423
 424         CORELIB_RETURN_IF_NOSYM(coreclr_initialize_ptr, initializeClr, "coreclr_initialize");
 425         CORELIB_RETURN_IF_NOSYM(coreclr_execute_assembly_ptr, executeAssembly, "coreclr_execute_assembly");
 426         CORELIB_RETURN_IF_NOSYM(coreclr_shutdown_ptr, shutdown, "coreclr_shutdown");
 427         CORELIB_RETURN_IF_NOSYM(coreclr_create_delegate_ptr, createDelegate, "coreclr_create_delegate");
 428
 429 #undef CORELIB_RETURN_IF_NOSYM
 430
 431         _INFO("libcoreclr dlopen and dlsym success");
 432
 433         // Set environment for System.Environment.SpecialFolder
 434         // Below function creates dbus connection by callging storage API.
 435         // If dbus connection is created bofere fork(), forked process cannot use dbus.
 436         // To avoid gdbus blocking issue, below function should be called after fork()
 437         initEnvForSpecialFolder();
 438
 439         std::string tpa;
 440         char* pluginTPA = pluginGetTPA();
 441         if (pluginTPA && pluginTPA[0] != '\0') {
 442                 tpa = std::string(pluginTPA);
 443         } else {
 444                 addAssembliesFromDirectories(__pm->getPlatformAssembliesPaths(), tpa);
 445         }
 446
 447         if (!initializeCoreClr(__pm, tpa)) {
 448                 _ERR("Failed to initialize coreclr");
 449                 return -1;
 450         }
 451
 452         int st = createDelegate(__hostHandle, __domainId, "Tizen.Runtime", "Tizen.Runtime.Environment", "SetEnvironmentVariable", (void**)&setEnvironmentVariable);
 453         if (st < 0 || setEnvironmentVariable == nullptr) {
 454                 _ERR("Create delegate for Tizen.Runtime.dll -> Tizen.Runtime.Environment -> SetEnvironmentVariable failed (0x%08x)", st);
 455                 return -1;
 456         }
 457
 458         st = createDelegate(__hostHandle, __domainId, "Tizen.Runtime", "Tizen.Runtime.Profiler", "StopProfileAfterDelay", (void**)&stopProfileAfterDelay);
 459         if (st < 0 || stopProfileAfterDelay == nullptr) {
 460                 _ERR("Create delegate for Tizen.Runtime.dll -> Tizen.Runtime.Profiler -> StopProfileAfterDelay failed (0x%08x)", st);
 461                 return -1;
 462         }
 463
 464         st = createDelegate(__hostHandle, __domainId, "Tizen.Runtime", "Tizen.Runtime.AppSetting", "SetSwitch", (void**)&setSwitch);
 465         if (st < 0 || setSwitch == nullptr) {
 466                 _ERR("Create delegate for Tizen.Runtime.dll -> Tizen.Runtime.AppSetting -> SetSwitch failed (0x%08x)", st);
 467                 return -1;
 468         }
 469
 470         if (launchMode == LaunchMode::loader) {
 471                 // preload libraries and manage dlls for optimizing startup time
 472                 preload();
 473
 474                 // The debug pipe created in the candidate process has a "User" label.
 475                 // As a result, smack deny occurs when app process try to access the debug pipe.
 476                 // Also, since debugging is performed only in standalone mode,
 477                 // the debug pipe doesnot be used in the candidate process.
 478                 // So, to avoid smack deny error, delete unused debug pipe files.
 479                 removeDebugPipe();
 480         }
 481
 482         __initialized = true;
 483
 484         _INFO("CoreRuntime initialize success");
 485
 486         return 0;
 487 }
 488
 489 void CoreRuntime::finalize()
 490 {
 491         // call plugin finalize function to notify finalize to plugin
 492         // dlclose shoud be done after coreclr shutdown to avoid breaking signal chain
 493         pluginFinalize();
 494
 495         // ignore the signal generated by an exception that occurred during shutdown
 496         checkOnTerminate = true;
 497
 498         // workaround : to prevent crash while process terminate on profiling mode,
 499         //                              kill process immediately.
 500         // see https://github.com/dotnet/coreclr/issues/26687
 501         if (__isProfileMode) {
 502                 _INFO("shutdown process immediately.");
 503                 _exit(0);
 504         }
 505
 506         if (__hostHandle != nullptr) {
 507                 int st = shutdown(__hostHandle, __domainId);
 508                 if (st < 0)
 509                         _ERR("shutdown core clr fail! (0x%08x)", st);
 510                 __hostHandle = nullptr;
 511         }
 512
 513         if (__coreclrLib != nullptr) {
 514                 if (dlclose(__coreclrLib) != 0) {
 515                         _ERR("libcoreclr.so close failed");
 516                 }
 517
 518                 __coreclrLib = nullptr;
 519         }
 520
 521         finalizePluginManager();
 522
 523         delete __pm;
 524         __pm = NULL;
 525
 526         __envList.clear();
 527
 528         _INFO("CoreRuntime finalized");
 529 }
 530
 531 int CoreRuntime::launch(const char* appId, const char* root, const char* path, int argc, char* argv[], bool profile)
 532 {
 533         if (!__initialized) {
 534                 _ERR("Runtime is not initialized");
 535                 return -1;
 536         }
 537
 538         if (path == nullptr) {
 539                 _ERR("executable path is null");
 540                 return -1;
 541         }
 542
 543         if (!isFile(path)) {
 544                 _ERR("File not exist : %s", path);
 545                 return -1;
 546         }
 547
 548         // VD has their own signal handler.
 549         if (!pluginHasLogControl()) {
 550                 registerSigHandler();
 551         }
 552
 553         pluginSetAppInfo(appId, path);
 554
 555         // temporal root path is overrided to real application root path
 556         __pm->setAppRootPath(root);
 557
 558         // set application data path to coreclr environment.
 559         // application data path can be changed by owner. So, we have to set data path just before launching.
 560         char* localDataPath = app_get_data_path();
 561         if (localDataPath != nullptr) {
 562                 setEnvironmentVariable("XDG_DATA_HOME", localDataPath);
 563
 564                 // set profile.data path and collect/use it if it non-exists/exists.
 565                 if (profile) {
 566                         char multiCoreJitProfile[strlen(localDataPath) + strlen(PROFILE_BASENAME) + 1];
 567                         memcpy(multiCoreJitProfile, localDataPath, strlen(localDataPath) + 1);
 568                         strncat(multiCoreJitProfile, PROFILE_BASENAME, strlen(PROFILE_BASENAME));
 569
 570                         setEnvironmentVariable("COMPlus_MultiCoreJitProfile", multiCoreJitProfile);
 571                         setEnvironmentVariable("COMPlus_MultiCoreJitMinNumCpus", "1");
 572
 573                         if (exist(multiCoreJitProfile)) {
 574                                 setEnvironmentVariable("COMPlus_MultiCoreJitNoProfileGather", "1");
 575                                 _INFO("MCJ playing start for %s", appId);
 576                         } else {
 577                                 setEnvironmentVariable("COMPlus_MultiCoreJitNoProfileGather", "0");
 578                                 // stop profiling and write collected data after delay if env value is set.
 579                                 char *env = getenv("CLR_MCJ_PROFILE_WRITE_DELAY");
 580                                 if (env != nullptr) {
 581                                         int delay = std::atoi(env);
 582                                         // To avoid undefined behavior by out-of-range input(atoi), set max delay value to 100.
 583                                         if (delay > 0) {
 584                                                 if (delay > MAX_DELAY_SEC) delay = MAX_DELAY_SEC;
 585                                                 stopProfileAfterDelay(delay);
 586                                         }
 587                                 }
 588                                 _INFO("MCJ recording start for %s", appId);
 589                         }
 590                 }
 591                 free(localDataPath);
 592         }
 593
 594         if (exist(__pm->getAppRootPath() + "/bin/" + DISABLE_IPV6_FILE)) {
 595                 setSwitch("System.Net.DisableIPv6", true);
 596         }
 597
 598         setSwitch("Switch.System.Diagnostics.StackTrace.ShowILOffsets", true);
 599
 600         pluginBeforeExecute();
 601
 602         _INFO("execute assembly : %s", path);
 603
 604         unsigned int ret = 0;
 605         int st = executeAssembly(__hostHandle, __domainId, argc, (const char**)argv, path, &ret);
 606         if (st < 0)
 607                 _ERR("Failed to Execute Assembly %s (0x%08x)", path, st);
 608         return ret;
 609 }
 610
 611 }  // namespace dotnetcore
 612 }  // namespace runtime
 613 }  // namespace tizen