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 <fcntl.h>
  27 #include <sys/stat.h>
  28 #include <sys/types.h>
  29 #include <sys/wait.h>
  30 #include <unistd.h>
  31 #include <linux/limits.h>
  32
  33 #include <storage.h>
  34 #include <app_common.h>
  35
  36 #include "utils.h"
  37 #include "log.h"
  38 #include "launcher.h"
  39 #include "dotnet_launcher.h"
  40 #include "plugin_manager.h"
  41 #include "path_manager.h"
  42 #include "log_manager.h"
  43
  44 #define PLUGIN_PATH "/usr/share/dotnet.tizen/lib/libdotnet_plugin.so"
  45 #define ENV_FILE_PATH "/usr/share/dotnet.tizen/lib/coreclr_env.list"
  46
  47 namespace tizen {
  48 namespace runtime {
  49 namespace dotnetcore {
  50
  51 #if defined (__aarch64__)
  52 #define ARCHITECTURE_IDENTIFIER "arm64"
  53 const static std::vector<std::string> RID_FALLBACK_GRAPH =
  54         {"linux-arm64", "linux", "unix-arm64", "unix", "any", "base"};
  55
  56 #elif defined (__arm__)
  57 #define ARCHITECTURE_IDENTIFIER "arm"
  58 const static std::vector<std::string> RID_FALLBACK_GRAPH =
  59         {"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"};
  60
  61 #elif defined (__x86_64__)
  62 #define ARCHITECTURE_IDENTIFIER "x64"
  63 const static std::vector<std::string> RID_FALLBACK_GRAPH =
  64         {"linux-x64", "linux", "unix-x64", "unix", "any", "base"};
  65
  66 #elif defined (__i386__)
  67 #define ARCHITECTURE_IDENTIFIER "x86"
  68 const static std::vector<std::string> RID_FALLBACK_GRAPH =
  69         {"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"};
  70
  71 #else
  72 #error "Unknown target"
  73 #endif
  74
  75 static std::string getExtraNativeLibDirs(const std::string& appRoot)
  76 {
  77         std::string candidate;
  78         for (unsigned int i = 0; i < RID_FALLBACK_GRAPH.size(); i++) {
  79                 if(!candidate.empty()) {
  80                         candidate += ":";
  81                 }
  82                 candidate += concatPath(appRoot, "bin/runtimes/" + RID_FALLBACK_GRAPH[i] + "/native");
  83         }
  84
  85         candidate = candidate + ":" + concatPath(appRoot, "lib/" ARCHITECTURE_IDENTIFIER);
  86         if (!strncmp(ARCHITECTURE_IDENTIFIER, "arm64", 5)) {
  87                 candidate = candidate + ":" + concatPath(appRoot, "lib/aarch64");
  88         }
  89
  90         return candidate;
  91 }
  92
  93
  94 static std::vector<std::string> __envList;
  95
  96 static void setEnvFromFile()
  97 {
  98         std::string envList;
  99         std::ifstream inFile(ENV_FILE_PATH);
 100
 101         __envList.clear();
 102
 103         if (inFile) {
 104                 _INFO("coreclr_env.list is found");
 105                 inFile >> envList;
 106
 107                 std::istringstream ss(envList);
 108                 std::string token;
 109
 110                 while (std::getline(ss, token, ':')) {
 111                         if (!token.empty()) {
 112                                 __envList.push_back(token);
 113                         }
 114                 }
 115
 116                 for (unsigned int i = 0; i < __envList.size(); i++) {
 117                         putenv(const_cast<char *>(__envList[i].c_str()));
 118                 }
 119         } else {
 120                 _INFO("coreclr_env.list file is not found. skip");
 121         }
 122 }
 123
 124 #define _unused(x) ((void)(x))
 125
 126 struct sigaction sig_abrt_new;
 127 struct sigaction sig_abrt_old;
 128
 129 static bool checkOnSigabrt = false;
 130
 131 static void onSigabrt(int signum)
 132 {
 133         // use unused variable to avoid build warning
 134         ssize_t ret = write(STDERR_FILENO, "onSigabrt called\n", 17);
 135
 136         if (checkOnSigabrt) {
 137                 ret = write(STDERR_FILENO, "onSigabrt called again. go to exit\n", 35);
 138                 _unused(ret);
 139                 exit(0);
 140         }
 141
 142         if (hasException()) {
 143                 ret = write(STDERR_FILENO, "******************************************************\n", 55);
 144                 ret = write(STDERR_FILENO, "Unhandled exception is occured. check application code\n", 55);
 145                 ret = write(STDERR_FILENO, "******************************************************\n", 55);
 146         }
 147
 148         checkOnSigabrt = true;
 149         if (sigaction(SIGABRT, &sig_abrt_old, NULL) == 0) {
 150                 if (raise(signum) < 0) {
 151                         ret = write(STDERR_FILENO, "Fail to raise SIGABRT\n", 22);
 152                 }
 153         } else {
 154                 ret = write(STDERR_FILENO, "Fail to set original SIGABRT handler\n", 37);
 155         }
 156         _unused(ret);
 157 }
 158
 159 static void registerSigHandler()
 160 {
 161         sig_abrt_new.sa_handler = onSigabrt;
 162         if (sigemptyset(&sig_abrt_new.sa_mask) != 0) {
 163                 _ERR("Fail to sigemptyset");
 164         }
 165
 166         if (sigaction(SIGABRT, &sig_abrt_new, &sig_abrt_old) < 0) {
 167                 _ERR("Fail to add sig handler");
 168         }
 169 }
 170
 171 static bool storage_cb(int id, storage_type_e type, storage_state_e state, const char *path, void *user_data)
 172 {
 173         int* tmp = (int*)user_data;
 174         if (type == STORAGE_TYPE_INTERNAL)
 175         {
 176                 *tmp = id;
 177                 return false;
 178         }
 179
 180         return true;
 181 }
 182
 183 static void initEnvForSpecialFolder()
 184 {
 185         int storageId;
 186         int error;
 187         char *path = NULL;
 188
 189         error = storage_foreach_device_supported(storage_cb, &storageId);
 190         if (error != STORAGE_ERROR_NONE) {
 191                 return;
 192         }
 193
 194         error = storage_get_directory(storageId, STORAGE_DIRECTORY_IMAGES, &path);
 195         if (error == STORAGE_ERROR_NONE && path != NULL) {
 196                 setenv("XDG_PICTURES_DIR", const_cast<char *>(path), 1);
 197                 free(path);
 198                 path = NULL;
 199         }
 200
 201         error = storage_get_directory(storageId, STORAGE_DIRECTORY_MUSIC, &path);
 202         if (error == STORAGE_ERROR_NONE && path != NULL) {
 203                 setenv("XDG_MUSIC_DIR", const_cast<char *>(path), 1);
 204                 free(path);
 205                 path = NULL;
 206         }
 207
 208         error = storage_get_directory(storageId, STORAGE_DIRECTORY_VIDEOS, &path);
 209         if (error == STORAGE_ERROR_NONE && path != NULL) {
 210                 setenv("XDG_VIDEOS_DIR", const_cast<char *>(path), 1);
 211                 free(path);
 212                 path = NULL;
 213         }
 214 }
 215
 216 CoreRuntime::CoreRuntime(const char* mode) :
 217         initializeClr(nullptr),
 218         executeAssembly(nullptr),
 219         shutdown(nullptr),
 220         createDelegate(nullptr),
 221         setEnvironmentVariable(nullptr),
 222         multiByteToWideChar(nullptr),
 223         __coreclrLib(nullptr),
 224         __hostHandle(nullptr),
 225         __domainId(-1),
 226         fd(0),
 227         __initialized(false)
 228 {
 229         _INFO("Constructor called!!");
 230
 231         // plugin initialize should be called before start loader mainloop.
 232         // In case of VD plugins, attaching secure zone is done in the plugin_initialize().
 233         // When attaching to a secure zone, if there is a created thread, it will failed.
 234         // So, plugin initialize should be called before mainloop start.
 235         if (initializePluginManager(mode) < 0) {
 236                 _ERR("Failed to initialize PluginManager");
 237         }
 238
 239         if (pluginHasLogControl()) {
 240                 __enableLogManager = false;
 241         } else {
 242                 __enableLogManager = true;
 243         }
 244 }
 245
 246 CoreRuntime::~CoreRuntime()
 247 {
 248         dispose();
 249 }
 250
 251 int CoreRuntime::initialize(bool standalone)
 252 {
 253 #define __XSTR(x) #x
 254 #define __STR(x) __XSTR(x)
 255
 256 #ifdef NATIVE_LIB_DIR
 257         __nativeLibDirectory = __STR(NATIVE_LIB_DIR);
 258 #endif
 259
 260 #undef __STR
 261 #undef __XSTR
 262
 263 #ifdef __arm__
 264         // libunwind library is used to unwind stack frame, but libunwind for ARM
 265         // does not support ARM vfpv3/NEON registers in DWARF format correctly.
 266         // Therefore let's disable stack unwinding using DWARF information
 267         // See https://github.com/dotnet/coreclr/issues/6698
 268         //
 269         // libunwind use following methods to unwind stack frame.
 270         // UNW_ARM_METHOD_ALL          0xFF
 271         // UNW_ARM_METHOD_DWARF        0x01
 272         // UNW_ARM_METHOD_FRAME        0x02
 273         // UNW_ARM_METHOD_EXIDX        0x04
 274         putenv(const_cast<char *>("UNW_ARM_UNWIND_METHOD=6"));
 275 #endif // __arm__
 276
 277         // Disable debug pipes and semaphores creation in case of non-standlone mode
 278         if (!standalone)
 279                 putenv(const_cast<char *>("COMPlus_EnableDiagnostics=0"));
 280
 281         // read string from external file and set them to environment value.
 282         setEnvFromFile();
 283
 284         // Set environment for System.Environment.SpecialFolder
 285         initEnvForSpecialFolder();
 286
 287         if (initializePathManager(std::string(), std::string(), std::string()) < 0) {
 288                 _ERR("Failed to initialize PathManager");
 289                 return -1;
 290         }
 291
 292         if (__enableLogManager) {
 293                 if (initializeLogManager() < 0) {
 294                         _ERR("Failed to initnialize LogManager");
 295                         return -1;
 296                 }
 297
 298                 if (redirectFD() < 0) {
 299                         _ERR("Failed to redirect FD");
 300                         return -1;
 301                 }
 302
 303                 if (runLoggingThread() < 0) {
 304                         _ERR("Failed to create and run logging thread to redicrect log");
 305                         return -1;
 306                 }
 307         }
 308
 309         std::string libCoreclr(concatPath(getRuntimeDir(), "libcoreclr.so"));
 310
 311         __coreclrLib = dlopen(libCoreclr.c_str(), RTLD_NOW | RTLD_LOCAL);
 312         if (__coreclrLib == nullptr) {
 313                 char *err = dlerror();
 314                 _ERR("dlopen failed to open libcoreclr.so with error %s", err);
 315                 return -1;
 316         }
 317
 318 #define CORELIB_RETURN_IF_NOSYM(type, variable, name) \
 319         do { \
 320                 variable = (type)dlsym(__coreclrLib, name); \
 321                 if (variable == nullptr) { \
 322                         _ERR(name " is not found in the libcoreclr.so"); \
 323                         return -1; \
 324                 } \
 325         } while (0)
 326
 327         CORELIB_RETURN_IF_NOSYM(coreclr_initialize_ptr, initializeClr, "coreclr_initialize");
 328         CORELIB_RETURN_IF_NOSYM(coreclr_execute_assembly_ptr, executeAssembly, "coreclr_execute_assembly");
 329         CORELIB_RETURN_IF_NOSYM(coreclr_shutdown_ptr, shutdown, "coreclr_shutdown");
 330         CORELIB_RETURN_IF_NOSYM(coreclr_create_delegate_ptr, createDelegate, "coreclr_create_delegate");
 331         CORELIB_RETURN_IF_NOSYM(set_environment_variable_ptr, setEnvironmentVariable, "SetEnvironmentVariableW");
 332         CORELIB_RETURN_IF_NOSYM(multi_byte_to_wide_char_ptr, multiByteToWideChar, "MultiByteToWideChar");
 333
 334 #undef CORELIB_RETURN_IF_NOSYM
 335
 336         _INFO("libcoreclr dlopen and dlsym success");
 337
 338         if (!standalone)
 339                 pluginPreload();
 340
 341         fd = open("/proc/self", O_DIRECTORY);
 342         std::string appRoot = std::string("/proc/self/fd/") + std::to_string(fd);
 343         std::string appBin = concatPath(appRoot, "bin");
 344         std::string appLib = concatPath(appRoot, "lib");
 345         std::string probePath = appBin + ":" + appLib;
 346         std::string tpa = getTPA();
 347         std::string nativeLibPath = getExtraNativeLibDirs(appRoot) + ":" + appBin + ":" + appLib + ":" + __nativeLibDirectory;
 348         std::string appName = std::string("dotnet-launcher-") + std::to_string(getpid());
 349
 350         if (!initializeCoreClr(appName.c_str(), probePath.c_str(), nativeLibPath.c_str(), tpa.c_str())) {
 351                 _ERR("Failed to initialize coreclr");
 352                 return -1;
 353         }
 354
 355         __initialized = true;
 356
 357         _INFO("CoreRuntime initialize success");
 358
 359         return 0;
 360 }
 361
 362 bool CoreRuntime::initializeCoreClr(const char* appId,
 363                                                                          const char* assemblyProbePaths,
 364                                                                          const char* pinvokeProbePaths,
 365                                                                          const char* tpaList)
 366 {
 367         const char *propertyKeys[] = {
 368                 "TRUSTED_PLATFORM_ASSEMBLIES",
 369                 "APP_PATHS",
 370                 "APP_NI_PATHS",
 371                 "NATIVE_DLL_SEARCH_DIRECTORIES",
 372                 "AppDomainCompatSwitch"
 373         };
 374
 375         const char *propertyValues[] = {
 376                 tpaList,
 377                 assemblyProbePaths,
 378                 assemblyProbePaths,
 379                 pinvokeProbePaths,
 380                 "UseLatestBehaviorWhenTFMNotSpecified"
 381         };
 382
 383         std::string selfPath = readSelfPath();
 384
 385         int st = initializeClr(selfPath.c_str(),
 386                                                         appId,
 387                                                         sizeof(propertyKeys) / sizeof(propertyKeys[0]),
 388                                                         propertyKeys,
 389                                                         propertyValues,
 390                                                         &__hostHandle,
 391                                                         &__domainId);
 392
 393         if (st < 0) {
 394                 _ERR("initialize core clr fail! (0x%08x)", st);
 395                 return false;
 396         }
 397
 398         pluginSetCoreclrInfo(__hostHandle, __domainId, createDelegate);
 399
 400         _INFO("Initialize core clr success");
 401         return true;
 402 }
 403
 404 void CoreRuntime::dispose()
 405 {
 406         if (__hostHandle != nullptr) {
 407                 int st = shutdown(__hostHandle, __domainId);
 408                 if (st < 0)
 409                         _ERR("shutdown core clr fail! (0x%08x)", st);
 410                 __hostHandle = nullptr;
 411         }
 412
 413         if (__coreclrLib != nullptr) {
 414                 if (dlclose(__coreclrLib) != 0) {
 415                         _ERR("libcoreclr.so close failed");
 416                 }
 417
 418                 __coreclrLib = nullptr;
 419         }
 420
 421         finalizePluginManager();
 422         finalizePathManager();
 423
 424         __envList.clear();
 425
 426         _INFO("Dotnet runtime disposed");
 427 }
 428
 429 int CoreRuntime::launch(const char* appId, const char* root, const char* path, int argc, char* argv[])
 430 {
 431         if (!__initialized) {
 432                 _ERR("Runtime is not initialized");
 433                 return -1;
 434         }
 435
 436         if (path == nullptr) {
 437                 _ERR("executable path is null");
 438                 return -1;
 439         }
 440
 441         if (!isFileExist(path)) {
 442                 _ERR("File not exist : %s", path);
 443                 return -1;
 444         }
 445
 446         if (__enableLogManager) {
 447                 // launchpad override stdout and stderr to journalctl before launch application.
 448                 // we have to re-override that to input pipe for logging thread.
 449                 if (redirectFD() < 0) {
 450                         _ERR("Failed to redirect FD");
 451                         return -1;
 452                 }
 453
 454                 registerSigHandler();
 455         }
 456
 457         pluginSetAppInfo(appId, path);
 458
 459         int fd2 = open(root, O_DIRECTORY);
 460         dup3(fd2, fd, O_CLOEXEC);
 461         if (fd2 >= 0)
 462                 close(fd2);
 463
 464         // set application data path to coreclr environment.
 465         // application data path can be changed by owner. So, we have to set data path just before launching.
 466         char* localDataPath = app_get_data_path();
 467         if (localDataPath != nullptr) {
 468                 char16_t envval[PATH_MAX] = {0};
 469                 int copied = multiByteToWideChar(0 /* CP_ACP */, 0, localDataPath, -1, envval, PATH_MAX);
 470                 if (copied >= PATH_MAX) {
 471                         _ERR("Data Path is bigger than PATH_MAX");
 472                 }
 473
 474                 if (!setEnvironmentVariable(u"XDG_DATA_HOME", envval)) {
 475                         _ERR("Failed to set XDG_DATA_HOME");
 476                 }
 477         }
 478
 479         pluginBeforeExecute();
 480
 481         _INFO("execute assembly : %s", path);
 482
 483         unsigned int ret = 0;
 484         int st = executeAssembly(__hostHandle, __domainId, argc, (const char**)argv, path, &ret);
 485         if (st < 0)
 486                 _ERR("Failed to Execute Assembly %s (0x%08x)", path, st);
 487         return ret;
 488 }
 489
 490 }  // namespace dotnetcore
 491 }  // namespace runtime
 492 }  // namespace tizen