Move service API from TactilityKernel to service-module (#604)
Extracted the service API from TactilityKernel and put it in a new module at `Modules/service-module`
This commit is contained in:
Ken Van Hoeylandt
committed by
GitHub
GitHub
parent
85fe1a319a
commit
d2c69ee7e8
@@ -8,5 +8,5 @@ tactility_add_module(gps-module
|
||||
SRCS ${SOURCE_FILES}
|
||||
PRIV_INCLUDE_DIRS private/
|
||||
INCLUDE_DIRS include/
|
||||
REQUIRES TactilityKernel minmea
|
||||
REQUIRES TactilityKernel service-module minmea
|
||||
)
|
||||
|
||||
@@ -2,9 +2,10 @@
|
||||
#include <gps/gps_settings.h>
|
||||
#include <gps/private/gps_ledger.h>
|
||||
|
||||
#include <service/paths.h>
|
||||
|
||||
#include <tactility/filesystem/file_mutex.h>
|
||||
#include <tactility/log.h>
|
||||
#include <tactility/service/service_paths.h>
|
||||
|
||||
#include <sys/stat.h>
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
cmake_minimum_required(VERSION 3.20)
|
||||
|
||||
include("${CMAKE_CURRENT_LIST_DIR}/../../Buildscripts/module.cmake")
|
||||
|
||||
file(GLOB_RECURSE SOURCE_FILES "source/*.c*")
|
||||
|
||||
tactility_add_module(service-module
|
||||
SRCS ${SOURCE_FILES}
|
||||
INCLUDE_DIRS include/
|
||||
REQUIRES TactilityKernel
|
||||
)
|
||||
@@ -0,0 +1,195 @@
|
||||
Apache License
|
||||
==============
|
||||
|
||||
_Version 2.0, January 2004_
|
||||
_<<http://www.apache.org/licenses/>>_
|
||||
|
||||
### Terms and Conditions for use, reproduction, and distribution
|
||||
|
||||
#### 1. Definitions
|
||||
|
||||
“License” shall mean the terms and conditions for use, reproduction, and
|
||||
distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
“Licensor” shall mean the copyright owner or entity authorized by the copyright
|
||||
owner that is granting the License.
|
||||
|
||||
“Legal Entity” shall mean the union of the acting entity and all other entities
|
||||
that control, are controlled by, or are under common control with that entity.
|
||||
For the purposes of this definition, “control” means **(i)** the power, direct or
|
||||
indirect, to cause the direction or management of such entity, whether by
|
||||
contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or **(iii)** beneficial ownership of such entity.
|
||||
|
||||
“You” (or “Your”) shall mean an individual or Legal Entity exercising
|
||||
permissions granted by this License.
|
||||
|
||||
“Source” form shall mean the preferred form for making modifications, including
|
||||
but not limited to software source code, documentation source, and configuration
|
||||
files.
|
||||
|
||||
“Object” form shall mean any form resulting from mechanical transformation or
|
||||
translation of a Source form, including but not limited to compiled object code,
|
||||
generated documentation, and conversions to other media types.
|
||||
|
||||
“Work” shall mean the work of authorship, whether in Source or Object form, made
|
||||
available under the License, as indicated by a copyright notice that is included
|
||||
in or attached to the work (an example is provided in the Appendix below).
|
||||
|
||||
“Derivative Works” shall mean any work, whether in Source or Object form, that
|
||||
is based on (or derived from) the Work and for which the editorial revisions,
|
||||
annotations, elaborations, or other modifications represent, as a whole, an
|
||||
original work of authorship. For the purposes of this License, Derivative Works
|
||||
shall not include works that remain separable from, or merely link (or bind by
|
||||
name) to the interfaces of, the Work and Derivative Works thereof.
|
||||
|
||||
“Contribution” shall mean any work of authorship, including the original version
|
||||
of the Work and any modifications or additions to that Work or Derivative Works
|
||||
thereof, that is intentionally submitted to Licensor for inclusion in the Work
|
||||
by the copyright owner or by an individual or Legal Entity authorized to submit
|
||||
on behalf of the copyright owner. For the purposes of this definition,
|
||||
“submitted” means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems, and
|
||||
issue tracking systems that are managed by, or on behalf of, the Licensor for
|
||||
the purpose of discussing and improving the Work, but excluding communication
|
||||
that is conspicuously marked or otherwise designated in writing by the copyright
|
||||
owner as “Not a Contribution.”
|
||||
|
||||
“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
|
||||
of whom a Contribution has been received by Licensor and subsequently
|
||||
incorporated within the Work.
|
||||
|
||||
#### 2. Grant of Copyright License
|
||||
|
||||
Subject to the terms and conditions of this License, each Contributor hereby
|
||||
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
||||
irrevocable copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the Work and such
|
||||
Derivative Works in Source or Object form.
|
||||
|
||||
#### 3. Grant of Patent License
|
||||
|
||||
Subject to the terms and conditions of this License, each Contributor hereby
|
||||
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
||||
irrevocable (except as stated in this section) patent license to make, have
|
||||
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
|
||||
such license applies only to those patent claims licensable by such Contributor
|
||||
that are necessarily infringed by their Contribution(s) alone or by combination
|
||||
of their Contribution(s) with the Work to which such Contribution(s) was
|
||||
submitted. If You institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
|
||||
Contribution incorporated within the Work constitutes direct or contributory
|
||||
patent infringement, then any patent licenses granted to You under this License
|
||||
for that Work shall terminate as of the date such litigation is filed.
|
||||
|
||||
#### 4. Redistribution
|
||||
|
||||
You may reproduce and distribute copies of the Work or Derivative Works thereof
|
||||
in any medium, with or without modifications, and in Source or Object form,
|
||||
provided that You meet the following conditions:
|
||||
|
||||
* **(a)** You must give any other recipients of the Work or Derivative Works a copy of
|
||||
this License; and
|
||||
* **(b)** You must cause any modified files to carry prominent notices stating that You
|
||||
changed the files; and
|
||||
* **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
|
||||
all copyright, patent, trademark, and attribution notices from the Source form
|
||||
of the Work, excluding those notices that do not pertain to any part of the
|
||||
Derivative Works; and
|
||||
* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
|
||||
Derivative Works that You distribute must include a readable copy of the
|
||||
attribution notices contained within such NOTICE file, excluding those notices
|
||||
that do not pertain to any part of the Derivative Works, in at least one of the
|
||||
following places: within a NOTICE text file distributed as part of the
|
||||
Derivative Works; within the Source form or documentation, if provided along
|
||||
with the Derivative Works; or, within a display generated by the Derivative
|
||||
Works, if and wherever such third-party notices normally appear. The contents of
|
||||
the NOTICE file are for informational purposes only and do not modify the
|
||||
License. You may add Your own attribution notices within Derivative Works that
|
||||
You distribute, alongside or as an addendum to the NOTICE text from the Work,
|
||||
provided that such additional attribution notices cannot be construed as
|
||||
modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and may provide
|
||||
additional or different license terms and conditions for use, reproduction, or
|
||||
distribution of Your modifications, or for any such Derivative Works as a whole,
|
||||
provided Your use, reproduction, and distribution of the Work otherwise complies
|
||||
with the conditions stated in this License.
|
||||
|
||||
#### 5. Submission of Contributions
|
||||
|
||||
Unless You explicitly state otherwise, any Contribution intentionally submitted
|
||||
for inclusion in the Work by You to the Licensor shall be under the terms and
|
||||
conditions of this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify the terms of
|
||||
any separate license agreement you may have executed with Licensor regarding
|
||||
such Contributions.
|
||||
|
||||
#### 6. Trademarks
|
||||
|
||||
This License does not grant permission to use the trade names, trademarks,
|
||||
service marks, or product names of the Licensor, except as required for
|
||||
reasonable and customary use in describing the origin of the Work and
|
||||
reproducing the content of the NOTICE file.
|
||||
|
||||
#### 7. Disclaimer of Warranty
|
||||
|
||||
Unless required by applicable law or agreed to in writing, Licensor provides the
|
||||
Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
|
||||
including, without limitation, any warranties or conditions of TITLE,
|
||||
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
|
||||
solely responsible for determining the appropriateness of using or
|
||||
redistributing the Work and assume any risks associated with Your exercise of
|
||||
permissions under this License.
|
||||
|
||||
#### 8. Limitation of Liability
|
||||
|
||||
In no event and under no legal theory, whether in tort (including negligence),
|
||||
contract, or otherwise, unless required by applicable law (such as deliberate
|
||||
and grossly negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special, incidental,
|
||||
or consequential damages of any character arising as a result of this License or
|
||||
out of the use or inability to use the Work (including but not limited to
|
||||
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
|
||||
any and all other commercial damages or losses), even if such Contributor has
|
||||
been advised of the possibility of such damages.
|
||||
|
||||
#### 9. Accepting Warranty or Additional Liability
|
||||
|
||||
While redistributing the Work or Derivative Works thereof, You may choose to
|
||||
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
|
||||
other liability obligations and/or rights consistent with this License. However,
|
||||
in accepting such obligations, You may act only on Your own behalf and on Your
|
||||
sole responsibility, not on behalf of any other Contributor, and only if You
|
||||
agree to indemnify, defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason of your
|
||||
accepting any such warranty or additional liability.
|
||||
|
||||
_END OF TERMS AND CONDITIONS_
|
||||
|
||||
### APPENDIX: How to apply the Apache License to your work
|
||||
|
||||
To apply the Apache License to your work, attach the following boilerplate
|
||||
notice, with the fields enclosed by brackets `[]` replaced with your own
|
||||
identifying information. (Don't include the brackets!) The text should be
|
||||
enclosed in the appropriate comment syntax for the file format. We also
|
||||
recommend that a file or class name and description of purpose be included on
|
||||
the same “printed page” as the copyright notice for easier identification within
|
||||
third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
dependencies:
|
||||
- TactilityKernel
|
||||
@@ -0,0 +1,79 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <service/manifest.h>
|
||||
|
||||
#include <tactility/error.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
struct ServiceInstanceInternal;
|
||||
|
||||
/** The lifecycle state of a ServiceInstance. */
|
||||
typedef enum {
|
||||
SERVICE_STATE_STARTING,
|
||||
SERVICE_STATE_STARTED,
|
||||
SERVICE_STATE_STOPPING,
|
||||
SERVICE_STATE_STOPPED,
|
||||
} ServiceState;
|
||||
|
||||
/** Represents a running (or about-to-run) instance of a service. */
|
||||
struct ServiceInstance {
|
||||
/** The manifest that spawned this instance. */
|
||||
const struct ServiceManifest* manifest;
|
||||
/** Service-specific data, owned by the service implementation. Can be NULL. */
|
||||
void* data;
|
||||
/**
|
||||
* Internal state managed by the kernel.
|
||||
* ServiceInstance implementers should initialize this to NULL.
|
||||
* Do not access or modify directly; use service_instance_* functions.
|
||||
*/
|
||||
struct ServiceInstanceInternal* internal;
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Construct a service instance.
|
||||
* @details This calls manifest->create_service() to build the instance's data.
|
||||
* @param[in,out] instance a service instance with manifest set and internal set to NULL
|
||||
* @param[in] manifest non-null manifest to construct the instance from
|
||||
* @retval ERROR_OUT_OF_MEMORY if internal data allocation failed
|
||||
* @retval ERROR_NONE on success
|
||||
*/
|
||||
error_t service_instance_construct(struct ServiceInstance* instance, const struct ServiceManifest* manifest);
|
||||
|
||||
/**
|
||||
* @brief Destruct a service instance.
|
||||
* @details This calls manifest->destroy_service() on the instance's data.
|
||||
* @param[in,out] instance non-null service instance pointer
|
||||
* @retval ERROR_INVALID_STATE if the instance is not stopped
|
||||
* @retval ERROR_NONE on success
|
||||
*/
|
||||
error_t service_instance_destruct(struct ServiceInstance* instance);
|
||||
|
||||
/**
|
||||
* @brief Get the manifest of a service instance.
|
||||
* @param[in] instance non-null service instance pointer
|
||||
* @return the manifest
|
||||
*/
|
||||
const struct ServiceManifest* service_instance_get_manifest(struct ServiceInstance* instance);
|
||||
|
||||
/**
|
||||
* @brief Get the data of a service instance.
|
||||
* @param[in] instance non-null service instance pointer
|
||||
* @return the data (can be NULL)
|
||||
*/
|
||||
void* service_instance_get_data(struct ServiceInstance* instance);
|
||||
|
||||
/**
|
||||
* @brief Get the state of a service instance.
|
||||
* @param[in] instance non-null service instance pointer
|
||||
* @return the current state
|
||||
*/
|
||||
ServiceState service_instance_get_state(struct ServiceInstance* instance);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
@@ -0,0 +1,74 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <service/instance.h>
|
||||
#include <service/manifest.h>
|
||||
#include <tactility/error.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Register a service manifest.
|
||||
* @param[in] manifest non-null manifest to register
|
||||
* @param[in] auto_start if true, the service is started immediately after registration
|
||||
* @retval ERROR_INVALID_ARGUMENT if a manifest with the same id is already registered
|
||||
* @retval ERROR_RESOURCE if auto_start is true and starting the service failed
|
||||
* @retval ERROR_NONE on success
|
||||
*/
|
||||
error_t service_manager_add(const struct ServiceManifest* manifest, bool auto_start);
|
||||
|
||||
/**
|
||||
* @brief Unregister a previously-added manifest.
|
||||
* @param[in] id non-null service id
|
||||
* @retval ERROR_INVALID_STATE if the service is still running
|
||||
* @retval ERROR_NOT_FOUND if no manifest with this id is registered
|
||||
* @retval ERROR_NONE on success
|
||||
*/
|
||||
error_t service_manager_remove(const char* id);
|
||||
|
||||
/**
|
||||
* @brief Find a registered manifest by id.
|
||||
* @param[in] id non-null service id
|
||||
* @return the manifest, or NULL if not found
|
||||
*/
|
||||
const struct ServiceManifest* service_manager_find_manifest(const char* id);
|
||||
|
||||
/**
|
||||
* @brief Start a registered service by id.
|
||||
* @param[in] id non-null service id
|
||||
* @retval ERROR_NOT_FOUND if no manifest with this id is registered
|
||||
* @retval ERROR_INVALID_STATE if the service is already running
|
||||
* @retval ERROR_RESOURCE if the service's on_start callback failed
|
||||
* @retval ERROR_NONE on success
|
||||
*/
|
||||
error_t service_manager_start(const char* id);
|
||||
|
||||
/**
|
||||
* @brief Stop a running service by id.
|
||||
* @param[in] id non-null service id
|
||||
* @retval ERROR_NOT_FOUND if no service with this id is running
|
||||
* @retval ERROR_NONE on success
|
||||
*/
|
||||
error_t service_manager_stop(const char* id);
|
||||
|
||||
/**
|
||||
* @brief Get the state of a service by id.
|
||||
* @param[in] id non-null service id
|
||||
* @return the current state, or SERVICE_STATE_STOPPED if the id is unknown
|
||||
*/
|
||||
ServiceState service_manager_get_state(const char* id);
|
||||
|
||||
/**
|
||||
* @brief Find the service instance
|
||||
* @param[in] id non-null service id
|
||||
* @return the instance when found, otherwise return NULL
|
||||
*/
|
||||
struct ServiceInstance* service_manager_find_instance(const char* id);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
@@ -0,0 +1,67 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <tactility/error.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
// ServiceContext (declared in service_context.h) is a typedef alias of ServiceInstance,
|
||||
// so the callback types below are declared directly in terms of ServiceInstance to avoid
|
||||
// a conflicting forward-declaration of an unrelated "ServiceContext" struct tag.
|
||||
struct ServiceInstance;
|
||||
struct ServiceManifest;
|
||||
|
||||
/**
|
||||
* Allocates and initializes the service's custom data.
|
||||
* @param[in] manifest the manifest that owns this callback
|
||||
* @return the service's custom data, or NULL if it has none
|
||||
*/
|
||||
typedef void* (*ServiceCreate)(const struct ServiceManifest* manifest);
|
||||
|
||||
/**
|
||||
* Frees custom data that was set up by the matching ServiceCreate function.
|
||||
* @param[in] data the custom data returned by create_service
|
||||
* @param[in] manifest the manifest that owns this callback
|
||||
*/
|
||||
typedef void (*ServiceDestroy)(const struct ServiceManifest* manifest, void* data);
|
||||
|
||||
/**
|
||||
* Called when a service instance is starting.
|
||||
* Can be NULL, in which case starting always succeeds.
|
||||
* @param[in,out] instance the starting service instance (also its own ServiceContext)
|
||||
* @param[in] data the custom data returned by create_service
|
||||
* @return ERROR_NONE if the service started successfully
|
||||
*/
|
||||
typedef error_t (*ServiceOnStart)(struct ServiceInstance* instance, void* data);
|
||||
|
||||
/**
|
||||
* Called when a service instance is stopping.
|
||||
* Can be NULL, in which case stopping is a no-op.
|
||||
* @param[in,out] instance the stopping service instance (also its own ServiceContext)
|
||||
* @param[in] data the custom data returned by create_service
|
||||
*/
|
||||
typedef void (*ServiceOnStop)(struct ServiceInstance* instance, void* data);
|
||||
|
||||
/**
|
||||
* Describes a registrable service type.
|
||||
* One manifest exists per service id, shared across start/stop cycles.
|
||||
*/
|
||||
struct ServiceManifest {
|
||||
/** Unique service identifier. Should never be NULL. */
|
||||
const char* id;
|
||||
/** Allocates the service's custom data. Should never be NULL. */
|
||||
ServiceCreate create_service;
|
||||
/** Frees the service's custom data. Should never be NULL. */
|
||||
ServiceDestroy destroy_service;
|
||||
/** Called when a service instance starts. Can be NULL. */
|
||||
ServiceOnStart on_start;
|
||||
/** Called when a service instance stops. Can be NULL. */
|
||||
ServiceOnStop on_stop;
|
||||
};
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
@@ -0,0 +1,56 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stddef.h>
|
||||
#include <tactility/error.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Get the user data directory for a service. Survives OS upgrades. No trailing "/".
|
||||
* @param[in] service_id non-null service id
|
||||
* @param[out] out_path buffer to store the path
|
||||
* @param[in] out_path_size size of the output buffer
|
||||
* @retval ERROR_BUFFER_OVERFLOW if out_path_size is too small
|
||||
* @retval ERROR_NONE on success
|
||||
*/
|
||||
error_t service_paths_get_user_data_directory(const char* service_id, char* out_path, size_t out_path_size);
|
||||
|
||||
/**
|
||||
* @brief Get a path within the user data directory for a service.
|
||||
* @param[in] service_id non-null service id
|
||||
* @param[in] child_path path without a "/" prefix
|
||||
* @param[out] out_path buffer to store the path
|
||||
* @param[in] out_path_size size of the output buffer
|
||||
* @retval ERROR_BUFFER_OVERFLOW if out_path_size is too small
|
||||
* @retval ERROR_NONE on success
|
||||
*/
|
||||
error_t service_paths_get_user_data_path(const char* service_id, const char* child_path, char* out_path, size_t out_path_size);
|
||||
|
||||
/**
|
||||
* @brief Get the assets directory for a service. Do not store configuration data here. No trailing "/".
|
||||
* @param[in] service_id non-null service id
|
||||
* @param[out] out_path buffer to store the path
|
||||
* @param[in] out_path_size size of the output buffer
|
||||
* @retval ERROR_BUFFER_OVERFLOW if out_path_size is too small
|
||||
* @retval ERROR_NONE on success
|
||||
*/
|
||||
error_t service_paths_get_assets_directory(const char* service_id, char* out_path, size_t out_path_size);
|
||||
|
||||
/**
|
||||
* @brief Get a path within the assets directory for a service.
|
||||
* @param[in] service_id non-null service id
|
||||
* @param[in] child_path path without a "/" prefix
|
||||
* @param[out] out_path buffer to store the path
|
||||
* @param[in] out_path_size size of the output buffer
|
||||
* @retval ERROR_BUFFER_OVERFLOW if out_path_size is too small
|
||||
* @retval ERROR_NONE on success
|
||||
*/
|
||||
error_t service_paths_get_assets_path(const char* service_id, const char* child_path, char* out_path, size_t out_path_size);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
@@ -0,0 +1,77 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
#include <service/instance.h>
|
||||
|
||||
#include <tactility/concurrent/mutex.h>
|
||||
#include <tactility/log.h>
|
||||
|
||||
#include <new>
|
||||
|
||||
#define TAG "service_instance"
|
||||
|
||||
struct ServiceInstanceInternal {
|
||||
Mutex mutex {};
|
||||
ServiceState state = SERVICE_STATE_STOPPED;
|
||||
};
|
||||
|
||||
extern "C" {
|
||||
|
||||
error_t service_instance_construct(ServiceInstance* instance, const ServiceManifest* manifest) {
|
||||
instance->internal = new(std::nothrow) ServiceInstanceInternal;
|
||||
if (instance->internal == nullptr) {
|
||||
return ERROR_OUT_OF_MEMORY;
|
||||
}
|
||||
mutex_construct(&instance->internal->mutex);
|
||||
|
||||
instance->manifest = manifest;
|
||||
instance->data = manifest->create_service(manifest);
|
||||
|
||||
LOG_D(TAG, "construct %s", manifest->id);
|
||||
return ERROR_NONE;
|
||||
}
|
||||
|
||||
error_t service_instance_destruct(ServiceInstance* instance) {
|
||||
auto* internal = instance->internal;
|
||||
|
||||
mutex_lock(&internal->mutex);
|
||||
if (internal->state != SERVICE_STATE_STOPPED) {
|
||||
mutex_unlock(&internal->mutex);
|
||||
return ERROR_INVALID_STATE;
|
||||
}
|
||||
mutex_unlock(&internal->mutex);
|
||||
|
||||
LOG_D(TAG, "destruct %s", instance->manifest->id);
|
||||
|
||||
instance->manifest->destroy_service(instance->manifest, instance->data);
|
||||
instance->data = nullptr;
|
||||
|
||||
instance->internal = nullptr;
|
||||
mutex_destruct(&internal->mutex);
|
||||
delete internal;
|
||||
|
||||
return ERROR_NONE;
|
||||
}
|
||||
|
||||
const ServiceManifest* service_instance_get_manifest(ServiceInstance* instance) {
|
||||
return instance->manifest;
|
||||
}
|
||||
|
||||
void* service_instance_get_data(ServiceInstance* instance) {
|
||||
return instance->data;
|
||||
}
|
||||
|
||||
ServiceState service_instance_get_state(ServiceInstance* instance) {
|
||||
mutex_lock(&instance->internal->mutex);
|
||||
ServiceState state = instance->internal->state;
|
||||
mutex_unlock(&instance->internal->mutex);
|
||||
return state;
|
||||
}
|
||||
|
||||
/** Internal-only: mutate the state of a service instance. Used by service_registration.cpp. */
|
||||
void service_instance_set_state(ServiceInstance* instance, ServiceState state) {
|
||||
mutex_lock(&instance->internal->mutex);
|
||||
instance->internal->state = state;
|
||||
mutex_unlock(&instance->internal->mutex);
|
||||
}
|
||||
|
||||
} // extern "C"
|
||||
@@ -0,0 +1,207 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
#include <service/manager.h>
|
||||
|
||||
#include <tactility/concurrent/mutex.h>
|
||||
#include <tactility/log.h>
|
||||
#include <tactility/system_event.h>
|
||||
|
||||
#include <new>
|
||||
#include <string>
|
||||
#include <unordered_map>
|
||||
|
||||
#define TAG "service_registration"
|
||||
|
||||
// Defined in service_instance.cpp. Internal-only: lets the registry drive state
|
||||
// transitions without exposing mutation on the public ServiceInstance API.
|
||||
extern "C" void service_instance_set_state(ServiceInstance* instance, ServiceState state);
|
||||
|
||||
struct ManifestLedger {
|
||||
std::unordered_map<std::string, const ServiceManifest*> manifests;
|
||||
Mutex mutex {};
|
||||
|
||||
ManifestLedger() { mutex_construct(&mutex); }
|
||||
~ManifestLedger() { mutex_destruct(&mutex); }
|
||||
};
|
||||
|
||||
struct InstanceLedger {
|
||||
std::unordered_map<std::string, ServiceInstance*> instances;
|
||||
Mutex mutex {};
|
||||
|
||||
InstanceLedger() { mutex_construct(&mutex); }
|
||||
~InstanceLedger() { mutex_destruct(&mutex); }
|
||||
};
|
||||
|
||||
static ManifestLedger& get_manifest_ledger() {
|
||||
static ManifestLedger ledger;
|
||||
return ledger;
|
||||
}
|
||||
|
||||
static InstanceLedger& get_instance_ledger() {
|
||||
static InstanceLedger ledger;
|
||||
return ledger;
|
||||
}
|
||||
|
||||
#define manifest_ledger get_manifest_ledger()
|
||||
#define instance_ledger get_instance_ledger()
|
||||
|
||||
extern "C" {
|
||||
|
||||
error_t service_manager_add(const ServiceManifest* manifest, bool auto_start) {
|
||||
mutex_lock(&manifest_ledger.mutex);
|
||||
if (manifest_ledger.manifests.contains(manifest->id)) {
|
||||
mutex_unlock(&manifest_ledger.mutex);
|
||||
LOG_E(TAG, "Manifest with id '%s' is already registered", manifest->id);
|
||||
return ERROR_INVALID_ARGUMENT;
|
||||
}
|
||||
manifest_ledger.manifests[manifest->id] = manifest;
|
||||
mutex_unlock(&manifest_ledger.mutex);
|
||||
|
||||
LOG_I(TAG, "add %s", manifest->id);
|
||||
|
||||
if (auto_start) {
|
||||
return service_manager_start(manifest->id);
|
||||
}
|
||||
|
||||
return ERROR_NONE;
|
||||
}
|
||||
|
||||
error_t service_manager_remove(const char* id) {
|
||||
if (service_manager_get_state(id) != SERVICE_STATE_STOPPED) {
|
||||
return ERROR_INVALID_STATE;
|
||||
}
|
||||
|
||||
mutex_lock(&manifest_ledger.mutex);
|
||||
const auto iterator = manifest_ledger.manifests.find(id);
|
||||
if (iterator == manifest_ledger.manifests.end()) {
|
||||
mutex_unlock(&manifest_ledger.mutex);
|
||||
return ERROR_NOT_FOUND;
|
||||
}
|
||||
manifest_ledger.manifests.erase(iterator);
|
||||
mutex_unlock(&manifest_ledger.mutex);
|
||||
|
||||
LOG_I(TAG, "remove %s", id);
|
||||
return ERROR_NONE;
|
||||
}
|
||||
|
||||
error_t service_manager_start(const char* id) {
|
||||
mutex_lock(&manifest_ledger.mutex);
|
||||
const auto manifest_iterator = manifest_ledger.manifests.find(id);
|
||||
if (manifest_iterator == manifest_ledger.manifests.end()) {
|
||||
mutex_unlock(&manifest_ledger.mutex);
|
||||
return ERROR_NOT_FOUND;
|
||||
}
|
||||
const ServiceManifest* manifest = manifest_iterator->second;
|
||||
mutex_unlock(&manifest_ledger.mutex);
|
||||
|
||||
mutex_lock(&instance_ledger.mutex);
|
||||
if (instance_ledger.instances.contains(id)) {
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
return ERROR_INVALID_STATE;
|
||||
}
|
||||
|
||||
auto* instance = new(std::nothrow) ServiceInstance { .manifest = nullptr, .data = nullptr, .internal = nullptr };
|
||||
if (instance == nullptr) {
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
return ERROR_OUT_OF_MEMORY;
|
||||
}
|
||||
|
||||
error_t error = service_instance_construct(instance, manifest);
|
||||
if (error != ERROR_NONE) {
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
delete instance;
|
||||
return error;
|
||||
}
|
||||
|
||||
// Register before on_start() so a service can find itself while starting.
|
||||
instance_ledger.instances[id] = instance;
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
|
||||
service_instance_set_state(instance, SERVICE_STATE_STARTING);
|
||||
|
||||
LOG_I(TAG, "start %s", id);
|
||||
error = (manifest->on_start != nullptr) ? manifest->on_start(instance, instance->data) : ERROR_NONE;
|
||||
|
||||
if (error == ERROR_NONE) {
|
||||
service_instance_set_state(instance, SERVICE_STATE_STARTED);
|
||||
ServiceStartedEvent start_event = { .id = id };
|
||||
system_event_emit(KERNEL_EVENT_SERVICE_STARTED, &start_event, sizeof(start_event));
|
||||
return ERROR_NONE;
|
||||
}
|
||||
|
||||
LOG_E(TAG, "Failed to start %s: %s", id, error_to_string(error));
|
||||
service_instance_set_state(instance, SERVICE_STATE_STOPPED);
|
||||
|
||||
mutex_lock(&instance_ledger.mutex);
|
||||
instance_ledger.instances.erase(id);
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
|
||||
service_instance_destruct(instance);
|
||||
delete instance;
|
||||
|
||||
return ERROR_RESOURCE;
|
||||
}
|
||||
|
||||
error_t service_manager_stop(const char* id) {
|
||||
mutex_lock(&instance_ledger.mutex);
|
||||
const auto iterator = instance_ledger.instances.find(id);
|
||||
if (iterator == instance_ledger.instances.end()) {
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
return ERROR_NOT_FOUND;
|
||||
}
|
||||
ServiceInstance* instance = iterator->second;
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
|
||||
LOG_I(TAG, "stop %s", id);
|
||||
|
||||
service_instance_set_state(instance, SERVICE_STATE_STOPPING);
|
||||
|
||||
if (instance->manifest->on_stop != nullptr) {
|
||||
instance->manifest->on_stop(instance, instance->data);
|
||||
}
|
||||
|
||||
service_instance_set_state(instance, SERVICE_STATE_STOPPED);
|
||||
|
||||
mutex_lock(&instance_ledger.mutex);
|
||||
instance_ledger.instances.erase(id);
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
|
||||
service_instance_destruct(instance);
|
||||
delete instance;
|
||||
|
||||
ServiceStoppedEvent stop_event = { .id = id };
|
||||
system_event_emit(KERNEL_EVENT_SERVICE_STOPPED, &stop_event, sizeof(stop_event));
|
||||
|
||||
return ERROR_NONE;
|
||||
}
|
||||
|
||||
ServiceState service_manager_get_state(const char* id) {
|
||||
mutex_lock(&instance_ledger.mutex);
|
||||
const auto iterator = instance_ledger.instances.find(id);
|
||||
if (iterator == instance_ledger.instances.end()) {
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
return SERVICE_STATE_STOPPED;
|
||||
}
|
||||
ServiceInstance* instance = iterator->second;
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
|
||||
return service_instance_get_state(instance);
|
||||
}
|
||||
|
||||
const ServiceManifest* service_manager_find_manifest(const char* id) {
|
||||
mutex_lock(&manifest_ledger.mutex);
|
||||
const auto iterator = manifest_ledger.manifests.find(id);
|
||||
const ServiceManifest* manifest = (iterator != manifest_ledger.manifests.end()) ? iterator->second : nullptr;
|
||||
mutex_unlock(&manifest_ledger.mutex);
|
||||
return manifest;
|
||||
}
|
||||
|
||||
ServiceInstance* service_manager_find_instance(const char* id) {
|
||||
mutex_lock(&instance_ledger.mutex);
|
||||
const auto iterator = instance_ledger.instances.find(id);
|
||||
auto* instance = (iterator != instance_ledger.instances.end()) ? iterator->second : nullptr;
|
||||
mutex_unlock(&instance_ledger.mutex);
|
||||
return instance;
|
||||
}
|
||||
|
||||
} // extern "C"
|
||||
@@ -0,0 +1,62 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
#include <service/paths.h>
|
||||
#include <tactility/paths.h>
|
||||
|
||||
#include <cstdio>
|
||||
|
||||
extern "C" {
|
||||
|
||||
error_t service_paths_get_user_data_directory(const char* service_id, char* out_path, size_t out_path_size) {
|
||||
char root[192];
|
||||
error_t error = paths_get_user_data_path(root, sizeof(root));
|
||||
if (error != ERROR_NONE) {
|
||||
return error;
|
||||
}
|
||||
int written = std::snprintf(out_path, out_path_size, "%s/service/%s", root, service_id);
|
||||
if (written < 0 || (size_t)written >= out_path_size) {
|
||||
return ERROR_BUFFER_OVERFLOW;
|
||||
}
|
||||
return ERROR_NONE;
|
||||
}
|
||||
|
||||
error_t service_paths_get_user_data_path(const char* service_id, const char* child_path, char* out_path, size_t out_path_size) {
|
||||
char directory[224];
|
||||
error_t error = service_paths_get_user_data_directory(service_id, directory, sizeof(directory));
|
||||
if (error != ERROR_NONE) {
|
||||
return error;
|
||||
}
|
||||
int written = std::snprintf(out_path, out_path_size, "%s/%s", directory, child_path);
|
||||
if (written < 0 || (size_t)written >= out_path_size) {
|
||||
return ERROR_BUFFER_OVERFLOW;
|
||||
}
|
||||
return ERROR_NONE;
|
||||
}
|
||||
|
||||
error_t service_paths_get_assets_directory(const char* service_id, char* out_path, size_t out_path_size) {
|
||||
char directory[224];
|
||||
error_t error = service_paths_get_user_data_directory(service_id, directory, sizeof(directory));
|
||||
if (error != ERROR_NONE) {
|
||||
return error;
|
||||
}
|
||||
int written = std::snprintf(out_path, out_path_size, "%s/assets", directory);
|
||||
if (written < 0 || (size_t)written >= out_path_size) {
|
||||
return ERROR_BUFFER_OVERFLOW;
|
||||
}
|
||||
return ERROR_NONE;
|
||||
}
|
||||
|
||||
error_t service_paths_get_assets_path(const char* service_id, const char* child_path, char* out_path, size_t out_path_size) {
|
||||
char directory[224];
|
||||
error_t error = service_paths_get_assets_directory(service_id, directory, sizeof(directory));
|
||||
if (error != ERROR_NONE) {
|
||||
return error;
|
||||
}
|
||||
int written = std::snprintf(out_path, out_path_size, "%s/%s", directory, child_path);
|
||||
if (written < 0 || (size_t)written >= out_path_size) {
|
||||
return ERROR_BUFFER_OVERFLOW;
|
||||
}
|
||||
return ERROR_NONE;
|
||||
}
|
||||
|
||||
} // extern "C"
|
||||
@@ -0,0 +1,36 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
#include <tactility/module.h>
|
||||
#include <service/instance.h>
|
||||
#include <service/manager.h>
|
||||
#include <service/paths.h>
|
||||
|
||||
const ModuleSymbol service_module_symbols[] = {
|
||||
// service/service_instance
|
||||
DEFINE_MODULE_SYMBOL(service_instance_construct),
|
||||
DEFINE_MODULE_SYMBOL(service_instance_destruct),
|
||||
DEFINE_MODULE_SYMBOL(service_instance_get_manifest),
|
||||
DEFINE_MODULE_SYMBOL(service_instance_get_data),
|
||||
DEFINE_MODULE_SYMBOL(service_instance_get_state),
|
||||
// service/service_manager
|
||||
DEFINE_MODULE_SYMBOL(service_manager_add),
|
||||
DEFINE_MODULE_SYMBOL(service_manager_remove),
|
||||
DEFINE_MODULE_SYMBOL(service_manager_find_manifest),
|
||||
DEFINE_MODULE_SYMBOL(service_manager_start),
|
||||
DEFINE_MODULE_SYMBOL(service_manager_stop),
|
||||
DEFINE_MODULE_SYMBOL(service_manager_get_state),
|
||||
DEFINE_MODULE_SYMBOL(service_manager_find_instance),
|
||||
// service/service_paths
|
||||
DEFINE_MODULE_SYMBOL(service_paths_get_user_data_directory),
|
||||
DEFINE_MODULE_SYMBOL(service_paths_get_user_data_path),
|
||||
DEFINE_MODULE_SYMBOL(service_paths_get_assets_directory),
|
||||
DEFINE_MODULE_SYMBOL(service_paths_get_assets_path),
|
||||
// terminator
|
||||
MODULE_SYMBOL_TERMINATOR
|
||||
};
|
||||
|
||||
Module service_module = {
|
||||
.name = "service",
|
||||
.drivers = nullptr,
|
||||
.symbols = service_module_symbols,
|
||||
.internal = nullptr
|
||||
};
|
||||
Reference in New Issue
Block a user