blob: 2d5c71146f26045f367fa791a16406c33e7b3702 [file] [log] [blame]
// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef FLUTTER_SHELL_PLATFORM_FUCHSIA_RUNNER_H_
#define FLUTTER_SHELL_PLATFORM_FUCHSIA_RUNNER_H_
#include <memory>
#include <unordered_map>
#include <fuchsia/component/runner/cpp/fidl.h>
#include <fuchsia/sys/cpp/fidl.h>
#include <lib/async-loop/cpp/loop.h>
#include <lib/sys/cpp/component_context.h>
#include <lib/trace-engine/instrumentation.h>
#include <lib/trace/observer.h>
#include "component_v1.h"
#include "component_v2.h"
#include "flutter/fml/macros.h"
#include "fml/memory/ref_ptr.h"
#include "fml/task_runner.h"
#include "lib/fidl/cpp/binding_set.h"
#include "runtime/dart/utils/vmservice_object.h"
namespace flutter_runner {
/// Publishes the CF v1 and CF v2 runner services.
///
/// Each component will be run on a separate thread dedicated to that component.
///
/// TODO(fxb/50694): Add unit tests for CF v2.
class Runner final
: public fuchsia::sys::Runner /* CF v1 */,
public fuchsia::component::runner::ComponentRunner /* CF v2 */ {
public:
// Does not take ownership of context.
Runner(fml::RefPtr<fml::TaskRunner> task_runner,
sys::ComponentContext* context);
~Runner();
private:
// CF v1 lifecycle methods.
// TODO(fxb/50694) Deprecate these once all Flutter components have been
// ported to CF v2.
// |fuchsia::sys::Runner|
void StartComponent(fuchsia::sys::Package package,
fuchsia::sys::StartupInfo startup_info,
fidl::InterfaceRequest<fuchsia::sys::ComponentController>
controller) override;
/// Registers a new CF v1 component with this runner, binding the component
/// to this runner.
void RegisterComponentV1(
fidl::InterfaceRequest<fuchsia::sys::Runner> request);
/// Callback that should be fired when a registered CF v2 component is
/// terminated.
void OnComponentV1Terminate(const ComponentV1* component);
// CF v2 lifecycle methods.
// |fuchsia::component::runner::ComponentRunner|
void Start(
fuchsia::component::runner::ComponentStartInfo start_info,
fidl::InterfaceRequest<fuchsia::component::runner::ComponentController>
controller) override;
/// Registers a new CF v2 component with this runner, binding the component
/// to this runner.
void RegisterComponentV2(
fidl::InterfaceRequest<fuchsia::component::runner::ComponentRunner>
request);
/// Callback that should be fired when a registered CF v2 component is
/// terminated.
void OnComponentV2Terminate(const ComponentV2* component);
void SetupICU();
#if !defined(DART_PRODUCT)
void SetupTraceObserver();
#endif // !defined(DART_PRODUCT)
// Called from SetupICU, for testing only. Returns false on error.
static bool SetupICUInternal();
// Called from SetupICU, for testing only. Returns false on error.
static bool SetupTZDataInternal();
#if defined(FRIEND_TEST)
FRIEND_TEST(RunnerTZDataTest, LoadsWithTZDataPresent);
FRIEND_TEST(RunnerTZDataTest, LoadsWithoutTZDataPresent);
#endif // defined(FRIEND_TEST)
fml::RefPtr<fml::TaskRunner> task_runner_;
sys::ComponentContext* context_;
// CF v1 component state.
fidl::BindingSet<fuchsia::sys::Runner> active_components_v1_bindings_;
std::unordered_map<const ComponentV1*, ActiveComponentV1>
active_components_v1_;
// CF v2 component state.
/// The components that are currently bound to this runner.
fidl::BindingSet<fuchsia::component::runner::ComponentRunner>
active_components_v2_bindings_;
/// The components that are currently actively running on threads.
std::unordered_map<const ComponentV2*, ActiveComponentV2>
active_components_v2_;
#if !defined(DART_PRODUCT)
// The connection between the Dart VM service and The Hub.
std::unique_ptr<dart_utils::VMServiceObject> vmservice_object_;
std::unique_ptr<trace::TraceObserver> trace_observer_;
trace_prolonged_context_t* prolonged_context_;
#endif // !defined(DART_PRODUCT)
FML_DISALLOW_COPY_AND_ASSIGN(Runner);
};
} // namespace flutter_runner
#endif // FLUTTER_SHELL_PLATFORM_FUCHSIA_RUNNER_H_