mirror of
https://github.com/apache/nuttx-apps.git
synced 2026-08-02 04:39:01 +00:00
65854ea805
Add the initial nxpkg command, metadata and store handling, the local install/list path, and the repository export helper. Keep the current flow scoped to local artifacts and target-qualified repository entries so it remains usable as an incremental MVP while follow-up features land separately. Signed-off-by: aviralgarg05 <gargaviral99@gmail.com>
187 lines
7 KiB
C
187 lines
7 KiB
C
/****************************************************************************
|
|
* apps/system/nxpkg/pkg.h
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership. The
|
|
* ASF licenses this file to you 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __APPS_SYSTEM_NXPKG_PKG_H
|
|
#define __APPS_SYSTEM_NXPKG_PKG_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <limits.h>
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include <stdio.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
#define PKG_REPO_DIR "/etc/nxpkg"
|
|
#define PKG_REPO_INDEX "/etc/nxpkg/index.json"
|
|
#define PKG_REPO_INSTALLED "/var/lib/nxpkg/installed.json"
|
|
#define PKG_STORE_DIR "/var/lib/nxpkg/pkgs"
|
|
#define PKG_TMP_DIR "/var/cache/nxpkg"
|
|
#define PKG_TMP_PKG_DIR "/var/cache/nxpkg/pkg"
|
|
|
|
#define PKG_NAME_MAX 63
|
|
#define PKG_VERSION_MAX 31
|
|
#define PKG_ARCH_MAX 31
|
|
#define PKG_COMPAT_MAX 63
|
|
#define PKG_HASH_HEX_LEN 64
|
|
#define PKG_INDEX_MAX 32
|
|
#define PKG_INSTALLED_MAX 16
|
|
#define PKG_INSTALLED_VERSIONS_MAX 8
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
enum pkg_payload_type_e
|
|
{
|
|
PKG_PAYLOAD_ELF = 0,
|
|
PKG_PAYLOAD_SHARED_LIB
|
|
};
|
|
|
|
enum pkg_txn_state_e
|
|
{
|
|
PKG_TXN_IDLE = 0,
|
|
PKG_TXN_FETCHING,
|
|
PKG_TXN_VERIFIED,
|
|
PKG_TXN_STAGED,
|
|
PKG_TXN_COMPAT_OK,
|
|
PKG_TXN_ACTIVATED,
|
|
PKG_TXN_CLEANUP,
|
|
PKG_TXN_FAILED,
|
|
PKG_TXN_RESTORE
|
|
};
|
|
|
|
struct pkg_manifest_s
|
|
{
|
|
char name[PKG_NAME_MAX + 1];
|
|
char version[PKG_VERSION_MAX + 1];
|
|
char arch[PKG_ARCH_MAX + 1];
|
|
char compat[PKG_COMPAT_MAX + 1];
|
|
char artifact[PATH_MAX];
|
|
char sha256[PKG_HASH_HEX_LEN + 1];
|
|
enum pkg_payload_type_e type;
|
|
};
|
|
|
|
struct pkg_index_s
|
|
{
|
|
struct pkg_manifest_s manifests[PKG_INDEX_MAX];
|
|
size_t count;
|
|
};
|
|
|
|
struct pkg_installed_entry_s
|
|
{
|
|
char name[PKG_NAME_MAX + 1];
|
|
char current[PKG_VERSION_MAX + 1];
|
|
char previous[PKG_VERSION_MAX + 1];
|
|
char arch[PKG_ARCH_MAX + 1];
|
|
char compat[PKG_COMPAT_MAX + 1];
|
|
char versions[PKG_INSTALLED_VERSIONS_MAX][PKG_VERSION_MAX + 1];
|
|
enum pkg_payload_type_e type;
|
|
size_t version_count;
|
|
};
|
|
|
|
struct pkg_installed_db_s
|
|
{
|
|
struct pkg_installed_entry_s entries[PKG_INSTALLED_MAX];
|
|
size_t count;
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
const char *pkg_manifest_type_str(enum pkg_payload_type_e type);
|
|
int pkg_manifest_validate(FAR const struct pkg_manifest_s *manifest);
|
|
int pkg_manifest_parse_type(FAR const char *value,
|
|
FAR enum pkg_payload_type_e *type);
|
|
|
|
int pkg_store_prepare_layout(void);
|
|
int pkg_store_ensure_package_root(FAR const char *name);
|
|
int pkg_store_ensure_version_dir(FAR const char *name,
|
|
FAR const char *version);
|
|
int pkg_store_format_index_path(FAR char *buffer, size_t size);
|
|
int pkg_store_format_installed_path(FAR char *buffer, size_t size);
|
|
int pkg_store_format_package_root(FAR char *buffer, size_t size,
|
|
FAR const char *name);
|
|
int pkg_store_format_version_path(FAR char *buffer, size_t size,
|
|
FAR const char *name,
|
|
FAR const char *version);
|
|
int pkg_store_format_current_path(FAR char *buffer, size_t size,
|
|
FAR const char *name);
|
|
int pkg_store_format_previous_path(FAR char *buffer, size_t size,
|
|
FAR const char *name);
|
|
int pkg_store_format_txn_path(FAR char *buffer, size_t size,
|
|
FAR const char *name);
|
|
int pkg_store_format_lock_path(FAR char *buffer, size_t size,
|
|
FAR const char *name);
|
|
int pkg_store_format_download_path(FAR char *buffer, size_t size,
|
|
FAR const char *name,
|
|
FAR const char *version);
|
|
int pkg_store_format_payload_path(FAR char *buffer, size_t size,
|
|
FAR const char *name,
|
|
FAR const char *version,
|
|
FAR const char *artifact);
|
|
int pkg_store_format_manifest_path(FAR char *buffer, size_t size,
|
|
FAR const char *name,
|
|
FAR const char *version);
|
|
int pkg_store_read_text(FAR const char *path, FAR char **buffer);
|
|
int pkg_store_write_text_atomic(FAR const char *path, FAR const char *text);
|
|
int pkg_store_copy_file(FAR const char *src, FAR const char *dest);
|
|
int pkg_store_remove_file(FAR const char *path);
|
|
|
|
const char *pkg_runtime_arch(void);
|
|
const char *pkg_runtime_compat(void);
|
|
int pkg_compat_check(FAR const struct pkg_manifest_s *manifest);
|
|
|
|
int pkg_hash_file_sha256(FAR const char *path,
|
|
FAR char digest[PKG_HASH_HEX_LEN + 1]);
|
|
|
|
int pkg_metadata_load_index(FAR struct pkg_index_s *index);
|
|
FAR const struct pkg_manifest_s *
|
|
pkg_metadata_find_latest(FAR const struct pkg_index_s *index,
|
|
FAR const char *name);
|
|
int pkg_metadata_load_installed(FAR struct pkg_installed_db_s *db);
|
|
int pkg_metadata_save_installed(FAR const struct pkg_installed_db_s *db);
|
|
FAR struct pkg_installed_entry_s *
|
|
pkg_metadata_find_installed(FAR struct pkg_installed_db_s *db,
|
|
FAR const char *name);
|
|
int pkg_metadata_write_manifest(FAR const char *path,
|
|
FAR const struct pkg_manifest_s *manifest);
|
|
int pkg_metadata_print_installed(FAR FILE *stream,
|
|
FAR const struct pkg_installed_db_s *db);
|
|
|
|
const char *pkg_txn_state_str(enum pkg_txn_state_e state);
|
|
int pkg_txn_write_state(FAR const char *name, enum pkg_txn_state_e state);
|
|
int pkg_txn_clear_state(FAR const char *name);
|
|
|
|
int pkg_install(FAR const char *name);
|
|
int pkg_list(FAR FILE *stream);
|
|
|
|
void pkg_error(FAR const char *fmt, ...);
|
|
void pkg_info(FAR const char *fmt, ...);
|
|
|
|
#endif /* __APPS_SYSTEM_NXPKG_PKG_H */
|