andrelcmoreira · andrelcmoreira · Nov 13, 2024 · Nov 13, 2024 · Nov 14, 2024 · Nov 14, 2024
diff --git a/.clangd b/.clangd
@@ -0,0 +1,2 @@
+CompileFlags:
+  CompilationDatabase: "build"
diff --git a/.github/workflows/pull_request.yaml → .github/workflows/ci.yaml b/.github/workflows/pull_request.yaml → .github/workflows/ci.yaml
@@ -1,13 +1,10 @@
-name: Pull request
+name: CI
 
 on:
   pull_request:
     push:
       branches:
         - develop
-  push:
-    branches:
-      - main
 
 env:
   COVERAGE_REPORT_DIR: build/coverage
@@ -18,6 +15,9 @@ jobs:
   build:
     name: Build library
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        cc: [gcc, clang]
     container:
       image: andrelcmoreira/pool-day:v2
       volumes:
@@ -29,7 +29,7 @@ jobs:
       - uses: actions/checkout@v2
       - name: Build library
         run: |
-          cmake -DCMAKE_BUILD_TYPE=Debug -S . -B build
+          cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_COMPILER=${{ matrix.cc }} -S . -B build
           cmake --build build
 
   build_samples:
@@ -71,6 +71,22 @@ jobs:
       - name: Run unit tests
         run: ${{ env.LD_PRELOAD }} build/test/pool-day-tests
 
+  static_analysis:
+    name: Run static analysis
+    runs-on: ubuntu-latest
+    container:
+      image: andrelcmoreira/pool-day:v2
+      volumes:
+        - ${{ github.workspace }}:/pool-day
+      credentials:
+        username: ${{ secrets.DOCKERHUB_USER }}
+        password: ${{ secrets.DOCKERHUB_PASS }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Run cppcheck
+        run: cppcheck --enable=all --inline-suppr -Iinclude --error-exitcode=1 --suppress=missingIncludeSystem src/*
+
   dynamic_analysis:
     name: Run dynamic analysis
     runs-on: ubuntu-latest
@@ -139,7 +155,7 @@ jobs:
 
       - name: Upload coverage report
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: coverage-report
           path: ${{ env.COVERAGE_REPORT_DIR }}
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -11,6 +11,7 @@ option(ENABLE_LOGGING "enable library logs" OFF)
 set(PROJECT_NAME "pool-day")
 set(SOURCES src/task.c src/queue.c src/pool_day.c)
 
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Werror -Wextra -Wpedantic")
 set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS} -g3")
 set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS} -O3 -s")
@@ -40,7 +41,7 @@ if(BUILD_DOCUMENTATION)
 endif(BUILD_DOCUMENTATION)
 
 if(ENABLE_LOGGING)
-  add_definitions(-DLIB_LOGGING)
+  add_definitions(-DENABLE_LOGGING)
   list(APPEND SOURCES "src/logger.c")
 endif(ENABLE_LOGGING)
 
@@ -49,5 +50,5 @@ target_link_libraries(${PROJECT_NAME} pthread)
 
 install(TARGETS ${PROJECT_NAME} DESTINATION /usr/lib)
 install(FILES include/pool_day.h DESTINATION /usr/include/pool_day)
+install(FILES include/task.h DESTINATION /usr/include/pool_day)
 install(FILES include/internal/errors.h DESTINATION /usr/include/pool_day/internal)
-install(FILES include/internal/task.h DESTINATION /usr/include/pool_day/internal)
diff --git a/README.md b/README.md
@@ -1,23 +1,30 @@
 ## pool-day
 
+[![CI](https://github.com/andrelcmoreira/pool-day/actions/workflows/ci.yaml/badge.svg)](https://github.com/andrelcmoreira/pool-day/actions/workflows/ci.yaml)
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+
 #### Overview
 
-`pool-day` is a thread pool library for C/C++ applications.
+`pool-day` is a simple thread pool library for C/C++ applications built around POSIX threads.
+
+#### Building
 
-#### Build
+The library relies on `cmake` tool to be built:
 
 ```cmake
 $ cmake -S . -B build
 $ cmake --build build
+$ sudo cmake --install build
 ```
 
-Optional build flags:
+Additional flags can be supplied as parameter to cmake according to the table
+below:
 
-|        Flag         |                 Description            |
-|---------------------|----------------------------------------|
-|    BUILD_SAMPLES    | Build the library samples              |
-|   ENABLE_LOGGING    | Enable library logs                    |
+|      Flag      |                 Description          |
+|----------------|--------------------------------------|
+|  BUILD_SAMPLES | Build the library's samples          |
+| ENABLE_LOGGING | Enable the library's logging feature |
 
-#### Library support
+#### Support
 
 - linux
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
@@ -121,7 +121,8 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/include @CMAKE_CURRENT_SOURCE_DIR@/src
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/include @CMAKE_CURRENT_SOURCE_DIR@/src @CMAKE_CURRENT_SOURCE_DIR@/README.md
+USE_MDFILE_AS_MAINPAGE = README.md
 INPUT_ENCODING         = UTF-8
 INPUT_FILE_ENCODING    =
 FILE_PATTERNS          = *.c \

diff --git a/include/internal/errors.h b/include/internal/errors.h
@@ -4,7 +4,7 @@
  * @brief Contains the definition of the error codes of the library.
  *
  * @authors
- * Copyright (C) 2023 André L. C. Moreira <andrelcmoreira@disroot.org>
+ * Copyright (C) 2023 André L. C. Moreira <andrelcmoreira@proton.me>
  *
  * @copyright
  * This program is free software: you can redistribute it and/or modify

diff --git a/include/internal/logger.h b/include/internal/logger.h
@@ -4,7 +4,7 @@
  * @brief Contains the logging functions of the library.
  *
  * @authors
- * Copyright (C) 2023 André L. C. Moreira <andrelcmoreira@disroot.org>
+ * Copyright (C) 2023 André L. C. Moreira <andrelcmoreira@proton.me>
  *
  * @copyright
  * This program is free software: you can redistribute it and/or modify
@@ -27,19 +27,19 @@
  * @brief Log severity.
  */
 typedef enum {
-  POOL_DAY_INFO_INFO,
-  POOL_DAY_INFO_ERROR
+  POOL_DAY_DEBUG_SEVERITY,
+  POOL_DAY_ERROR_SEVERITY
 } pool_day_log_severity_t;
 
-#ifdef LIB_LOGGING
-#define POOL_DAY_INFO(...) \
-  __log_msg(POOL_DAY_INFO_INFO, __FILE__, __func__, __LINE__, __VA_ARGS__)
+#ifdef ENABLE_LOGGING
+#define POOL_DAY_DEBUG(...) \
+  __log_msg(POOL_DAY_DEBUG_SEVERITY, __FILE__, __func__, __LINE__, __VA_ARGS__)
 #define POOL_DAY_ERROR(...) \
-  __log_msg(POOL_DAY_INFO_ERROR, __FILE__, __func__, __LINE__, __VA_ARGS__)
+  __log_msg(POOL_DAY_ERROR_SEVERITY, __FILE__, __func__, __LINE__, __VA_ARGS__)
 #else
-#define POOL_DAY_INFO(...)
+#define POOL_DAY_DEBUG(...)
 #define POOL_DAY_ERROR(...)
-#endif  // LIB_LOGGING
+#endif  // ENABLE_LOGGING
 
 /**
  * @brief Log a message to the screen.

diff --git a/include/internal/queue.h b/include/internal/queue.h
@@ -4,7 +4,7 @@
  * @brief Contains the basic definitions and data structures of the task queue.
  *
  * @authors
- * Copyright (C) 2023 André L. C. Moreira <andrelcmoreira@disroot.org>
+ * Copyright (C) 2023 André L. C. Moreira <andrelcmoreira@proton.me>
  *
  * @copyright
  * This program is free software: you can redistribute it and/or modify
@@ -26,10 +26,10 @@
 #include <stdbool.h>
 #include <stdint.h>
 
-typedef struct task task_t; //!< Structure representing an item on the task
-                            // queue.
 typedef struct task_queue task_queue_t; //!< Structure representing the queue
                                         // itself.
+typedef struct task *task_t; //!< Structure representing an item on the task
+                             // queue.
 
 /**
  * @brief Get the queue size.
@@ -48,9 +48,9 @@ uint32_t queue_size(task_queue_t *queue);
  * @note This function is thread-safe.
  *
  * @param[in,out] queue Pointer to the queue.
- * @param[in]     task Pointer to the task to be enqueued.
+ * @param[in]     task Handle to the task to be enqueued.
  */
-void enqueue(task_queue_t *queue, task_t *task);
+void enqueue(task_queue_t *queue, task_t task);
 
 /**
  * @brief Dequeue a task from the queue.
@@ -61,7 +61,7 @@ void enqueue(task_queue_t *queue, task_t *task);
  *
  * @return The head task.
  */
-task_t *dequeue(task_queue_t *queue);
+task_t dequeue(task_queue_t *queue);
 
 /**
  * @brief Initialize the queue.

diff --git a/include/internal/task.h b/include/internal/task.h
diff --git a/include/internal/task_def.h b/include/internal/task_def.h
@@ -0,0 +1,58 @@
+/**
+ * @file
+ *
+ * @brief Contains the definitions of task structure and helper methods and
+ * macros to handle it.
+ *
+ * @authors
+ * Copyright (C) 2023 André L. C. Moreira <andrelcmoreira@proton.me>
+ *
+ * @copyright
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+#ifndef TASK_DEF_H_
+#define TASK_DEF_H_
+
+#include <semaphore.h>
+#include <stdbool.h>
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif  // __cplusplus
+
+/**
+ * @brief Pool task definition.
+ */
+struct task {
+  uint32_t id;                                          //!< Task identifier.
+  bool is_orphan;                                       //!< Flag indicating whether the task is orphaned.
+  bool auto_release;                                    //!< Flag indicating whether the task must be released after its execution.
+  struct task *next;                                    //!< Next element of the current instance.
+  struct task *prev;                                    //!< Previous element of the current instance.
+  void *(*task)(void *);                                //!< Task callback.
+  void *param;                                          //!< Parameter of the task callback.
+  void *ret_val;                                        //!< Task return value.
+  void (*on_task_start)(uint32_t, const void *);        //!< Callback executed when the task starts.
+  void (*on_task_end)(uint32_t, const void *, void *);  //!< Callback executed when the task ends.
+  sem_t ready;                                          //!< Task's semaphore.
+};
+
+typedef struct task *task_t; //!< Structure representing an item on the task queue.
+
+#ifdef __cplusplus
+}
+#endif  // __cplusplus
+
+#endif  // TASK_DEF_H_
diff --git a/include/internal/utils.h b/include/internal/utils.h
@@ -4,7 +4,7 @@
  * @brief Contains a set of utilities available for use by the library.
  *
  * @authors
- * Copyright (C) 2023 André L. C. Moreira <andrelcmoreira@disroot.org>
+ * Copyright (C) 2023 André L. C. Moreira <andrelcmoreira@proton.me>
  *
  * @copyright
  * This program is free software: you can redistribute it and/or modify