Files
djhackersdev_bemanitools/src/main/launcher/avs-config.c
T
icex2andShiz 35ca49fe7e refactor(launcher): Major re-work of launcher
Kudos to Shiz for providing the groundwork for this.

Fundamentally re-think how launcher operates and
bootstrapping the games is managed and configured.

This brings it significantly closer to how the original
bootstrap is doing the job: launcher now utilizes the
data (structures) provided by the bootstrap.xml configuration
file. This creates compatibility with vanilla data dumps
and original stock images. Note that bemanitools does not
include any code or means to run DRM'd data, only decrypted.

But, this allows users to keep decrypted dumps as stock as
possible which means:

* No copying around of property files anymore
* Keep the modules/ folder with the binaries
* Have bemanitools binaries separate in the data
* No need to edit/customize the original configuration files

A list of key features of the "new" launcher:

* Boostrap games by following the configuration provided by
  stock game's bootstrap.xml files
* Custom launcher.xml configuration file that adds further
  launcher configurable features, composability of
  bootstrap.xml configuration(s) as well as configuration
  overriding/stacking of selected types of configurations,
  e.g. eamuse config, avs-config. The latter eliminates
  the need for modifying stock config files in the prop/
  folder
* Unified logging system: launcher and AVS logging uses
  the same logger, all output can now be in a single file
* Original features such as various hook types still
  available

Due to the significant architectural changes, this also
breaks with any backwards compatibility to existing
launcher setups. Thus, users need to migrate by re-applying
the new configuration format and migrating their config
parameters accordingly.

Further migration instructions and updated documentation
will be provided upon release.

Co-authored-by: Shiz <hi@shiz.me>
2024-08-14 17:53:51 +02:00

773 lines
23 KiB
C

#define LOG_MODULE "avs-config"
#include <windows.h>
#include "avs-util/error.h"
#include "core/log.h"
#include "imports/avs.h"
#include "launcher/avs-config.h"
#include "launcher/property-util.h"
#include "util/str.h"
#define AVS_CONFIG_ROOT_NODE "/config"
static const char *_avs_config_property_mounttable_path =
"/config/fs/mounttable";
static void _avs_config_node_vfs_copy(
struct property *parent_property,
struct property_node *parent,
struct property_node *source)
{
// Use max path size to fit dst and src fs paths
char data[MAX_PATH];
// Remark: Using property_node_clone doesn't work here
// Cloning non-deep only clones the vfs node. Cloning deep doesn't seem
// to work with arbitrary attributes that don't follow the general
// design of a property structure. This seems to require clear typing for
// nodes in order to allow property_node_clone to work
// Ignore errors and default to empty
memset(data, 0, sizeof(data));
property_node_refer(
NULL, source, "name@", PROPERTY_TYPE_ATTR, data, sizeof(data));
property_util_node_attribute_replace(
parent_property, parent, "name@", data);
memset(data, 0, sizeof(data));
property_node_refer(
NULL, source, "fstype@", PROPERTY_TYPE_ATTR, data, sizeof(data));
property_util_node_attribute_replace(
parent_property, parent, "fstype@", data);
memset(data, 0, sizeof(data));
property_node_refer(
NULL, source, "src@", PROPERTY_TYPE_ATTR, data, sizeof(data));
property_util_node_attribute_replace(parent_property, parent, "src@", data);
memset(data, 0, sizeof(data));
property_node_refer(
NULL, source, "dst@", PROPERTY_TYPE_ATTR, data, sizeof(data));
property_util_node_attribute_replace(parent_property, parent, "dst@", data);
memset(data, 0, sizeof(data));
property_node_refer(
NULL, source, "opt@", PROPERTY_TYPE_ATTR, data, sizeof(data));
property_util_node_attribute_replace(parent_property, parent, "opt@", data);
}
static bool _avs_config_mounttable_vfs_nodes_merge_strategy_do(
struct property *parent_property,
struct property_node *parent,
struct property_node *source,
void *ctx,
property_util_node_merge_recursion_do_t node_merge_recursion_do)
{
struct property_node *parent_child;
struct property_node *source_child;
char parent_child_name[PROPERTY_NODE_NAME_SIZE_MAX];
char name_parent[PROPERTY_NODE_ATTR_NAME_SIZE_MAX];
char dst_parent[PROPERTY_NODE_ATTR_NAME_SIZE_MAX];
char source_child_name[PROPERTY_NODE_NAME_SIZE_MAX];
char name_source[PROPERTY_NODE_ATTR_NAME_SIZE_MAX];
char dst_source[PROPERTY_NODE_ATTR_NAME_SIZE_MAX];
bool node_consumed;
bool found_parent;
source_child = property_node_traversal(source, TRAVERSE_FIRST_CHILD);
node_consumed = false;
while (source_child) {
property_node_name(
source_child, source_child_name, sizeof(source_child_name));
if (str_eq(source_child_name, "vfs")) {
node_consumed = true;
parent_child =
property_node_traversal(parent, TRAVERSE_FIRST_CHILD);
found_parent = false;
while (parent_child) {
property_node_name(
parent_child, parent_child_name, sizeof(parent_child_name));
if (str_eq(parent_child_name, "vfs")) {
if (AVS_IS_ERROR(property_node_refer(
NULL,
source_child,
"name@",
PROPERTY_TYPE_ATTR,
name_source,
sizeof(name_source)))) {
log_fatal(
"Missing 'name' attribute on avs config mounttable "
"vfs source node");
}
if (AVS_IS_ERROR(property_node_refer(
NULL,
source_child,
"dst@",
PROPERTY_TYPE_ATTR,
dst_source,
sizeof(dst_source)))) {
log_fatal(
"Missing 'dst' attribute on avs config mounttable "
"vfs source node");
}
if (AVS_IS_ERROR(property_node_refer(
NULL,
parent_child,
"name@",
PROPERTY_TYPE_ATTR,
name_parent,
sizeof(name_parent)))) {
log_fatal(
"Missing 'name' attribute on avs config mounttable "
"vfs parent node");
}
if (AVS_IS_ERROR(property_node_refer(
NULL,
parent_child,
"dst@",
PROPERTY_TYPE_ATTR,
dst_parent,
sizeof(dst_parent)))) {
log_fatal(
"Missing 'dst' attribute on avs config mounttable "
"vfs parent node");
}
// Found existing matching node on parent, replace it
if (str_eq(name_source, name_parent) &&
str_eq(dst_source, dst_parent)) {
_avs_config_node_vfs_copy(
parent_property, parent_child, source_child);
found_parent = true;
break;
}
}
parent_child = property_node_traversal(
parent_child, TRAVERSE_NEXT_SIBLING);
}
// Not found an existing node that got replaced, insert/merge new
// data
if (!found_parent) {
parent_child = property_node_create(
parent_property, parent, PROPERTY_TYPE_VOID, "vfs");
_avs_config_node_vfs_copy(
parent_property, parent_child, source_child);
}
}
source_child =
property_node_traversal(source_child, TRAVERSE_NEXT_SIBLING);
}
return node_consumed;
}
struct property *avs_config_load(const char *filepath)
{
struct property *property;
log_assert(filepath);
log_info("Loading from file path: %s", filepath);
property = property_util_load(filepath);
// Check if root node exists, call already errors if not
avs_config_root_get(property);
return property;
}
struct property_node *avs_config_root_get(struct property *property)
{
struct property_node *node;
log_assert(property);
node = property_search(property, 0, AVS_CONFIG_ROOT_NODE);
if (node == NULL) {
log_fatal("Root node " AVS_CONFIG_ROOT_NODE " in AVS config missing");
}
return node;
}
struct property *
avs_config_property_merge(struct property *parent, struct property *source)
{
struct property_util_node_merge_strategies strategies;
log_assert(parent);
log_assert(source);
strategies.num = 2;
strategies.entry[0].path = _avs_config_property_mounttable_path;
strategies.entry[0].merge_strategy_do =
_avs_config_mounttable_vfs_nodes_merge_strategy_do;
strategies.entry[1].path = "";
strategies.entry[1].merge_strategy_do =
property_util_node_merge_default_strategy_do;
return property_util_merge_with_strategies(parent, source, &strategies);
}
void avs_config_fs_root_device_get(
struct property_node *node, char *buffer, size_t size)
{
struct property_node *device_node;
avs_error error;
log_assert(node);
device_node = property_search(NULL, node, "fs/root/device");
if (device_node == NULL) {
log_fatal("Could not find node fs/root/device AVS config");
}
error = property_node_read(device_node, PROPERTY_TYPE_STR, buffer, size);
if (AVS_IS_ERROR(error)) {
log_fatal(
"fs/root/device, property read failed: %s",
avs_util_error_str(error));
}
}
void avs_config_mode_product_set(struct property_node *node, bool enable)
{
log_assert(node);
#if AVS_VERSION <= 1306
property_util_node_u8_replace(NULL, node, "mode/product", enable ? 1 : 0);
#else
property_util_node_bool_replace(NULL, node, "mode/product", enable);
#endif
}
void avs_config_net_raw_set(struct property_node *node, bool enable)
{
log_assert(node);
#if AVS_VERSION <= 1306
property_util_node_u8_replace(NULL, node, "net/enable_raw", enable ? 1 : 0);
#else
property_util_node_bool_replace(NULL, node, "net/enable_raw", enable);
#endif
}
void avs_config_net_eaudp_set(struct property_node *node, bool enable)
{
log_assert(node);
#if AVS_VERSION <= 1306
property_util_node_u8_replace(
NULL, node, "net/eaudp/enable", enable ? 1 : 0);
#else
property_util_node_bool_replace(NULL, node, "net/eaudp/enable", enable);
#endif
}
void avs_config_sntp_ea_set(struct property_node *node, bool on)
{
log_assert(node);
#if AVS_VERSION <= 1306
property_util_node_u8_replace(NULL, node, "sntp/ea_on", on ? 1 : 0);
#else
property_util_node_bool_replace(NULL, node, "sntp/ea_on", on);
#endif
}
void avs_config_log_level_set(struct property_node *node, const char *level)
{
log_assert(node);
log_assert(level);
#if AVS_VERSION <= 1306
uint32_t level_value;
if (str_eq(level, "fatal")) {
level_value = 1;
} else if (str_eq(level, "warning")) {
level_value = 2;
} else if (str_eq(level, "info")) {
level_value = 3;
} else if (str_eq(level, "misc")) {
level_value = 4;
} else if (str_eq(level, "all")) {
level_value = 4;
} else if (str_eq(level, "disable")) {
level_value = 0;
} else if (str_eq(level, "default")) {
level_value = 4;
} else {
log_fatal("Unknown log level string %s", level);
}
property_util_node_u32_replace(NULL, node, "log/level", level_value);
#else
property_util_node_str_replace(NULL, node, "log/level", level);
#endif
}
void avs_config_log_name_set(struct property_node *node, const char *name)
{
log_assert(node);
log_assert(name);
property_util_node_str_replace(NULL, node, "log/name", name);
}
void avs_config_log_file_set(struct property_node *node, const char *file)
{
log_assert(node);
log_assert(file);
property_util_node_str_replace(NULL, node, "log/file", file);
}
void avs_config_log_buffer_size_set(struct property_node *node, uint32_t size)
{
log_assert(node);
property_util_node_u32_replace(NULL, node, "log/sz_buf", size);
}
void avs_config_log_output_delay_set(
struct property_node *node, uint16_t delay_ms)
{
log_assert(node);
property_util_node_u16_replace(NULL, node, "log/output_delay", delay_ms);
}
void avs_config_log_enable_console_set(struct property_node *node, bool enable)
{
log_assert(node);
#if AVS_VERSION <= 1306
property_util_node_u8_replace(
NULL, node, "log/enable_console", enable ? 1 : 0);
#else
property_util_node_bool_replace(NULL, node, "log/enable_console", enable);
#endif
}
void avs_config_log_enable_sci_set(struct property_node *node, bool enable)
{
log_assert(node);
#if AVS_VERSION <= 1306
property_util_node_u8_replace(
NULL, node, "log/enable_netsci", enable ? 1 : 0);
#else
property_util_node_bool_replace(NULL, node, "log/enable_netsci", enable);
#endif
}
void avs_config_log_enable_net_set(struct property_node *node, bool enable)
{
log_assert(node);
#if AVS_VERSION <= 1306
property_util_node_u8_replace(
NULL, node, "log/enable_netlog", enable ? 1 : 0);
#else
property_util_node_bool_replace(NULL, node, "log/enable_netlog", enable);
#endif
}
void avs_config_log_enable_file_set(struct property_node *node, bool enable)
{
log_assert(node);
#if AVS_VERSION <= 1306
property_util_node_u8_replace(
NULL, node, "log/enable_file", enable ? 1 : 0);
#else
property_util_node_bool_replace(NULL, node, "log/enable_file", enable);
#endif
}
void avs_config_log_rotate_set(struct property_node *node, bool rotate)
{
log_assert(node);
#if AVS_VERSION <= 1306
property_util_node_u8_replace(NULL, node, "log/rotate", rotate ? 1 : 0);
#else
property_util_node_bool_replace(NULL, node, "log/rotate", rotate);
#endif
}
void avs_config_log_append_set(struct property_node *node, bool append)
{
log_assert(node);
#if AVS_VERSION <= 1306
property_util_node_u8_replace(NULL, node, "log/append", append ? 1 : 0);
#else
property_util_node_bool_replace(NULL, node, "log/append", append);
#endif
}
void avs_config_log_count_set(struct property_node *node, uint16_t count)
{
log_assert(node);
property_util_node_u16_replace(NULL, node, "log/gen", count);
}
void avs_config_set_log_level(
struct property_node *node, enum core_log_bt_log_level loglevel)
{
const char *str;
log_assert(node);
switch (loglevel) {
case CORE_LOG_BT_LOG_LEVEL_OFF:
str = "disable";
break;
case CORE_LOG_BT_LOG_LEVEL_FATAL:
str = "fatal";
break;
case CORE_LOG_BT_LOG_LEVEL_WARNING:
str = "warn";
break;
case CORE_LOG_BT_LOG_LEVEL_INFO:
str = "info";
break;
case CORE_LOG_BT_LOG_LEVEL_MISC:
str = "misc";
break;
default:
log_fatal("Unsupported log level: %d", loglevel);
break;
}
avs_config_log_level_set(node, str);
}
void avs_config_local_fs_path_dev_nvram_and_raw_set(
struct property_node *node, const char *dev_nvram_raw_path)
{
char path_dev_raw[MAX_PATH];
char path_dev_nvram[MAX_PATH];
struct property_node *fs_node;
struct property_node *mounttable_node;
struct property_node *vfs_node;
log_assert(node);
log_assert(dev_nvram_raw_path);
str_cpy(path_dev_raw, sizeof(path_dev_raw), dev_nvram_raw_path);
str_cat(path_dev_raw, sizeof(path_dev_raw), "/dev/raw");
str_cpy(path_dev_nvram, sizeof(path_dev_nvram), dev_nvram_raw_path);
str_cat(path_dev_nvram, sizeof(path_dev_nvram), "/dev/nvram");
fs_node = property_search(NULL, node, "fs");
if (!fs_node) {
log_fatal("Cannot find 'fs' node in avs config");
}
// Check if "new" mounttable config is used for dev/nvram and dev/raw or
// legacy config
if (property_search(NULL, fs_node, "mounttable")) {
property_remove(NULL, fs_node, "mounttable");
mounttable_node = property_node_create(
NULL, fs_node, PROPERTY_TYPE_VOID, "mounttable");
vfs_node = property_node_create(
NULL, mounttable_node, PROPERTY_TYPE_VOID, "vfs");
property_node_create(
NULL, vfs_node, PROPERTY_TYPE_ATTR, "name", "boot");
property_node_create(
NULL, vfs_node, PROPERTY_TYPE_ATTR, "fstype", "fs");
property_node_create(
NULL, vfs_node, PROPERTY_TYPE_ATTR, "src", path_dev_raw);
property_node_create(
NULL, vfs_node, PROPERTY_TYPE_ATTR, "dest", "/dev/raw");
property_node_create(
NULL, vfs_node, PROPERTY_TYPE_ATTR, "opt", "vf=1,posix=1");
vfs_node = property_node_create(
NULL, mounttable_node, PROPERTY_TYPE_VOID, "vfs");
property_node_create(
NULL, vfs_node, PROPERTY_TYPE_ATTR, "name", "boot");
property_node_create(
NULL, vfs_node, PROPERTY_TYPE_ATTR, "fstype", "fs");
property_node_create(
NULL, vfs_node, PROPERTY_TYPE_ATTR, "src", path_dev_nvram);
property_node_create(
NULL, vfs_node, PROPERTY_TYPE_ATTR, "dest", "/dev/nvram");
property_node_create(
NULL, vfs_node, PROPERTY_TYPE_ATTR, "opt", "vf=1,posix=1");
} else {
property_util_node_str_replace(
NULL, fs_node, "nvram/device", path_dev_raw);
property_util_node_str_replace(NULL, fs_node, "nvram/fstype", "fs");
property_util_node_str_replace(
NULL, fs_node, "nvram/option", "vf=1,posix=1");
property_util_node_str_replace(
NULL, fs_node, "raw/device", path_dev_nvram);
property_util_node_str_replace(NULL, fs_node, "raw/fstype", "fs");
property_util_node_str_replace(
NULL, fs_node, "raw/option", "vf=1,posix=1");
}
}
void avs_config_vfs_mounttable_get(
struct property_node *node, struct avs_config_vfs_mounttable *mounttable)
{
struct property_node *fs_node;
struct property_node *mounttable_node;
struct property_node *cur;
char mounttable_selector[128];
char name[128];
uint8_t pos;
log_assert(node);
log_assert(mounttable);
fs_node = property_search(NULL, node, "fs");
if (!fs_node) {
log_fatal("Cannot find 'fs' node in avs config");
}
// Check if new mounttable config is used for dev/nvram and dev/raw or
// legacy config
mounttable_node = property_search(NULL, fs_node, "mounttable");
memset(mounttable, 0, sizeof(*mounttable));
pos = 0;
if (mounttable_node) {
cur = property_search(NULL, fs_node, "mounttable_selector");
if (!cur) {
log_fatal("Missing 'mounttable_selector' on mounttable");
}
if (AVS_IS_ERROR(property_node_read(
cur,
PROPERTY_TYPE_STR,
mounttable_selector,
sizeof(mounttable_selector)))) {
log_fatal("Reading 'mounttable_selector' failed");
}
log_misc("Mounttable selector: %s", mounttable_selector);
cur = property_node_traversal(mounttable_node, TRAVERSE_FIRST_CHILD);
while (cur) {
property_node_name(cur, name, sizeof(name));
if (str_eq(name, "vfs")) {
if (pos >= AVS_CONFIG_MOUNTTABLE_MAX_ENTRIES) {
log_warning(
"Exceeding max number of supported mounttable entries "
"(%d), ignoring remaining",
pos);
break;
}
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"name@",
PROPERTY_TYPE_ATTR,
name,
sizeof(name)))) {
log_fatal("Missing 'name' attribute on vfs node");
}
if (str_eq(name, mounttable_selector)) {
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"fstype@",
PROPERTY_TYPE_ATTR,
mounttable->entry[pos].fstype,
sizeof(mounttable->entry[pos].fstype)))) {
// default
str_cpy(
mounttable->entry[pos].fstype,
sizeof(mounttable->entry[pos].fstype),
"fs");
}
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"src@",
PROPERTY_TYPE_ATTR,
mounttable->entry[pos].src,
sizeof(mounttable->entry[pos].src)))) {
log_fatal(
"Missing 'src' attribute on vfs node, name: %s",
name);
}
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"dst@",
PROPERTY_TYPE_ATTR,
mounttable->entry[pos].dst,
sizeof(mounttable->entry[pos].dst)))) {
log_fatal(
"Missing 'dst' attribute on vfs node, name: %s",
name);
}
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"opt@",
PROPERTY_TYPE_ATTR,
mounttable->entry[pos].opt,
sizeof(mounttable->entry[pos].opt)))) {
// optional
}
pos++;
}
}
cur = property_node_traversal(cur, TRAVERSE_NEXT_SIBLING);
}
} else {
cur = property_search(NULL, fs_node, "nvram");
if (cur) {
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"fstype",
PROPERTY_TYPE_STR,
mounttable->entry[pos].fstype,
sizeof(mounttable->entry[pos].fstype)))) {
// default
str_cpy(
mounttable->entry[pos].fstype,
sizeof(mounttable->entry[pos].fstype),
"fs");
}
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"device",
PROPERTY_TYPE_STR,
mounttable->entry[pos].src,
sizeof(mounttable->entry[pos].src)))) {
log_fatal("Missing 'device' attribute on nvram node");
}
str_cpy(
mounttable->entry[pos].dst,
sizeof(mounttable->entry[pos].dst),
"/dev/nvram");
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"opt",
PROPERTY_TYPE_STR,
mounttable->entry[pos].opt,
sizeof(mounttable->entry[pos].opt)))) {
// optional
}
pos++;
}
cur = property_search(NULL, fs_node, "raw");
if (cur) {
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"fstype",
PROPERTY_TYPE_STR,
mounttable->entry[pos].fstype,
sizeof(mounttable->entry[pos].fstype)))) {
// default
str_cpy(
mounttable->entry[pos].fstype,
sizeof(mounttable->entry[pos].fstype),
"fs");
}
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"device",
PROPERTY_TYPE_STR,
mounttable->entry[pos].src,
sizeof(mounttable->entry[pos].src)))) {
log_fatal("Missing 'device' attribute on raw node");
}
str_cpy(
mounttable->entry[pos].dst,
sizeof(mounttable->entry[pos].dst),
"/dev/raw");
if (AVS_IS_ERROR(property_node_refer(
NULL,
cur,
"opt",
PROPERTY_TYPE_STR,
mounttable->entry[pos].opt,
sizeof(mounttable->entry[pos].opt)))) {
// optional
}
pos++;
}
}
mounttable->num_entries = pos;
}