Resolve "Refactor CLI for scord and scord-ctl"

Alberto Mirandarequested to merge
amiranda/127-refactor-cli-for-scord-and-scord-ctl into main

Closes #127 (closed)

Merge request reports

etc/scord.conf.in

+4 −17
Changes for etc/scord.conf.in: 4 added lines, 17 removed lines.
Original line number Diff line number Diff line 
## vim: set filetype=yaml:



## global service settings

global_settings: [



  # if true, dump log messages to syslog

  use_syslog: false,

global_settings:



  # log file

  log_file: "@CMAKE_INSTALL_FULL_LOCALSTATEDIR@/@CMAKE_PROJECT_NAME@/@CMAKE_PROJECT_NAME@.log",

  logfile: "@CMAKE_INSTALL_FULL_LOCALSTATEDIR@/@CMAKE_PROJECT_NAME@/@CMAKE_PROJECT_NAME@.log"



  # path to pidfile

  pidfile: "@CMAKE_INSTALL_FULL_RUNSTATEDIR@/@CMAKE_PROJECT_NAME@/@CMAKE_PROJECT_NAME@.pid",



  # transport protocol used for communication

  transport_protocol: "@SCORD_TRANSPORT_PROTOCOL@",

  rundir: "@CMAKE_INSTALL_FULL_RUNSTATEDIR@/@CMAKE_PROJECT_NAME@"



  # address to bind to

  bind_address: "@SCORD_BIND_ADDRESS@",



  # incoming port for remote connections

  remote_port: @SCORD_BIND_PORT@,



  # number of worker threads to serve I/O requests

  workers: 4,

]
 
  address: "@SCORD_TRANSPORT_PROTOCOL@://@SCORD_BIND_ADDRESS@:@SCORD_BIND_PORT@"

examples/CMakeLists.txt

+0 −1
Changes for examples/CMakeLists.txt: 0 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -31,7 +31,6 @@ if(SCORD_BUILD_TESTS) 
  file(MAKE_DIRECTORY ${TEST_DIRECTORY})



  set(TEST_ENV)

  list(APPEND TEST_ENV SCORD_LOG=1)

  list(APPEND TEST_ENV SCORD_LOG_OUTPUT=${TEST_DIRECTORY}/scord_daemon.log)



  add_test(start_scord_daemon

src/common/config/CMakeLists.txt

deleted100644 → 0
+0 −87
Changes for src/common/config/CMakeLists.txt: 0 added lines, 87 removed lines.
Original line number Diff line number Diff line 
################################################################################

# Copyright 2021, Barcelona Supercomputing Center (BSC), Spain                 #

#                                                                              #

# This software was partially supported by the EuroHPC-funded project ADMIRE   #

#   (Project ID: 956748, https://www.admire-eurohpc.eu).                       #

#                                                                              #

# This file is part of scord.                                                  #

#                                                                              #

# scord is free software: you can redistribute it and/or modify                #

# it under the terms of the GNU General Public License as published by         #

# the Free Software Foundation, either version 3 of the License, or            #

# (at your option) any later version.                                          #

#                                                                              #

# scord is distributed in the hope that it will be useful,                     #

# but WITHOUT ANY WARRANTY; without even the implied warranty of               #

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                #

# GNU General Public License for more details.                                 #

#                                                                              #

# You should have received a copy of the GNU General Public License            #

# along with scord.  If not, see <https://www.gnu.org/licenses/>.              #

#                                                                              #

# SPDX-License-Identifier: GPL-3.0-or-later                                    #

################################################################################



# Create a config target for all configuration code

add_library(_config STATIC)



# Since some of the sources will be auto-generated, we need to search for

# includes in ${CMAKE_CURRENT_BINARY_DIR}

target_include_directories(

  _config PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}

                 ${CMAKE_CURRENT_BINARY_DIR}

)

set_property(TARGET _config PROPERTY POSITION_INDEPENDENT_CODE ON)



target_sources(

  _config

  PRIVATE config.hpp

          defaults.hpp

          ${CMAKE_CURRENT_BINARY_DIR}/defaults.cpp

          ${CMAKE_CURRENT_BINARY_DIR}/config_options.hpp

          ${CMAKE_CURRENT_BINARY_DIR}/keywords.hpp

          parsers.cpp

          parsers.hpp

          settings.cpp

          settings.hpp

)



target_link_libraries(_config PRIVATE common::utils file_options::file_options)



# ##############################################################################

# Produce several auto-generated files for 'config'

# ##############################################################################



# Default values for options

configure_file(defaults.cpp.in defaults.cpp)



# Automatic generation of file_options schemas. To facilitate the management of

# any file-based configuration options, we generate a C++ schema from a YAML

# file that allows the 'file_options' library to parse them fromm a

# configuration file. The process works as follows:

#  1. We define the desired options in 'file_options.yml'

#  2. We rely on the 'genopts' tool to generate valid C++ schemas for the

#     'file_options' library. This tool can be configured using a 'genopts.yml'

#     configuration file.

#  3. In the daemon code, we use the facilities provided by the 'file_options'

#     library to access the options values.



# Since the configuration in genopts.yml can be path-dependant, we rely on

# CMake to substitute any special @variables@ for their actual values

configure_file(genopts.yml.in genopts.yml @ONLY)



# Define the command that will generate config_options.hpp and keywords.hpp.

# It will be executed since there is a direct dependency between 'config'

# (defined below) and these output files.

# We also make the command depend on file_options.yml and genopts.yml so that

# it gets re-executed if they change.

add_custom_command(

  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/config_options.hpp

         ${CMAKE_CURRENT_BINARY_DIR}/keywords.hpp

  COMMENT "Generating config_options.hpp, keywords.hpp"

  DEPENDS genopts_virtualenv file_options.yml ${CMAKE_CURRENT_BINARY_DIR}/genopts.yml

  COMMAND

    Genopts::Python3_Interpreter -m genopts --config

    ${CMAKE_CURRENT_BINARY_DIR}/genopts.yml

    ${CMAKE_CURRENT_LIST_DIR}/file_options.yml

)

src/common/config/config.hpp

deleted100644 → 0
+0 −31
Changes for src/common/config/config.hpp: 0 added lines, 31 removed lines.
Original line number Diff line number Diff line 
/******************************************************************************

 * Copyright 2021, Barcelona Supercomputing Center (BSC), Spain

 *

 * This software was partially supported by the EuroHPC-funded project ADMIRE

 *   (Project ID: 956748, https://www.admire-eurohpc.eu).

 *

 * This file is part of scord.

 *

 * scord is free software: you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation, either version 3 of the License, or

 * (at your option) any later version.

 *

 * scord is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with scord.  If not, see <https://www.gnu.org/licenses/>.

 *

 * SPDX-License-Identifier: GPL-3.0-or-later

 *****************************************************************************/



#ifndef SCORD_CONFIG_HPP

#define SCORD_CONFIG_HPP



#include "defaults.hpp"

#include "settings.hpp"



#endif /* SCORD_CONFIG_HPP */

src/common/config/defaults.cpp.in

deleted100644 → 0
+0 −52
Changes for src/common/config/defaults.cpp.in: 0 added lines, 52 removed lines.
Original line number Diff line number Diff line 
/******************************************************************************

 * Copyright 2021, Barcelona Supercomputing Center (BSC), Spain

 *

 * This software was partially supported by the EuroHPC-funded project ADMIRE

 *   (Project ID: 956748, https://www.admire-eurohpc.eu).

 *

 * This file is part of scord.

 *

 * scord is free software: you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation, either version 3 of the License, or

 * (at your option) any later version.

 *

 * scord is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with scord.  If not, see <https://www.gnu.org/licenses/>.

 *

 * SPDX-License-Identifier: GPL-3.0-or-later

 *****************************************************************************/



/* DO NOT MODIFY: This file is autogenerated by CMake */

#include <thread>

#include <filesystem>

#include <config/defaults.hpp>

#include <netinet/in.h>

#include <cstdint>



namespace scord::config::defaults {



const char* progname = "@CMAKE_PROJECT_NAME@";

const bool daemonize = true;

const bool use_syslog = false;

const bool use_console = false;

const std::filesystem::path log_file = {};

const uint32_t log_file_max_size = static_cast<uint32_t>(16 * 1024 * 1024);



const char* transport_protocol = "ofi+tcp";

const char* bind_address = "127.0.0.1";

const in_port_t remote_port = 42000;

const char* pidfile =

        "@CMAKE_INSTALL_FULL_LOCALSTATEDIR@/@CMAKE_PROJECT_NAME@.pid";



const uint32_t workers_in_pool = std::thread::hardware_concurrency();

const uint32_t backlog_size = 128;

const char* config_file =

        "@CMAKE_INSTALL_FULL_SYSCONFDIR@/@CMAKE_PROJECT_NAME@.conf";



} // namespace scord::config::defaults