├── .gitignore ├── .gitattributes ├── .editorconfig ├── post-example-build.cmake ├── tests ├── test.h ├── test_options_single_retry.c ├── test_options_multiple_retries.c ├── test_options_with_delay.c ├── test_options_with_context.c ├── test.c ├── test_callback_multiple_retries.c └── test_callback_with_context.c ├── include └── forever.h ├── .github ├── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md ├── CONTRIBUTING.md └── workflows │ ├── ci.yml │ └── codeql-analysis.yml ├── CHANGELOG.md ├── examples └── example.c ├── CMakeLists.txt ├── README.md ├── src └── forever.c ├── uncrustify.cfg └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | temp/ 3 | **/*.log 4 | /core 5 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text eol=lf 2 | *.ico binary 3 | *.woff binary 4 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | end_of_line = lf 7 | insert_final_newline = true 8 | trim_trailing_whitespace = true 9 | indent_style = space 10 | indent_size = 2 11 | 12 | -------------------------------------------------------------------------------- /post-example-build.cmake: -------------------------------------------------------------------------------- 1 | 2 | include("./cmake-modules/src/utils.cmake") 3 | 4 | utils_embed_example_source_in_readme( 5 | EXAMPLE_FILE "../examples/example.c" 6 | DOCUMENT_FILE "../README.md" 7 | SOURCE_TYPE "c" 8 | ) 9 | 10 | -------------------------------------------------------------------------------- /tests/test.h: -------------------------------------------------------------------------------- 1 | #ifndef __TEST_H__ 2 | #define __TEST_H__ 3 | 4 | #include 5 | #include 6 | #include 7 | 8 | void test_run(void (*fn)()); 9 | void test_fail(); 10 | void assert_true(bool); 11 | 12 | void assert_num_equal(size_t, size_t); 13 | 14 | #endif 15 | 16 | -------------------------------------------------------------------------------- /include/forever.h: -------------------------------------------------------------------------------- 1 | #ifndef FOREVER_H 2 | #define FOREVER_H 3 | 4 | unsigned int forever(void (*fn)(void *), void *); 5 | unsigned int forever_with_options(void (*fn)(void *), void *, const unsigned int /* max retries */, const unsigned int /* interval between invocations in milliseconds */); 6 | unsigned int forever_with_callback(void (*fn)(void *), void *, int (*callback)(void *, const unsigned char, int)); 7 | 8 | #endif 9 | 10 | -------------------------------------------------------------------------------- /tests/test_options_single_retry.c: -------------------------------------------------------------------------------- 1 | #include "forever.h" 2 | #include "test.h" 3 | #include 4 | 5 | 6 | void fn(void *context) 7 | { 8 | assert_true(context == NULL); 9 | exit(0); 10 | } 11 | 12 | 13 | void test_impl() 14 | { 15 | unsigned int counter = forever_with_options(fn, NULL, 1, 0); 16 | 17 | assert_num_equal(counter, 1); 18 | } 19 | 20 | 21 | int main() 22 | { 23 | test_run(test_impl); 24 | } 25 | 26 | -------------------------------------------------------------------------------- /tests/test_options_multiple_retries.c: -------------------------------------------------------------------------------- 1 | #include "forever.h" 2 | #include "test.h" 3 | #include 4 | 5 | 6 | void fn(void *context) 7 | { 8 | assert_true(context == NULL); 9 | exit(0); 10 | } 11 | 12 | 13 | void test_impl() 14 | { 15 | unsigned int counter = forever_with_options(fn, NULL, 10, 1); 16 | 17 | assert_num_equal(counter, 10); 18 | } 19 | 20 | 21 | int main() 22 | { 23 | test_run(test_impl); 24 | } 25 | 26 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: sagiegurari 7 | 8 | --- 9 | 10 | ### Feature Description 11 | 12 | 13 | ### Describe The Solution You'd Like 14 | 15 | 16 | ### Code Sample 17 | 18 | ```c 19 | // paste code here 20 | ``` 21 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: sagiegurari 7 | 8 | --- 9 | 10 | ### Describe The Bug 11 | 12 | 13 | ### To Reproduce 14 | 15 | 16 | ### Error Stack 17 | 18 | ```console 19 | The error stack trace 20 | ``` 21 | 22 | ### Code Sample 23 | 24 | ```c 25 | // paste code here 26 | ``` 27 | -------------------------------------------------------------------------------- /tests/test_options_with_delay.c: -------------------------------------------------------------------------------- 1 | #include "forever.h" 2 | #include "test.h" 3 | #include 4 | #include 5 | #include 6 | 7 | 8 | void fn(void *context) 9 | { 10 | assert_true(context == NULL); 11 | sleep(1); 12 | exit(0); 13 | } 14 | 15 | 16 | void test_impl() 17 | { 18 | clock_t time = clock(); 19 | unsigned int counter = forever_with_options(fn, NULL, 2, 1000); 20 | 21 | assert_num_equal(counter, 2); 22 | assert_true(clock() - time >= 4); 23 | } 24 | 25 | 26 | int main() 27 | { 28 | test_run(test_impl); 29 | } 30 | 31 | -------------------------------------------------------------------------------- /tests/test_options_with_context.c: -------------------------------------------------------------------------------- 1 | #include "forever.h" 2 | #include "test.h" 3 | #include 4 | 5 | struct Context 6 | { 7 | int counter; 8 | }; 9 | 10 | 11 | void fn(void *context) 12 | { 13 | ((struct Context *)context)->counter++; 14 | exit(0); 15 | } 16 | 17 | 18 | void test_impl() 19 | { 20 | struct Context *context = malloc(sizeof(struct Context)); 21 | 22 | context->counter = 0; 23 | 24 | unsigned int counter = forever_with_options(fn, context, 10, 1); 25 | 26 | assert_num_equal(counter, 10); 27 | assert_num_equal(context->counter, 0); 28 | 29 | free(context); 30 | } 31 | 32 | 33 | int main() 34 | { 35 | test_run(test_impl); 36 | } 37 | 38 | -------------------------------------------------------------------------------- /tests/test.c: -------------------------------------------------------------------------------- 1 | #include "test.h" 2 | #include 3 | #include 4 | #include 5 | 6 | 7 | void test_run(void (*fn)(void)) 8 | { 9 | printf("Test ... "); 10 | fn(); 11 | printf("Done\n"); 12 | } 13 | 14 | 15 | void test_fail() 16 | { 17 | printf(" Error\n"); 18 | exit(1); 19 | } 20 | 21 | 22 | void assert_true(bool value) 23 | { 24 | if (!value) 25 | { 26 | test_fail(); 27 | } 28 | } 29 | 30 | 31 | void assert_num_equal(size_t value1, size_t value2) 32 | { 33 | if (value1 != value2) 34 | { 35 | #ifdef linux 36 | printf("Assert Failed, value: %zu not equals to value: %zu", value1, value2); 37 | #endif 38 | test_fail(); 39 | } 40 | } 41 | 42 | -------------------------------------------------------------------------------- /tests/test_callback_multiple_retries.c: -------------------------------------------------------------------------------- 1 | #include "forever.h" 2 | #include "test.h" 3 | #include 4 | #include 5 | 6 | unsigned short global_counter = 0; 7 | 8 | 9 | int callback(void *context, const unsigned char started, int stat_loc) 10 | { 11 | assert_true(context == NULL); 12 | assert_true(started); 13 | assert_num_equal(stat_loc, 0); 14 | 15 | global_counter++; 16 | 17 | if (global_counter < 4) 18 | { 19 | return(500); 20 | } 21 | 22 | return(-1); 23 | } 24 | 25 | 26 | void fn() 27 | { 28 | exit(0); 29 | } 30 | 31 | 32 | void test_impl() 33 | { 34 | clock_t time = clock(); 35 | unsigned int counter = forever_with_callback(fn, NULL, callback); 36 | 37 | assert_num_equal(counter, 4); 38 | assert_true(clock() - time >= 2); 39 | } 40 | 41 | 42 | int main() 43 | { 44 | test_run(test_impl); 45 | } 46 | 47 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## CHANGELOG 2 | 3 | ### v0.2.1 4 | 5 | * Test memory leaks in CI 6 | * Added static to internal functions 7 | * Adding lint checks as part of build 8 | * Added cargo-make makefile for simpler sharing of optional development build instructions. 9 | * Updated header include guard macro name 10 | 11 | ### v0.2.0 (2020-11-20) 12 | 13 | * Invoked function and callback function can now accept a context pointer (breaking change). 14 | 15 | ### v0.1.3 (2020-11-07) 16 | 17 | * Internal functions are now namespaced with _forever prefix. 18 | * Added example file 19 | * Improved build setup (no need to list test names). 20 | * Update cmake build to use shared cmake utilities. 21 | 22 | ### v0.1.2 (2020-06-14) 23 | 24 | * Ensure child process does not continue loop. 25 | 26 | ### v0.1.1 (2020-05-31) 27 | 28 | * Bug fixes 29 | 30 | ### v0.1.0 (2020-04-25) 31 | 32 | * Initial Release 33 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | ## Issues 4 | 5 | Found a bug? Got a question? Want some enhancement?
6 | First place to go is the repository issues section, and I'll try to help as much as possible. 7 | 8 | ## Pull Requests 9 | 10 | Fixed a bug or just want to provided additional functionality?
11 | Simply fork this repository, implement your changes and create a pull request.
12 | Few guidelines regarding pull requests: 13 | 14 | * This repository is integrated with github actions for continuous integration.
15 | 16 | Your pull request build must pass (the build will run automatically).
17 | You can run the following command locally to ensure the build will pass: 18 | 19 | ```sh 20 | mkdir ./target 21 | cd ./target 22 | cmake .. 23 | make 24 | ctest -C Release --output-on-failure 25 | ``` 26 | 27 | * There are many automatic unit tests as part of the library which provide full coverage of the functionality.
Any fix/enhancement must come with a set of tests to ensure it's working well. 28 | -------------------------------------------------------------------------------- /tests/test_callback_with_context.c: -------------------------------------------------------------------------------- 1 | #include "forever.h" 2 | #include "test.h" 3 | #include 4 | #include 5 | 6 | struct Context 7 | { 8 | int counter; 9 | }; 10 | 11 | 12 | int callback(void *context, const unsigned char started, int stat_loc) 13 | { 14 | ((struct Context *)context)->counter++; 15 | assert_true(started); 16 | assert_num_equal(stat_loc, 0); 17 | 18 | if (((struct Context *)context)->counter < 4) 19 | { 20 | return(500); 21 | } 22 | 23 | return(-1); 24 | } 25 | 26 | 27 | void fn(void *context) 28 | { 29 | assert_true(context != NULL); 30 | exit(0); 31 | } 32 | 33 | 34 | void test_impl() 35 | { 36 | struct Context *context = malloc(sizeof(struct Context)); 37 | 38 | context->counter = 0; 39 | 40 | clock_t time = clock(); 41 | unsigned int counter = forever_with_callback(fn, context, callback); 42 | free(context); 43 | 44 | assert_num_equal(counter, 4); 45 | assert_true(clock() - time >= 2); 46 | } 47 | 48 | 49 | int main() 50 | { 51 | test_run(test_impl); 52 | } 53 | 54 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: [push, pull_request] 3 | env: 4 | BUILD_TYPE: Release 5 | jobs: 6 | ci: 7 | name: CI 8 | runs-on: ${{ matrix.os }} 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | os: [ubuntu-latest, macOS-latest] 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v2 16 | - name: Setup Env 17 | run: cmake -E make_directory target 18 | - name: Configure 19 | shell: bash 20 | working-directory: target 21 | run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE 22 | - name: Build 23 | shell: bash 24 | working-directory: target 25 | run: cmake --build . --config $BUILD_TYPE 26 | - name: Test 27 | shell: bash 28 | working-directory: target 29 | run: ctest -C $BUILD_TYPE --output-on-failure 30 | - name: Memory Leak Test 31 | if: matrix.os == 'ubuntu-latest' 32 | shell: bash 33 | working-directory: target 34 | run: | 35 | sudo apt update 36 | sudo apt install -y valgrind --fix-missing 37 | for testfile in ./bin/test_*; do echo "Testing ${testfile}" && valgrind --leak-check=full --show-leak-kinds=definite,indirect,possible --error-exitcode=1 "${testfile}"; done 38 | 39 | -------------------------------------------------------------------------------- /examples/example.c: -------------------------------------------------------------------------------- 1 | #include "forever.h" 2 | #include 3 | #include 4 | #include 5 | 6 | 7 | void my_program(void *context) 8 | { 9 | if (context != NULL) 10 | { 11 | // do something with the context 12 | } 13 | 14 | sleep(1); 15 | exit(0); 16 | } 17 | 18 | 19 | int callback(void *context, const unsigned char started, int stat_loc) 20 | { 21 | if (context != NULL) 22 | { 23 | // do something with the context 24 | } 25 | 26 | if (stat_loc == 0 || !started) 27 | { 28 | return(-1); // no more retries 29 | } 30 | 31 | return(500); // wait 500 millies before next invocation, 0 for no wait. 32 | } 33 | 34 | 35 | int main() 36 | { 37 | void *context = NULL; 38 | 39 | // call 'my_program' and when it ends/crashes invoke it again, up 40 | // to 10 times and wait 250 millies between invocations. 41 | // counter will hold the amount of times 'my_program' was invoked. 42 | unsigned int counter = forever_with_options( 43 | my_program, // function to invoke 44 | context, // context that is passed to the function on every invocation 45 | 10, // max amount of retries. 0 for unlimited retries. 46 | 250 // amount of millies to wait between invocations. 0 for no wait. 47 | ); 48 | 49 | printf("Invoked %u time/s.\n", counter); 50 | 51 | // call 'my_program' and when it ends/crashes call the provided callback 52 | counter = forever_with_callback(my_program, context, callback); 53 | printf("Invoked %u time/s.\n", counter); 54 | 55 | // run with unlimited retries and no delay between invocations 56 | forever(my_program, context); 57 | } 58 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | name: "CodeQL" 2 | 3 | on: 4 | push: 5 | pull_request: 6 | schedule: 7 | - cron: '0 23 * * 5' 8 | 9 | jobs: 10 | analyse: 11 | name: Analyse 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - name: Checkout repository 16 | uses: actions/checkout@v2 17 | with: 18 | # We must fetch at least the immediate parents so that if this is 19 | # a pull request then we can checkout the head. 20 | fetch-depth: 2 21 | 22 | # If this run was triggered by a pull request event, then checkout 23 | # the head of the pull request instead of the merge commit. 24 | - run: git checkout HEAD^2 25 | if: ${{ github.event_name == 'pull_request' }} 26 | 27 | # Initializes the CodeQL tools for scanning. 28 | - name: Initialize CodeQL 29 | uses: github/codeql-action/init@v1 30 | with: 31 | languages: cpp 32 | # Override language selection by uncommenting this and choosing your languages 33 | # with: 34 | # languages: go, javascript, csharp, python, cpp, java 35 | 36 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). 37 | # If this step fails, then you should remove it and run the build manually (see below) 38 | - name: Autobuild 39 | uses: github/codeql-action/autobuild@v1 40 | 41 | # ℹ️ Command-line programs to run using the OS shell. 42 | # 📚 https://git.io/JvXDl 43 | 44 | # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines 45 | # and modify them (or add more) to build your code if your project 46 | # uses a compiled language 47 | 48 | #- run: | 49 | # make bootstrap 50 | # make release 51 | 52 | - name: Perform CodeQL Analysis 53 | uses: github/codeql-action/analyze@v1 54 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | 2 | cmake_minimum_required(VERSION 3.7) 3 | 4 | project(forever C) 5 | 6 | # include shared utilities 7 | if(NOT EXISTS "target/cmake-modules/src/utils.cmake") 8 | execute_process(COMMAND git clone https://github.com/sagiegurari/cmake-modules.git) 9 | endif() 10 | include("target/cmake-modules/src/utils.cmake") 11 | 12 | set(CMAKE_EXPORT_COMPILE_COMMANDS ON) 13 | 14 | set(CMAKE_BUILD_TYPE Release) 15 | if(NOT WIN32) 16 | set(X_CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror -Wall -Wextra -Wcast-align -Wunused -Wshadow -Wpedantic") 17 | endif() 18 | 19 | set(X_CMAKE_PROJECT_ROOT_DIR ${CMAKE_BINARY_DIR}/..) 20 | 21 | set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) 22 | set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) 23 | set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) 24 | 25 | include_directories(include) 26 | 27 | # define all sources 28 | file(GLOB SOURCES "src/*.c") 29 | file(GLOB HEADER_SOURCES "include/*.h") 30 | file(GLOB TEST_SOURCES "tests/*") 31 | file(GLOB COMMON_TEST_SOURCES "tests/test.*") 32 | file(GLOB EXAMPLE_SOURCES "examples/*.c") 33 | 34 | # lint code 35 | utils_cppcheck(INCLUDE_DIRECTORY "./include/" SOURCES "./src/*.c" WORKING_DIRECTORY "${X_CMAKE_PROJECT_ROOT_DIR}") 36 | 37 | # format code 38 | utils_uncrustify( 39 | CONFIG_FILE "${X_CMAKE_PROJECT_ROOT_DIR}/uncrustify.cfg" 40 | SOURCES ${SOURCES} ${HEADER_SOURCES} ${TEST_SOURCES} ${EXAMPLE_SOURCES} 41 | ) 42 | 43 | # create static library 44 | add_library(${CMAKE_PROJECT_NAME} STATIC ${SOURCES}) 45 | if(NOT WIN32) 46 | set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES COMPILE_FLAGS "${X_CMAKE_C_FLAGS} -Wconversion") 47 | endif() 48 | 49 | # example 50 | add_executable(example examples/example.c) 51 | target_link_libraries(example ${CMAKE_PROJECT_NAME}) 52 | set_target_properties(example PROPERTIES COMPILE_FLAGS "${X_CMAKE_C_FLAGS}") 53 | 54 | # tests 55 | include(CTest) 56 | 57 | utils_setup_test_lib( 58 | SOURCES "${COMMON_TEST_SOURCES}" 59 | COMPILATION_FLAGS "${X_CMAKE_C_FLAGS}" 60 | ) 61 | utils_setup_c_all_tests( 62 | COMPILATION_FLAGS "${X_CMAKE_C_FLAGS}" 63 | BINARY_DIRECTORY "${CMAKE_BINARY_DIR}/bin" 64 | LIBRARIES "Test" 65 | ) 66 | 67 | if("$ENV{X_CMAKE_DOC_STEPS}" STREQUAL "true") 68 | # post build steps 69 | add_custom_command( 70 | TARGET example 71 | POST_BUILD 72 | COMMENT "Post Build Steps" 73 | COMMAND ${CMAKE_COMMAND} -P "../post-example-build.cmake" 74 | ) 75 | endif() 76 | 77 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # forever 2 | 3 | [![CI](https://github.com/sagiegurari/c_forever/workflows/CI/badge.svg?branch=master)](https://github.com/sagiegurari/c_forever/actions) 4 | [![Release](https://img.shields.io/github/v/release/sagiegurari/c_forever)](https://github.com/sagiegurari/c_forever/releases) 5 | [![license](https://img.shields.io/github/license/sagiegurari/c_forever)](https://github.com/sagiegurari/c_forever/blob/master/LICENSE) 6 | 7 | > Ensure the program runs continuously. 8 | 9 | * [Overview](#overview) 10 | * [Usage](#usage) 11 | * [Contributing](.github/CONTRIBUTING.md) 12 | * [Release History](CHANGELOG.md) 13 | * [License](#license) 14 | 15 | 16 | ## Overview 17 | This library provides few utility functions which enable you to invoke a function and ensure it continues to execute.
18 | In case the function exists due to a crash or simply because it finished, the forever library will reinvoke it.
19 | The forever function provides control over the amount of retries and time to wait between intervals via parameters or via callback for a more 20 | fine grained control.
21 | The provided function is invoked as a forked process, so any crash is caught and when restarts, it will be started as a new process with a new state. 22 | 23 | 24 | ## Usage 25 | 26 | 27 | ```c 28 | #include "forever.h" 29 | #include 30 | #include 31 | #include 32 | 33 | 34 | void my_program(void *context) 35 | { 36 | if (context != NULL) 37 | { 38 | // do something with the context 39 | } 40 | 41 | sleep(1); 42 | exit(0); 43 | } 44 | 45 | 46 | int callback(void *context, const unsigned char started, int stat_loc) 47 | { 48 | if (context != NULL) 49 | { 50 | // do something with the context 51 | } 52 | 53 | if (stat_loc == 0 || !started) 54 | { 55 | return(-1); // no more retries 56 | } 57 | 58 | return(500); // wait 500 millies before next invocation, 0 for no wait. 59 | } 60 | 61 | 62 | int main() 63 | { 64 | void *context = NULL; 65 | 66 | // call 'my_program' and when it ends/crashes invoke it again, up 67 | // to 10 times and wait 250 millies between invocations. 68 | // counter will hold the amount of times 'my_program' was invoked. 69 | unsigned int counter = forever_with_options( 70 | my_program, // function to invoke 71 | context, // context that is passed to the function on every invocation 72 | 10, // max amount of retries. 0 for unlimited retries. 73 | 250 // amount of millies to wait between invocations. 0 for no wait. 74 | ); 75 | 76 | printf("Invoked %u time/s.\n", counter); 77 | 78 | // call 'my_program' and when it ends/crashes call the provided callback 79 | counter = forever_with_callback(my_program, context, callback); 80 | printf("Invoked %u time/s.\n", counter); 81 | 82 | // run with unlimited retries and no delay between invocations 83 | forever(my_program, context); 84 | } 85 | ``` 86 | 87 | 88 | ## Contributing 89 | See [contributing guide](.github/CONTRIBUTING.md) 90 | 91 | 92 | ## Release History 93 | 94 | See [Changelog](CHANGELOG.md) 95 | 96 | 97 | ## License 98 | Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license. 99 | -------------------------------------------------------------------------------- /src/forever.c: -------------------------------------------------------------------------------- 1 | #include "forever.h" 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | 8 | struct ForeverState 9 | { 10 | void *context; 11 | unsigned int max_retries; 12 | unsigned int interval_in_millies; 13 | int (*callback)(void *, const unsigned char, int); 14 | bool use_callback; 15 | unsigned int invocation_counter; 16 | bool stop; 17 | }; 18 | 19 | // private functions 20 | static unsigned int _forever(void (*fn)(void *), struct ForeverState); 21 | static void _forever_on_exit(struct ForeverState *, const bool, int); 22 | static void _forever_msleep(unsigned int); 23 | 24 | 25 | unsigned int forever(void (*fn)(void *), void *context) 26 | { 27 | return(forever_with_options(fn, context, 0, 0)); 28 | } 29 | 30 | 31 | unsigned int forever_with_options(void (*fn)(void *), void *context, const unsigned int max_retries, const unsigned int interval_in_millies) 32 | { 33 | struct ForeverState state = 34 | { 35 | context, 36 | max_retries, 37 | interval_in_millies, 38 | NULL, 39 | false, 40 | 0, 41 | false, 42 | }; 43 | 44 | return(_forever(fn, state)); 45 | } 46 | 47 | 48 | unsigned int forever_with_callback(void (*fn)(void *), void *context, int (*callback)(void *, const unsigned char, int)) 49 | { 50 | struct ForeverState state = 51 | { 52 | context, 53 | 0, 54 | 0, 55 | callback, 56 | true, 57 | 0, 58 | false, 59 | }; 60 | 61 | return(_forever(fn, state)); 62 | } 63 | 64 | 65 | static unsigned int _forever(void (*fn)(void *), struct ForeverState state) 66 | { 67 | state.invocation_counter = 0; 68 | state.stop = 0; 69 | 70 | while (!state.stop) 71 | { 72 | int pid = fork(); 73 | if (pid < 0) 74 | { 75 | // wait and try again later 76 | _forever_on_exit(&state, false, 0); 77 | } 78 | else 79 | { 80 | const bool is_parent = pid > 0; 81 | 82 | if (is_parent) 83 | { 84 | int stat_loc = 0; 85 | waitpid(pid, &stat_loc, 0); 86 | _forever_on_exit(&state, true, stat_loc); 87 | } 88 | else 89 | { 90 | (*fn)(state.context); 91 | return(0); 92 | } 93 | } 94 | } 95 | 96 | return(state.invocation_counter); 97 | } 98 | 99 | 100 | static void _forever_on_exit(struct ForeverState *state, const bool started, int stat_loc) 101 | { 102 | state->invocation_counter++; 103 | 104 | if (state->use_callback) 105 | { 106 | const unsigned char started_flag = started ? 1 : 0; 107 | const int interval_in_millies = state->callback(state->context, started_flag, stat_loc); 108 | if (interval_in_millies < 0) 109 | { 110 | state->stop = true; 111 | } 112 | else 113 | { 114 | state->interval_in_millies = (unsigned int)interval_in_millies; 115 | } 116 | } 117 | else if (state->max_retries > 0 && state->invocation_counter >= state->max_retries) 118 | { 119 | state->stop = true; 120 | } 121 | 122 | if (!state->stop && state->interval_in_millies > 0) 123 | { 124 | _forever_msleep(state->interval_in_millies); 125 | } 126 | } 127 | 128 | 129 | static void _forever_msleep(unsigned int millies) 130 | { 131 | long millies_long = (long)millies; 132 | 133 | struct timespec ts; 134 | 135 | ts.tv_sec = millies_long / 1000; 136 | ts.tv_nsec = (millies_long % 1000) * 1000000; 137 | 138 | nanosleep(&ts, &ts); 139 | } 140 | 141 | -------------------------------------------------------------------------------- /uncrustify.cfg: -------------------------------------------------------------------------------- 1 | output_tab_size = 2 2 | tok_split_gte = true 3 | indent_columns = 2 4 | indent_with_tabs = 0 5 | indent_class = true 6 | indent_member = 2 7 | indent_bool_paren = true 8 | indent_first_bool_expr = true 9 | sp_arith = force 10 | sp_assign = force 11 | sp_assign_default = force 12 | sp_bool = force 13 | sp_compare = force 14 | sp_inside_paren = remove 15 | sp_paren_paren = remove 16 | sp_before_ptr_star = force 17 | sp_between_ptr_star = remove 18 | sp_after_ptr_star = remove 19 | sp_before_byref = force 20 | sp_after_byref = remove 21 | sp_before_angle = remove 22 | sp_inside_angle = remove 23 | sp_after_angle = force 24 | sp_angle_paren = remove 25 | sp_angle_paren_empty = remove 26 | sp_angle_word = force 27 | sp_before_sparen = force 28 | sp_inside_sparen = remove 29 | sp_after_sparen = force 30 | sp_before_semi_for = remove 31 | sp_before_semi_for_empty = force 32 | sp_before_squares = remove 33 | sp_inside_square = remove 34 | sp_after_comma = force 35 | sp_before_ellipsis = remove 36 | sp_after_cast = remove 37 | sp_sizeof_paren = remove 38 | sp_inside_braces_enum = force 39 | sp_inside_braces_struct = force 40 | sp_inside_braces = force 41 | sp_func_proto_paren = remove 42 | sp_func_def_paren = remove 43 | sp_inside_fparen = remove 44 | sp_after_tparen_close = remove 45 | sp_func_call_paren = remove 46 | sp_return_paren = remove 47 | sp_attribute_paren = remove 48 | sp_defined_paren = force 49 | sp_brace_typedef = force 50 | sp_before_dc = remove 51 | sp_after_dc = remove 52 | sp_enum_assign = force 53 | align_func_params = true 54 | align_var_def_span = 2 55 | align_var_def_star_style = 1 56 | align_var_def_amp_style = 1 57 | align_var_def_colon = true 58 | align_var_def_inline = true 59 | align_assign_span = 1 60 | align_enum_equ_span = 4 61 | align_var_class_span = 2 62 | align_var_struct_span = 3 63 | align_struct_init_span = 3 64 | align_typedef_gap = 3 65 | align_typedef_span = 5 66 | align_typedef_star_style = 1 67 | align_right_cmt_span = 3 68 | align_nl_cont = true 69 | align_pp_define_gap = 4 70 | align_pp_define_span = 3 71 | align_asm_colon = true 72 | align_enum_equ_thresh = 8 73 | nl_assign_leave_one_liners = true 74 | nl_class_leave_one_liners = true 75 | nl_enum_leave_one_liners = true 76 | nl_getset_leave_one_liners = true 77 | nl_assign_brace = add 78 | nl_func_var_def_blk = 1 79 | nl_fcall_brace = add 80 | nl_enum_brace = force 81 | nl_struct_brace = add 82 | nl_union_brace = add 83 | nl_if_brace = add 84 | nl_brace_else = add 85 | nl_elseif_brace = add 86 | nl_else_brace = add 87 | nl_finally_brace = add 88 | nl_try_brace = add 89 | nl_for_brace = add 90 | nl_catch_brace = add 91 | nl_while_brace = add 92 | nl_do_brace = add 93 | nl_brace_while = remove 94 | nl_switch_brace = add 95 | nl_before_case = true 96 | nl_after_case = true 97 | nl_case_colon_brace = force 98 | nl_namespace_brace = force 99 | nl_constr_init_args = force 100 | nl_func_type_name = remove 101 | nl_func_paren = remove 102 | nl_func_def_paren = remove 103 | nl_func_decl_start = remove 104 | nl_func_def_start = remove 105 | nl_func_decl_start_single = remove 106 | nl_func_def_start_single = remove 107 | nl_func_decl_args = remove 108 | nl_func_decl_end = remove 109 | nl_func_def_end = remove 110 | nl_func_decl_end_single = remove 111 | nl_func_def_end_single = remove 112 | nl_fdef_brace = force 113 | nl_return_expr = remove 114 | nl_after_semicolon = true 115 | nl_after_brace_open = true 116 | nl_after_vbrace_open = true 117 | nl_after_brace_close = true 118 | nl_squeeze_ifdef = true 119 | nl_constr_colon = force 120 | pos_constr_comma = lead_force 121 | pos_constr_colon = lead_break 122 | pos_bool = lead 123 | pos_enum_comma = trail_force 124 | nl_max = 3 125 | nl_after_func_proto = 1 126 | nl_after_func_proto_group = 2 127 | nl_before_func_body_def = 3 128 | nl_after_access_spec = 1 129 | eat_blanks_after_open_brace = true 130 | eat_blanks_before_close_brace = true 131 | nl_after_return = true 132 | mod_full_brace_do = add 133 | mod_full_brace_for = add 134 | mod_full_brace_if = add 135 | mod_full_brace_while = add 136 | mod_paren_on_return = add 137 | mod_remove_extra_semicolon = true 138 | mod_add_long_function_closebrace_comment = 40 139 | mod_add_long_namespace_closebrace_comment = 5 140 | mod_add_long_switch_closebrace_comment = 40 141 | mod_remove_empty_return = true 142 | cmt_star_cont = true 143 | pp_indent = remove 144 | pp_space = remove 145 | mod_sort_include = true 146 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------