From: Vitek Karas Date: Thu, 18 Apr 2019 13:48:47 +0000 (-0700) Subject: Update hosting components with new hosts and new scenarios (dotnet/core-setup#5889) X-Git-Tag: submit/tizen/20210909.063632~11032^2~245 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c16430626af3895edc0654ce64631c6d5e5e4830;p=platform%2Fupstream%2Fdotnet%2Fruntime.git Update hosting components with new hosts and new scenarios (dotnet/core-setup#5889) * Update hosting components with new hosts and new scenarios * Apply suggestions from code review Co-Authored-By: vitek-karas Commit migrated from https://github.com/dotnet/core-setup/commit/17737d8b507401b28afef4b576e801f31b76a7e3 --- diff --git a/docs/installer/design-docs/host-components.md b/docs/installer/design-docs/host-components.md index 21252a6..5b71cf8 100644 --- a/docs/installer/design-docs/host-components.md +++ b/docs/installer/design-docs/host-components.md @@ -7,28 +7,31 @@ The .NET Core default hosting setup consists of several components which are des * `dotnet` (executable) - which comes from a shared location and is typically the latest version available on the machine. This is also sometimes called the "muxer". * `apphost` (executable) - which is used to give app an actual executable which can be run directly. The executable will be named using the application name. The advantage of having an app-local executable is that it can be customized for each app (not just the name, but icon, OS behavior and so on). * `comhost` (library) - which is used to enable COM server hosting. Component which wants to expose COM server objects will be built with this dynamic library in its output. The `comhost` then acts as the main entry point for the OS. - -The executable does just one thing, it finds the `hostfxr` library and passes control to it. It also exposes the right entry points for its purpose (so the "main" for `dotnet` and `apphost`, the COM exports for `comhost` and so on). -* `dotnet` host - `hostfxr` is obtained from the `./host/fxr` folder (relative to the location of the `dotnet` host). -* `apphost` and `comhost` - `hostfxr` is located by - 1. The app's folder is searched first. This is either the folder where the `apphost` or `comhost` lives or in case of `apphost` it is the path it has embedded in it as the app path. +* `ijwhost` (library) - which is used to enable loading of IJW assemblies. The library exposes functionality needed by the C++ compiler to generate mixed mode assemblies. +* `winrthost` (library) - which is used to enable WinRT component hosting. Any component which wants to be a WinRT component will be built with this library in its output. The `winrthost` then acts as the main entry point for the OS (very similar to `comhost`). +* `nethost` (library) - which is used by native apps (any app which is not .NET Core) to load .NET Core code dynamically. + +The entry-point typically does just one thing: it finds the `hostfxr` library and passes control to it. It also exposes the right entry points for its purpose (so the "main" for `dotnet` and `apphost`, the COM exports for `comhost` and so on). +* `dotnet` host - `hostfxr` is obtained from the `./host/fxr/` folder (relative to the location of the `dotnet` host). +* `apphost`, `comhost` and the others - `hostfxr` is located using this process: + 1. The app's folder is searched first. This is either the folder where the entry-point host lives or in case of `apphost` it is the path it has embedded in it as the app path. 1. If the `DOTNET_ROOT` environment variable is defined, that path is searched 1. The default shared locations are searched ## Host FXR This library finds and resolves the runtime and all the frameworks the app needs. Then it loads the `hostpolicy` library and transfers control to it. -The library reads the `.runtimeconfig.json` of the app (and all it's dependent frameworks) and resolves the frameworks. It implements the algorithm for framework resolution as described in [SharedFX Lookup](multilevel-sharedfx-lookup.md). +The host FXR library reads the `.runtimeconfig.json` of the app (and all it's dependent frameworks) and resolves the frameworks. It implements the algorithm for framework resolution as described in [SharedFX Lookup](multilevel-sharedfx-lookup.md) and in [Framework version resolution](framework-version-resolution.md). In most cases the latest available version of `hostfxr` is used. Self-contained apps use `hostfxr` from the app folder. -The main reason to split the entry-point host and the `hostfxr` is to allow for servicing the logic in `hostfxr` without the need to stop all instances of the executable host currently running. +The main reason to split the entry-point host and the `hostfxr` is to allow for servicing the logic in `hostfxr` without the need to stop all instances of the executable host currently running. In the case of `apphost` and all the library hosts, servicing the entry-point host is impossible as they are part of the application itself. ## Host Policy -The host policy library implements all the policies to actually load the runtime, apply configuration, resolve all app's dependencies and calls the runtime to run the app. +The host policy library implements all the policies to actually load the runtime, apply configuration, resolve all app's dependencies and calls the runtime to run the app or load the required component. -The host policy library lives in the runtime folder and is versioned alongside it. Which version is used is specified by the app as it specifies which version of the .NET Core runtime to use (done by directly or indirectly referencing the `Microsoft.NETCore.App` framework, or carrying everything app-local). +The host policy library lives in the runtime folder and is versioned alongside it. Which version is used is specified by the app as it specifies which version of the .NET Core runtime to use (done directly or indirectly by referencing the `Microsoft.NETCore.App` framework, or carrying everything app-local). -The library reads the `.deps.json` file of the app (and the `.deps.json` of all the referenced frameworks). It resolves all the assemblies specified in the `.deps.json` for the app and creates a list of assembly paths (also called TPA). It does a similar thing for native dependencies as well. +Host policy library reads the `.deps.json` file of the app (and the `.deps.json` of all the referenced frameworks). It resolves all the assemblies specified in the `.deps.json` for the app and frameworks and creates a list of assembly paths (also called TPA). It does a similar thing for native dependencies as well. -Finally the library loads the runtime `coreclr` library and initializes it (among other things with the TPA). The version of the runtime (and its location) is now already determined since the host policy was loaded from it. Then it calls the runtime with the configuration information which runs the app or performs other requested actions (like COM activation). \ No newline at end of file +Finally the host policy library loads the runtime `coreclr` library and initializes it (among other things with the TPA). The version of the runtime (and its location) is now already determined since the host policy was loaded from the same framework. Then it calls the runtime with the configuration information which runs the app or performs other requested actions (like COM activation).