# fss-0000
+_di_libcap_ Disable libcap support, allow for compiling and linking without libcap (-lcap).
_di_thread_support_ Disables thread support.
+_libcap_legacy_only_ Disable functionality provided by later versions of libcap (2.43 and later).
+
_controller_as_init_ The controller program is compiled as an init replacement and this control program should treat it as such.
+
+_override_control_path_settings_ Use this as the default full path to the controlsettings.
+_override_control_path_settings_length_ The number of bytes representing the string in _override_controller_path_settings_length_ (not including the terminating NULL).
+
_override_controller_name_socket_ Use this as the default custom file name representing the controller program socket.
_override_controller_name_socket_length_ The number of bytes representing the string in _override_controller_name_socket_ (not including the terminating NULL).
-_override_controller_path_socket_ Use this as the default custom directory path representing the location of the controller program socket.
-_override_controller_path_socket_length_ The number of bytes representing the string in _override_controller_path_socket_ (not including the terminating NULL).
+
+_override_controller_default_engine_ Provide a custom scripting engine name string to execute (such as php).
+_override_controller_path_pid_ Use this as the default custom directory path representing the location of the controller program pid.
+_override_controller_path_pid_prefix_ Use this as the default custom prefix prepended to the file name of the file representing the controller program pid.
+_override_controller_path_pid_suffix_ Use this as the default custom prefix prepended to the file name of the file representing the controller program pid.
+_override_controller_path_settings_ Use this as the default custom settings path, such as /etc/settings.
+_override_controller_path_socket_ Use this as the default custom directory path representing the location of the controller program socket.
_override_controller_path_socket_prefix_ Use this as the default custom prefix prepended to the file name of the file representing the controller program socket.
-_override_controller_path_socket_prefix_length_ The number of bytes representing the string in _override_controller_path_socket_prefix_ (not including the terminating NULL).
_override_controller_path_socket_suffix_ Use this as the default custom prefix prepended to the file name of the file representing the controller program socket.
+
+_override_controller_default_engine_length_ The number of bytes representing the string in _override_controller_default_engine_ (not including the terminating NULL).
+_override_controller_path_pid_length_ The number of bytes representing the string in _override_controller_path_pid_ (not including the terminating NULL).
+_override_controller_path_pid_prefix_length_ The number of bytes representing the string in _override_controller_path_pid_prefix_ (not including the terminating NULL).
+_override_controller_path_pid_suffix_length_ The number of bytes representing the string in _override_controller_path_pid_suffix_ (not including the terminating NULL).
+_override_controller_path_settings_length_ The number of bytes representing the string in _override_controller_path_settings_ (not including the terminating NULL).
+_override_controller_path_socket_length_ The number of bytes representing the string in _override_controller_path_socket_ (not including the terminating NULL).
+_override_controller_path_socket_prefix_length_ The number of bytes representing the string in _override_controller_path_socket_prefix_ (not including the terminating NULL).
_override_controller_path_socket_suffix_length_ The number of bytes representing the string in _override_controller_path_socket_suffix_ (not including the terminating NULL).
-_override_control_path_settings_ Use this as the default full path to the controlsettings.
-_override_control_path_settings_length_ The number of bytes representing the string in _override_controller_path_settings_length_ (not including the terminating NULL).
-_pthread_attr_unsupported_ Disable non-portable functionality associated with pthread_attr.
+_pthread_attr_unsupported_ Disable non-portable functionality associated with pthread_attr.
_pthread_sigqueue_unsupported_ Disable GNU specific sigqueue().
print
print The following operations are available\:
- print " - context:'notable'help:context:'reset' Perform the help operation, printing this message."
- print " - context:'notable'install:context:'reset' A helper operation that calls the ./install.sh script for the control program."
- print " - context:'notable'main:context:'reset' Compilation using the build settings mode for the control program (default)."
+ print " - context:'notable'help:context:'reset' Perform the help operation, printing this message."
+ print " - context:'notable'install:context:'reset' A helper operation that calls the ./install.sh script for the control program."
+ print " - context:'notable'main:context:'reset' Compilation using the build settings mode for the control program (default)."
print
print The context:'notable'install context:'reset'operation supports the context:'notable'work,context:'reset' context:'notable'verbosity,context:'reset' and context:'notable'color context:'reset'parameters.
# - individual_thread: This is required when compiling in individual mode with "thread" mode.
# - level: Compile using per level libraries.
# - monolithic: Compile using per monolithic libraries.
-# - clang: Use clang rather than the default, which is generally gcc.
-# - gcc: Use gcc specific settings.
+# - clang: Use CLang rather than the default, which is generally GCC.
+# - gcc: Use GCC specific settings.
# - test: Compile for a test, such as unit testing.
# - fanalyzer: Compile using GCC's -fanalyzer compile time option.
# - coverage: Compile for building coverage.
build_libraries-level -lfll_2 -lfll_1 -lfll_0
build_libraries-monolithic -lfll
-build_sources_library main/common.c main/common/define.c main/common/enumeration.c main/common/print.c main/common/string.c main/common/type.c
-build_sources_library main/print/data.c main/print/debug.c main/print/error.c main/print/message.c main/print/warning.c
-build_sources_library main/action.c main/control.c main/packet.c main/payload.c main/signal.c main/thread.c
+build_sources_library common.c common/define.c common/enumeration.c common/print.c common/string.c common/type.c
+build_sources_library print/data.c print/debug.c print/error.c print/message.c print/warning.c
+build_sources_library action.c packet.c payload.c signal.c thread.c
-build_sources_headers main/common.h main/common/define.h main/common/enumeration.h main/common/print.h main/common/string.h main/common/type.h
-build_sources_headers main/print/data.h main/print/debug.h main/print/error.h main/print/message.h main/print/warning.h
-build_sources_headers main/action.h main/control.h main/packet.h main/payload.h main/signal.h main/thread.h
+build_sources_headers common.h common/define.h common/enumeration.h common/print.h common/string.h common/type.h
+build_sources_headers print/data.h print/debug.h print/error.h print/message.h print/warning.h
+build_sources_headers action.h control.h packet.h payload.h signal.h thread.h
build_sources_documentation man
path_program_script script
path_program_shared shared
path_program_static static
+path_sources sources/c/program/control/main
has_path_standard no
preserve_path_headers yes
data.setting.flag |= control_main_flag_interruptible_e;
+ data.setting.socket.domain = f_socket_protocol_family_local_e;
+ data.setting.socket.type = f_socket_type_stream_e;
+ data.setting.socket.length = sizeof(struct sockaddr_un);
+
fll_program_standard_set_up(&data.program);
f_file_umask_get(&data.program.umask);
- {
- const f_console_arguments_t arguments = macro_f_console_arguments_t_initialize_1(argc, argv, envp);
+ #ifdef _di_thread_support_
+ {
+ const f_console_arguments_t arguments = macro_f_console_arguments_t_initialize_1(argc, argv, envp);
- control_setting_load(arguments, &data);
- }
+ control_setting_load(arguments, &data);
+ }
+
+ control_process(&data);
+ #else
+ {
+ f_thread_id_t id_signal;
+
+ memset(&id_signal, 0, sizeof(f_thread_id_t));
+
+ data.setting.state.status = f_thread_create(0, &id_signal, &control_thread_signal, (void *) &data);
+
+ if (F_status_is_error(data.setting.state.status)) {
+ control_print_error(&data.program.error, macro_control_f(f_thread_create));
+ }
+ else {
+ {
+ const f_console_arguments_t arguments = macro_f_console_arguments_t_initialize_1(argc, argv, envp);
+
+ control_setting_load(arguments, &data);
+ }
+
+ if (!control_signal_check(&data)) {
+ control_process(&data);
+ }
- control_process(&data);
+ f_thread_cancel(id_signal);
+ f_thread_join(id_signal, 0);
+ }
+ }
+ #endif // _di_thread_support_
control_delete(&data);
#endif // _di_control_action_type_name_
#ifndef _di_control_action_verify_
- void control_action_verify(control_main_t * const main) {
+ void control_action_verify(control_t * const main) {
if (!main) return;
* F_parameter (with error bit) on parameter validation/verification failure.
*/
#ifndef _di_control_action_verify_
- extern void control_action_verify(control_main_t * const main);
+ extern void control_action_verify(control_t * const main);
#endif // _di_control_action_verify_
#ifdef __cplusplus
#endif
#ifndef _di_control_setting_load_
- void control_setting_load(const f_console_arguments_t arguments, control_main_t * const main) {
+ void control_setting_load(const f_console_arguments_t arguments, control_t * const main) {
if (!main) return;
* @see fll_program_parameter_process_context()
*/
#ifndef _di_control_setting_load_
- extern void control_setting_load(const f_console_arguments_t arguments, control_main_t * const main);
+ extern void control_setting_load(const f_console_arguments_t arguments, control_t * const main);
#endif // _di_control_setting_load_
#ifdef __cplusplus
#endif // _di_control_default_d_
/**
+ * A codes repesent different flags associated with a packet.
+ *
+ * control_packet_flag_*_d:
+ * - binary: Designate that the packet is in binary mode (when not set then packet is in string mode).
+ * - endian_big: Designate that the packet is in big endian order (when not set then packet is in little endian order).
+ */
+#ifndef _di_control_packet_flag_d_
+ #define control_packet_flag_binary_d 0x80
+ #define control_packet_flag_endian_big_d 0x40
+#endif // _di_control_packet_flag_d_
+
+/**
* The program signal defines.
*
* control_signal_*_d:
/**
* Codes representing supported actions.
*
- * freeze: Perform the freeze controller operation.
- * kexec: Perform the kexec controller operation (only for init mode).
- * kill: Perform the kill controller operation.
- * pause: Perform the pause controller operation.
- * reboot: Perform the reboot controller operation (only for init mode).
- * reload: Perform the reload controller operation.
- * rerun: Perform the rerun controller operation.
- * restart: Perform the restart controller operation.
- * resume: Perform the resume controller operation.
- * shutdown: Perform the shutdown controller operation (only for init mode).
- * start: Perform the start controller operation.
- * stop: Perform the stop controller operation.
- * thaw: Perform the thaw controller operation.
+ * control_action_type_*_e:
+ * - none: No type set.
+ * - freeze: Perform the freeze controller operation.
+ * - kexec: Perform the kexec controller operation (only for init mode).
+ * - kill: Perform the kill controller operation.
+ * - pause: Perform the pause controller operation.
+ * - reboot: Perform the reboot controller operation (only for init mode).
+ * - reload: Perform the reload controller operation.
+ * - rerun: Perform the rerun controller operation.
+ * - restart: Perform the restart controller operation.
+ * - resume: Perform the resume controller operation.
+ * - shutdown: Perform the shutdown controller operation (only for init mode).
+ * - start: Perform the start controller operation.
+ * - stop: Perform the stop controller operation.
+ * - thaw: Perform the thaw controller operation.
*/
#ifndef _di_control_action_type_e_
enum {
- control_action_type_freeze_e = 1,
+ control_action_type_none_e = 0,
+ control_action_type_freeze_e,
control_action_type_kexec_e,
control_action_type_kill_e,
control_action_type_pause_e,
#endif // _di_control_action_type_e_
/**
- * Supported payload types.
- *
- * controller: The payload is a controller payload.
- * error: The payload is an error payload.
- * init: The payload is an init payload (only available when operating in "init" mode).
- */
-#ifndef _di_control_payload_type_e_
- enum {
- control_payload_type_controller_e = 1,
- control_payload_type_error_e,
- control_payload_type_init_e,
- }; // enum
-#endif // _di_control_payload_type_e_
-
-/**
- * A codes repesent different flags associated with a packet.
- *
- * control_packet_flag_*:
- * - binary: Designate that the packet is in binary mode (when not set then packet is in string mode).
- * - endian_big: Designate that the packet is in big endian order (when not set then packet is in little endian order).
- */
-#ifndef _di_control_packet_flag_e_
- #define control_packet_flag_binary_d 0x80
- #define control_packet_flag_endian_big_d 0x40
-#endif // _di_control_packet_flag_e_
-
-/**
* Flags passed to the main function or program.
*
* control_main_flag_*_e:
* - header: Enable printing of headers.
* - help: Print help.
* - pipe: Use the input pipe.
- * - return: The parameter is specified.
+ * - return: Print a message about the response packet.
* - version: Print version.
* - version_copyright_help: A helper flag representing version, copyright, and help flag bits being set.
*/
#endif // _di_control_main_flag_e_
/**
+ * Supported payload types.
+ *
+ * control_payload_type_*_e:
+ * - controller: The payload is a controller payload.
+ * - error: The payload is an error payload.
+ * - init: The payload is an init payload (only available when operating in "init" mode).
+ */
+#ifndef _di_control_payload_type_e_
+ enum {
+ control_payload_type_controller_e = 1,
+ control_payload_type_error_e,
+ control_payload_type_init_e,
+ }; // enum
+#endif // _di_control_payload_type_e_
+
+/**
* The main program parameters.
*/
-#ifndef _di_control_parameter_d_
+#ifndef _di_control_parameter_e_
enum {
control_parameter_name_e = f_console_standard_parameter_last_e,
control_parameter_return_e,
}
#define control_parameter_total_d (f_console_parameter_state_type_total_d + 4)
-#endif // _di_control_parameter_d_
+#endif // _di_control_parameter_e_
/**
* Flags for fine-tuned print control.
const f_string_static_t control_program_version_s = macro_f_string_static_t_initialize_1(CONTROL_program_version_s, 0, CONTROL_program_version_s_length);
#endif // _di_control_program_version_s_
-#ifndef _di_control_program_name_s_
- const f_string_static_t control_program_name_s = macro_f_string_static_t_initialize_1(CONTROL_program_name_s, 0, CONTROL_program_name_s_length);
- const f_string_static_t control_program_name_long_s = macro_f_string_static_t_initialize_1(CONTROL_program_name_long_s, 0, CONTROL_program_name_long_s_length);
-#endif // _di_control_program_name_s_
-
#ifndef _di_control_parameter_s_
const f_string_static_t control_short_name_s = macro_f_string_static_t_initialize_1(CONTROL_short_name_s, 0, CONTROL_short_name_s_length);
const f_string_static_t control_short_return_s = macro_f_string_static_t_initialize_1(CONTROL_short_return_s, 0, CONTROL_short_return_s_length);
extern "C" {
#endif
-#ifndef _di_control_main_delete_
- void control_main_delete(control_main_t * const main) {
+#ifndef _di_control_delete_
+ void control_delete(control_t * const control) {
- if (!main) return;
+ if (!control) return;
- fll_program_data_delete(&main->program);
- control_setting_delete(&main->setting);
+ fll_program_data_delete(&control->program);
+ control_setting_delete(&control->setting);
- f_memory_array_resize(0, sizeof(f_char_t), (void **) &main->cache.large.string, &main->cache.large.used, &main->cache.large.size);
- f_memory_array_resize(0, sizeof(f_char_t), (void **) &main->cache.small.string, &main->cache.small.used, &main->cache.small.size);
- f_memory_array_resize(0, sizeof(f_char_t), (void **) &main->cache.packet.string, &main->cache.packet.used, &main->cache.packet.size);
+ f_memory_array_resize(0, sizeof(f_char_t), (void **) &control->cache.large.string, &control->cache.large.used, &control->cache.large.size);
+ f_memory_array_resize(0, sizeof(f_char_t), (void **) &control->cache.small.string, &control->cache.small.used, &control->cache.small.size);
+ f_memory_array_resize(0, sizeof(f_char_t), (void **) &control->cache.packet.string, &control->cache.packet.used, &control->cache.packet.size);
- f_memory_array_resize(0, sizeof(f_range_t), (void **) &main->cache.objects.array, &main->cache.objects.used, &main->cache.objects.size);
- f_memory_arrays_resize(0, sizeof(f_ranges_t), (void **) &main->cache.contents.array, &main->cache.contents.used, &main->cache.contents.size, &f_rangess_delete_callback);
+ f_memory_array_resize(0, sizeof(f_range_t), (void **) &control->cache.objects.array, &control->cache.objects.used, &control->cache.objects.size);
+ f_memory_arrays_resize(0, sizeof(f_ranges_t), (void **) &control->cache.contents.array, &control->cache.contents.used, &control->cache.contents.size, &f_rangess_delete_callback);
- f_memory_array_resize(0, sizeof(f_range_t), (void **) &main->cache.packet_objects.array, &main->cache.packet_objects.used, &main->cache.packet_objects.size);
- f_memory_arrays_resize(0, sizeof(f_ranges_t), (void **) &main->cache.packet_contents.array, &main->cache.packet_contents.used, &main->cache.packet_contents.size, &f_rangess_delete_callback);
+ f_memory_array_resize(0, sizeof(f_range_t), (void **) &control->cache.packet_objects.array, &control->cache.packet_objects.used, &control->cache.packet_objects.size);
+ f_memory_arrays_resize(0, sizeof(f_ranges_t), (void **) &control->cache.packet_contents.array, &control->cache.packet_contents.used, &control->cache.packet_contents.size, &f_rangess_delete_callback);
- f_memory_array_resize(0, sizeof(f_range_t), (void **) &main->cache.header_objects.array, &main->cache.header_objects.used, &main->cache.header_objects.size);
- f_memory_arrays_resize(0, sizeof(f_ranges_t), (void **) &main->cache.header_contents.array, &main->cache.header_contents.used, &main->cache.header_contents.size, &f_rangess_delete_callback);
+ f_memory_array_resize(0, sizeof(f_range_t), (void **) &control->cache.header_objects.array, &control->cache.header_objects.used, &control->cache.header_objects.size);
+ f_memory_arrays_resize(0, sizeof(f_ranges_t), (void **) &control->cache.header_contents.array, &control->cache.header_contents.used, &control->cache.header_contents.size, &f_rangess_delete_callback);
- f_memory_array_resize(0, sizeof(f_number_unsigned_t), (void **) &main->cache.delimits.array, &main->cache.delimits.used, &main->cache.delimits.size);
+ f_memory_array_resize(0, sizeof(f_number_unsigned_t), (void **) &control->cache.delimits.array, &control->cache.delimits.used, &control->cache.delimits.size);
}
-#endif // _di_control_main_delete_
+#endif // _di_control_delete_
#ifndef _di_control_setting_delete_
void control_setting_delete(control_setting_t * const setting) {
* - setting: The settings data.
* - cache: The cache data.
*/
-#ifndef _di_control_main_t_
+#ifndef _di_control_t_
typedef struct {
fll_program_data_t program;
+
control_setting_t setting;
control_cache_t cache;
- } control_main_t;
+ } control_t;
- #define control_main_t_initialize \
+ #define control_t_initialize \
{ \
fll_program_data_t_initialize, \
control_setting_t_initialize, \
control_cache_t_initialize, \
}
-#endif // _di_control_main_t_
+#endif // _di_control_t_
/**
- * Deallocate main program data.
+ * Deallocate control data.
*
- * @param main
- * The main program data.
+ * @param control
+ * The control data.
*
* Must not be NULL.
*
* @see fll_program_data_delete()
* @see control_setting_delete()
*/
-#ifndef _di_control_main_delete_
- extern void control_main_delete(control_main_t * const main);
-#endif // _di_control_main_delete_
+#ifndef _di_control_delete_
+ extern void control_delete(control_t * const control);
+#endif // _di_control_delete_
/**
* Delete the program main setting data.
+++ /dev/null
-#include "control.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#ifndef _di_control_main_
- void control_main(control_main_t * const main) {
-
- if (!main) return;
- if (F_status_is_error(main->setting.state.status)) return;
-
- main->setting.state.status = F_okay;
-
- if (main->setting.flag & control_main_flag_version_copyright_help_e) {
- if (main->setting.flag & control_main_flag_help_e) {
- control_print_message_help(&main->program.message);
- }
- else if (main->setting.flag & control_main_flag_version_e) {
- fll_program_print_version(&main->program.message, control_program_version_s);
- }
- else if (main->setting.flag & control_main_flag_copyright_e) {
- fll_program_print_copyright(&main->program.message, fll_program_copyright_year_author_s);
- }
-
- return;
- }
-
- if (main->setting.flag & control_main_flag_pipe_e) {
- control_print_error_pipe_supported_not(&main->program.error);
-
- main->setting.state.status = F_status_set_error(F_support_not);
- }
- else if (main->setting.actions.used) {
- main->setting.action = control_action_type_identify(main->setting.actions.array[0]);
-
- if (main->setting.action) {
- control_action_verify(main);
- }
- else {
- control_print_error_parameter_action_not(&main->program.error, main->setting.actions.array[0]);
-
- main->setting.state.status = F_status_set_error(F_parameter);
- }
-
- if (F_status_is_error_not(main->setting.state.status)) {
- control_packet_build(main);
-
- if (F_status_is_error(main->setting.state.status)) {
- if (F_status_set_fine(main->setting.state.status) == F_too_large) {
- control_print_error_request_packet_too_large(&main->program.error);
- }
- else {
- control_print_error(&main->program.error, macro_control_f(control_packet_build));
- }
- }
-
- if (F_status_is_error_not(main->setting.state.status)) {
- control_packet_send(main);
-
- if (F_status_is_error(main->setting.state.status)) {
- control_print_error(&main->program.error, macro_control_f(control_packet_send));
- }
- }
-
- if (F_status_is_error_not(main->setting.state.status)) {
- control_payload_header_t header = control_payload_header_t_initialize;
-
- control_packet_receive(main, &header);
-
- if (F_status_is_error(main->setting.state.status)) {
- if (F_status_set_fine(main->setting.state.status) == F_too_large) {
- control_print_error_response_packet_valid_not(&main->program.error);
- }
- else {
- control_print_error(&main->program.error, macro_control_f(control_packet_receive));
- }
- }
- else {
- control_packet_process(main, &header);
-
- // Print the error message only if the error message is not already printed.
- if (F_status_is_error(main->setting.state.status)) {
- if (header.type != control_payload_type_error_e && (header.type != control_payload_type_controller_e || F_status_set_fine(main->setting.state.status) != header.status || (header.status != F_failure && header.status != F_busy))) {
- control_print_error(&main->program.error, macro_control_f(control_packet_process));
- }
- }
- }
- }
- }
-
- if (main->setting.socket.id != -1) {
- f_socket_disconnect(&main->setting.socket, f_socket_close_fast_e);
- }
- }
- else {
- control_print_error_parameter_actions_none(&main->program.error);
-
- main->setting.state.status = F_status_set_error(F_data_not);
- }
-
- if (F_status_is_error(main->setting.state.status)) return;
-
- main->setting.state.status = F_okay;
- }
-#endif // _di_control_main_
-
-#ifdef __cplusplus
-} // extern "C"
-#endif
extern "C" {
#endif
-/**
- * Execute main program.
- *
- * If main.signal is non-zero, then this blocks and handles the following signals:
- * - F_signal_abort
- * - F_signal_broken_pipe
- * - F_signal_hangup
- * - F_signal_interrupt
- * - F_signal_quit
- * - F_signal_termination
- *
- * @param main
- * The main program data and settings.
- *
- * This alters main.setting.state.status:
- * F_okay on success.
- * F_true on success when performing verification and verify passed.
- * F_false on success when performing verification and verify failed.
- *
- * F_interrupt (with error bit) on (exit) signal received.
- * F_parameter (with error bit) if main is NULL or setting is NULL.
- */
-#ifndef _di_control_main_
- extern void control_main(control_main_t * const main);
-#endif // _di_control_main_
-
#ifdef __cplusplus
} // extern "C"
#endif
+++ /dev/null
-#include "control.h"
-
-int main(const int argc, const f_string_t *argv, const f_string_t *envp) {
-
- control_main_t data = control_main_t_initialize;
-
- data.program.debug.flag |= control_print_flag_debug_e | control_print_flag_out_e;
- data.program.error.flag |= control_print_flag_error_e | control_print_flag_out_e;
- data.program.output.flag |= control_print_flag_out_e;
- data.program.message.flag |= control_print_flag_message_e | control_print_flag_out_e;
- data.program.warning.flag |= control_print_flag_warning_e | control_print_flag_out_e;
- data.program.error.custom = (void *) &data;
- data.program.debug.custom = (void *) &data;
- data.program.message.custom = (void *) &data;
- data.program.output.custom = (void *) &data;
- data.program.warning.custom = (void *) &data;
-
- f_console_parameter_t parameters[] = control_console_parameter_t_initialize;
-
- data.program.parameters.array = parameters;
- data.program.parameters.used = control_parameter_total_d;
- data.program.environment = envp;
-
- data.setting.socket.domain = f_socket_protocol_family_local_e;
- data.setting.socket.type = f_socket_type_stream_e;
- data.setting.socket.length = sizeof(struct sockaddr_un);
-
- if (f_pipe_input_exists()) {
- data.program.pipe = fll_program_data_pipe_input_e;
- }
-
- fll_program_standard_set_up(&data.program);
-
- f_file_umask_get(&data.program.umask);
-
- #ifdef _di_thread_support_
- {
- const f_console_arguments_t arguments = macro_f_console_arguments_t_initialize_1(argc, argv, envp);
-
- control_setting_load(arguments, &data);
- }
-
- control_main(&data);
- #else
- {
- f_thread_id_t id_signal;
-
- memset(&id_signal, 0, sizeof(f_thread_id_t));
-
- data.setting.state.status = f_thread_create(0, &id_signal, &control_thread_signal, (void *) &data);
-
- if (F_status_is_error(data.setting.state.status)) {
- control_print_error(&data.program.error, macro_control_f(f_thread_create));
- }
- else {
- {
- const f_console_arguments_t arguments = macro_f_console_arguments_t_initialize_1(argc, argv, envp);
-
- control_setting_load(arguments, &data);
- }
-
- if (!control_signal_check(&data)) {
- control_main(&data);
- }
-
- f_thread_cancel(id_signal);
- f_thread_join(id_signal, 0);
- }
- }
- #endif // _di_thread_support_
-
- control_main_delete(&data);
-
- fll_program_standard_set_down(&data.program);
-
- return (F_status_is_error(data.setting.state.status) || data.setting.state.status == F_false) ? 1 : 0;
-}
+++ /dev/null
-/**
- * FLL - Level 3
- *
- * Project: Control
- * API Version: 0.7
- * Licenses: lgpl-2.1-or-later
- *
- * This file is only ever included by main/main.c and should not normally be included anywhere else.
- * Anything that wants to include this should be providing the "control" program functionality in some manner.
- */
-#ifndef _control_main_main_h
-#define _control_main_main_h
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * Standard program entry point.
- *
- * @param argc
- * The number of arguments.
- * @param argv
- * The array of arguments.
- * @param envp
- * The array of all environment variables on program start.
- *
- * @return
- * 0 on success.
- * 1 on error.
- */
-extern int main(const int argc, const f_string_t *argv, const f_string_t *envp);
-
-#ifdef __cplusplus
-} // extern "C"
-#endif
-
-#endif // _control_main_main_h
#endif
#ifndef _di_control_packet_build_
- void control_packet_build(control_main_t * const main) {
+ void control_packet_build(control_t * const main) {
if (!main) return;
#endif // _di_control_packet_header_length_
#ifndef _di_control_packet_receive_
- void control_packet_receive(control_main_t * const main, control_payload_header_t * const header) {
+ void control_packet_receive(control_t * const main, control_payload_header_t * const header) {
if (!main || !header) return;
#endif // _di_control_packet_receive_
#ifndef _di_control_packet_process_
- void control_packet_process(control_main_t * const main, control_payload_header_t * const header) {
+ void control_packet_process(control_t * const main, control_payload_header_t * const header) {
if (!main || !header) return;
#endif // _di_control_packet_process_
#ifndef _di_control_packet_send_
- void control_packet_send(control_main_t * const main) {
+ void control_packet_send(control_t * const main) {
if (!main) return;
* @see f_string_dynamic_append()
*/
#ifndef _di_control_packet_build_
- extern void control_packet_build(control_main_t * const main);
+ extern void control_packet_build(control_t * const main);
#endif // _di_control_packet_build_
/**
* @see fll_fss_basic_list_read()
*/
#ifndef _di_control_packet_receive_
- extern void control_packet_receive(control_main_t * const main, control_payload_header_t * const header);
+ extern void control_packet_receive(control_t * const main, control_payload_header_t * const header);
#endif // _di_control_packet_receive_
/**
* The control payload packet header data.
*/
#ifndef _di_control_packet_process_
- extern void control_packet_process(control_main_t * const main, control_payload_header_t * const header);
+ extern void control_packet_process(control_t * const main, control_payload_header_t * const header);
#endif // _di_control_packet_process_
/**
* @see f_socket_write()
*/
#ifndef _di_control_packet_send_
- extern void control_packet_send(control_main_t * const main);
+ extern void control_packet_send(control_t * const main);
#endif // _di_control_packet_send_
#ifdef __cplusplus
if (!print || !print->custom) return F_status_set_error(F_output_not);
if (print->verbosity < f_console_verbosity_debug_e) return F_output_not;
- control_main_t * const main = (control_main_t *) print->custom;
+ control_t * const main = (control_t *) print->custom;
f_file_stream_lock(print->to);
if (!print || !print->custom) return F_status_set_error(F_output_not);
if (print->verbosity < f_console_verbosity_error_e) return F_output_not;
- fll_error_print(print, F_status_set_fine(((control_main_t *) print->custom)->setting.state.status), function, fll_error_file_flag_fallback_e);
+ fll_error_print(print, F_status_set_fine(((control_t *) print->custom)->setting.state.status), function, fll_error_file_flag_fallback_e);
return F_okay;
}
if (!print || !print->custom) return F_status_set_error(F_output_not);
if (print->verbosity < f_console_verbosity_error_e) return F_output_not;
- control_main_t * const main = (control_main_t *) print->custom;
-
- fll_error_file_print(print, F_status_set_fine(main->setting.state.status), function, fll_error_file_flag_fallback_e, name, operation, type);
+ fll_error_file_print(print, F_status_set_fine(((control_t *) print->custom)->setting.state.status), function, fll_error_file_flag_fallback_e, name, operation, type);
return F_okay;
}
if (!print || !print->custom) return F_status_set_error(F_output_not);
if (print->verbosity < f_console_verbosity_error_e) return F_output_not;
- control_main_t * const main = (control_main_t *) print->custom;
+ control_t * const main = (control_t *) print->custom;
f_file_stream_lock(print->to);
if (!print || !print->custom) return F_status_set_error(F_output_not);
if (print->verbosity < f_console_verbosity_error_e) return F_output_not;
- control_main_t * const main = (control_main_t *) print->custom;
+ control_t * const main = (control_t *) print->custom;
f_file_stream_lock(print->to);
}
#endif // _di_control_print_error_packet_response_failure_
-#ifndef _di_control_print_error_parameter_actions_none_
- f_status_t control_print_error_parameter_actions_none(fl_print_t * const print) {
+#ifndef _di_control_print_error_parameter_action_message_first_
+ f_status_t control_print_error_parameter_action_message_first(fl_print_t * const print, const f_string_static_t action) {
if (!print) return F_status_set_error(F_output_not);
if (print->verbosity < f_console_verbosity_error_e) return F_output_not;
- fll_print_format("%[%QNo actions provided.%]%r", print->to, print->set->error, print->prefix, print->set->error, f_string_eol_s);
+ fl_print_format("%[%QThe action parameter '%]", print->to, print->set->error, print->prefix, print->set->error);
+ fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, action, print->set->notable);
return F_okay;
}
-#endif // _di_control_print_error_parameter_actions_none_
+#endif // _di_control_print_error_parameter_action_message_first_
#ifndef _di_control_print_error_parameter_action_not_
f_status_t control_print_error_parameter_action_not(fl_print_t * const print, const f_string_static_t action) {
f_file_stream_lock(print->to);
- fl_print_format("%[%QThe action parameter '%]", print->to, print->set->error, print->prefix, print->set->error);
- fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, action, print->set->notable);
+ control_print_error_parameter_action_message_first(print, action);
+
fl_print_format("%[' a rule base name cannot be an empty string.%]%r", print->to, print->set->error, print->set->error, f_string_eol_s);
f_file_stream_unlock(print->to);
f_file_stream_lock(print->to);
- fl_print_format("%[%QThe action parameter '%]", print->to, print->set->error, print->prefix, print->set->error);
- fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, action, print->set->notable);
+ control_print_error_parameter_action_message_first(print, action);
+
fl_print_format("%[' a rule directory path cannot be an empty string.%]%r", print->to, print->set->error, print->set->error, f_string_eol_s);
f_file_stream_unlock(print->to);
f_file_stream_lock(print->to);
- fl_print_format("%[%QThe action parameter '%]", print->to, print->set->error, print->prefix, print->set->error);
- fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, action, print->set->notable);
+ control_print_error_parameter_action_message_first(print, action);
+
fl_print_format("%[' a rule name cannot be an empty string.%]%r", print->to, print->set->error, print->set->error, f_string_eol_s);
f_file_stream_unlock(print->to);
f_file_stream_lock(print->to);
- fl_print_format("%[%QThe action parameter '%]", print->to, print->set->error, print->prefix, print->set->error);
- fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, action, print->set->notable);
+ control_print_error_parameter_action_message_first(print, action);
+
fl_print_format("%[' requires either a full rule name or a rule directory path along with the rule base name.%]%r", print->to, print->set->error, print->set->error, f_string_eol_s);
f_file_stream_unlock(print->to);
f_file_stream_lock(print->to);
- fl_print_format("%[%QThe action parameter '%]", print->to, print->set->error, print->prefix, print->set->error);
- fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, action, print->set->notable);
+ control_print_error_parameter_action_message_first(print, action);
+
fl_print_format("%[' has too few arguments.%]%r", print->to, print->set->error, print->set->error, f_string_eol_s);
f_file_stream_unlock(print->to);
f_file_stream_lock(print->to);
- fl_print_format("%[%QThe action parameter '%]", print->to, print->set->error, print->prefix, print->set->error);
- fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, action, print->set->notable);
+ control_print_error_parameter_action_message_first(print, action);
+
fl_print_format("%[' when used with '%]", print->to, print->set->error, print->set->error, f_string_eol_s);
fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, with, print->set->notable);
fl_print_format("%[' has too few arguments.%]%r", print->to, print->set->error, print->set->error, f_string_eol_s);
f_file_stream_lock(print->to);
- fl_print_format("%[%QThe action parameter '%]", print->to, print->set->error, print->prefix, print->set->error);
- fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, action, print->set->notable);
+ control_print_error_parameter_action_message_first(print, action);
+
fl_print_format("%[' has too many arguments.%]%r", print->to, print->set->error, print->set->error, f_string_eol_s);
f_file_stream_unlock(print->to);
f_file_stream_lock(print->to);
- fl_print_format("%[%QThe action parameter '%]", print->to, print->set->error, print->prefix, print->set->error);
- fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, action, print->set->notable);
+ control_print_error_parameter_action_message_first(print, action);
+
fl_print_format("%[' when used with '%]", print->to, print->set->error, print->set->error, f_string_eol_s);
fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, with, print->set->notable);
fl_print_format("%[' has too many arguments.%]%r", print->to, print->set->error, print->set->error, f_string_eol_s);
f_file_stream_lock(print->to);
- fl_print_format("%[%QThe action parameter '%]", print->to, print->set->error, print->prefix, print->set->error);
- fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, action, print->set->notable);
+ control_print_error_parameter_action_message_first(print, action);
+
fl_print_format("%[' does not know the argument '%]", print->to, print->set->error, print->set->error, f_string_eol_s);
fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, with, print->set->notable);
fl_print_format(f_string_format_sentence_end_quote_s.string, print->to, print->set->error, print->set->error, f_string_eol_s);
}
#endif // _di_control_print_error_parameter_action_rule_with_unknown_
+#ifndef _di_control_print_error_parameter_actions_none_
+ f_status_t control_print_error_parameter_actions_none(fl_print_t * const print) {
+
+ if (!print) return F_status_set_error(F_output_not);
+ if (print->verbosity < f_console_verbosity_error_e) return F_output_not;
+
+ fll_print_format("%[%QNo actions provided.%]%r", print->to, print->set->error, print->prefix, print->set->error, f_string_eol_s);
+
+ return F_okay;
+ }
+#endif // _di_control_print_error_parameter_actions_none_
+
#ifndef _di_control_print_error_parameter_value_empty_
f_status_t control_print_error_parameter_value_empty(fl_print_t * const print, const f_string_static_t parameter) {
#ifndef _di_control_print_error_packet_response_failure_
extern f_status_t control_print_error_packet_response_failure(fl_print_t * const print, const control_payload_header_t header, const f_string_static_t string_status);
#endif // _di_control_print_error_packet_response_failure_
+
+
/**
- * Print an error message about no actions being provided.
+ * Helper print function for printing the first part of an action message.
+ *
+ * This does not perform any locking.
*
* @param print
* The output structure to print to.
*
* F_output_not (with error bit) if setting is NULL.
*/
-#ifndef _di_control_print_error_parameter_actions_none_
- extern f_status_t control_print_error_parameter_actions_none(fl_print_t * const print);
-#endif // _di_control_print_error_parameter_actions_none_
+#ifndef _di_control_print_error_parameter_action_message_first_
+ extern f_status_t control_print_error_parameter_action_message_first(fl_print_t * const print, const f_string_static_t action);
+#endif // _di_control_print_error_parameter_action_message_first_
/**
* Print an error message about the given parameter not matching the known set of controller actions.
#endif // _di_control_print_error_parameter_action_rule_with_unknown_
/**
+ * Print an error message about no actions being provided.
+ *
+ * @param print
+ * The output structure to print to.
+ *
+ * This does not alter print.custom.setting.state.status.
+ *
+ * @return
+ * F_okay on success.
+ * F_output_not on success, but no printing is performed.
+ *
+ * F_output_not (with error bit) if setting is NULL.
+ */
+#ifndef _di_control_print_error_parameter_actions_none_
+ extern f_status_t control_print_error_parameter_actions_none(fl_print_t * const print);
+#endif // _di_control_print_error_parameter_actions_none_
+
+/**
* Print an error message about the parameter's associated value being an empty string.
*
* @param print
if (!print || !print->custom) return F_status_set_error(F_output_not);
if (print->verbosity < f_console_verbosity_normal_e) return F_output_not;
- control_main_t * const main = (control_main_t *) print->custom;
+ control_t * const main = (control_t *) print->custom;
f_file_stream_lock(print->to);
fl_print_format("The action '", print->to);
fl_print_format(f_string_format_Q_single_s.string, print->to, print->set->notable, control_action_type_name(header.action), print->set->notable);
-
- if (header.status == F_done) {
- fl_print_format("' is performed", print->to);
- }
- else {
- fl_print_format("' is successfully performed", print->to);
- }
+ fl_print_format(header.status == F_done ? "' is performed" : "' is successfully performed", print->to);
if (header.length) {
fl_print_format(": %/Q%r", print->to, main->cache.large, main->cache.packet_contents.array[main->cache.packet_contents.used - 1].array[0], f_string_eol_s);
* F_output_not on success, but no printing is performed.
*
* F_output_not (with error bit) if setting is NULL.
- *
- * @see f_file_stream_flush()
- * @see f_file_stream_lock()
- * @see f_file_stream_unlock()
- * @see f_print_dynamic_raw()
- * @see fl_print_format()
- *
- * @see fll_program_print_help_header()
- * @see fll_program_print_help_option()
- * @see fll_program_print_help_option_standard()
- * @see fll_program_print_help_usage()
*/
#ifndef _di_control_print_message_help_
extern f_status_t control_print_message_help(fl_print_t * const print);
extern "C" {
#endif
+#ifndef _di_control_process_
+ void control_process(control_t * const main) {
+
+ if (!main || F_status_is_error(main->setting.state.status)) return;
+
+ main->setting.state.status = F_okay;
+
+ if (main->setting.flag & control_main_flag_version_copyright_help_e) {
+ if (main->setting.flag & control_main_flag_help_e) {
+ control_print_message_help(&main->program.message);
+ }
+ else if (main->setting.flag & control_main_flag_version_e) {
+ fll_program_print_version(&main->program.message, control_program_version_s);
+ }
+ else if (main->setting.flag & control_main_flag_copyright_e) {
+ fll_program_print_copyright(&main->program.message, fll_program_copyright_year_author_s);
+ }
+
+ return;
+ }
+
+ if (main->setting.flag & control_main_flag_pipe_e) {
+ control_print_error_pipe_supported_not(&main->program.error);
+
+ main->setting.state.status = F_status_set_error(F_support_not);
+ }
+ else if (main->setting.actions.used) {
+ main->setting.action = control_action_type_identify(main->setting.actions.array[0]);
+
+ if (main->setting.action) {
+ control_action_verify(main);
+ }
+ else {
+ control_print_error_parameter_action_not(&main->program.error, main->setting.actions.array[0]);
+
+ main->setting.state.status = F_status_set_error(F_parameter);
+ }
+
+ if (F_status_is_error_not(main->setting.state.status)) {
+ control_packet_build(main);
+
+ if (F_status_is_error(main->setting.state.status)) {
+ if (F_status_set_fine(main->setting.state.status) == F_too_large) {
+ control_print_error_request_packet_too_large(&main->program.error);
+ }
+ else {
+ control_print_error(&main->program.error, macro_control_f(control_packet_build));
+ }
+ }
+
+ if (F_status_is_error_not(main->setting.state.status)) {
+ control_packet_send(main);
+
+ if (F_status_is_error(main->setting.state.status)) {
+ control_print_error(&main->program.error, macro_control_f(control_packet_send));
+ }
+ }
+
+ if (F_status_is_error_not(main->setting.state.status)) {
+ control_payload_header_t header = control_payload_header_t_initialize;
+
+ control_packet_receive(main, &header);
+
+ if (F_status_is_error(main->setting.state.status)) {
+ if (F_status_set_fine(main->setting.state.status) == F_too_large) {
+ control_print_error_response_packet_valid_not(&main->program.error);
+ }
+ else {
+ control_print_error(&main->program.error, macro_control_f(control_packet_receive));
+ }
+ }
+ else {
+ control_packet_process(main, &header);
+
+ // Print the error message only if the error message is not already printed.
+ if (F_status_is_error(main->setting.state.status)) {
+ if (header.type != control_payload_type_error_e && (header.type != control_payload_type_controller_e || F_status_set_fine(main->setting.state.status) != header.status || (header.status != F_failure && header.status != F_busy))) {
+ control_print_error(&main->program.error, macro_control_f(control_packet_process));
+ }
+ }
+ }
+ }
+ }
+
+ if (main->setting.socket.id != -1) {
+ f_socket_disconnect(&main->setting.socket, f_socket_close_fast_e);
+ }
+ }
+ else {
+ control_print_error_parameter_actions_none(&main->program.error);
+
+ main->setting.state.status = F_status_set_error(F_data_not);
+ }
+
+ if (F_status_is_error(main->setting.state.status)) return;
+
+ main->setting.state.status = F_okay;
+ }
+#endif // _di_control_process_
+
#ifdef __cplusplus
} // extern "C"
#endif
*
* This is auto-included and should not need to be explicitly included.
*/
-#ifndef _control_main_process_h
-#define _control_main_process_h
+#ifndef _control_process_h
+#define _control_process_h
#ifdef __cplusplus
extern "C" {
#endif
+/**
+ * Execute main program.
+ *
+ * If main.signal is non-zero, then this blocks and handles the following signals:
+ * - F_signal_abort
+ * - F_signal_broken_pipe
+ * - F_signal_hangup
+ * - F_signal_interrupt
+ * - F_signal_quit
+ * - F_signal_termination
+ *
+ * @param main
+ * The main program data and settings.
+ *
+ * This alters main.setting.state.status:
+ * F_okay on success.
+ * F_true on success when performing verification and verify passed.
+ * F_false on success when performing verification and verify failed.
+ *
+ * F_interrupt (with error bit) on (exit) signal received.
+ * F_parameter (with error bit) if main is NULL or setting is NULL.
+ */
+#ifndef _di_control_process_
+ extern void control_process(control_t * const main);
+#endif // _di_control_process_
+
#ifdef __cplusplus
} // extern "C"
#endif
-#endif // _control_main_process_h
+#endif // _control_process_h
#endif
#if !defined(_di_control_signal_check_) && defined(_di_thread_support_)
- f_status_t control_signal_check(control_main_t * const main) {
+ f_status_t control_signal_check(control_t * const main) {
if (!main || main->program.signal.id == -1) return F_false;
#endif // !defined(_di_control_signal_check_) && defined(_di_thread_support_)
#if !defined(_di_control_signal_check_) && !defined(_di_thread_support_)
- f_status_t control_signal_check(control_main_t * const main) {
+ f_status_t control_signal_check(control_t * const main) {
if (!main || main->program.signal.id == -1) return F_false;
#endif // !defined(_di_control_signal_check_) && !defined(_di_thread_support_)
#if !defined(_di_control_signal_handler_) && !defined(_di_thread_support_)
- void control_signal_handler(control_main_t * const main) {
+ void control_signal_handler(control_t * const main) {
if (!main) return;
* @see fll_program_standard_signal_received()
*/
#ifndef _di_control_signal_check_
- extern f_status_t control_signal_check(control_main_t * const main);
+ extern f_status_t control_signal_check(control_t * const main);
#endif // _di_control_signal_check_
/**
* @see f_signal_wait()
*/
#if !defined(_di_control_signal_handler_) && !defined(_di_thread_support_)
- extern void control_signal_handler(control_main_t * const main);
+ extern void control_signal_handler(control_t * const main);
#endif // !defined(_di_control_signal_handler_) && !defined(_di_thread_support_)
#ifdef __cplusplus
f_thread_cancel_state_set(PTHREAD_CANCEL_DEFERRED, 0);
if (main) {
- control_signal_handler((control_main_t *) main);
+ control_signal_handler((control_t *) main);
}
return 0;
*
* This is auto-included and should not need to be explicitly included.
*/
-#ifndef _control_main_thread_h
-#define _control_main_thread_h
+#ifndef _control_thread_h
+#define _control_thread_h
/**
* Thread handler for signals/interrupts.
* @param main
* The program and settings data.
*
- * Must be of type control_main_t.
+ * Must be of type control_t.
*
* @return
* 0, always.
} // extern "C"
#endif
-#endif // _control_main_thread_h
+#endif // _control_thread_h
projects / control / commitdiff