From 8e1424fbec7b15d8dfc84de0cfc1c7a3f3d8cc5c Mon Sep 17 00:00:00 2001 From: Enrico Fraccaroli Date: Fri, 9 Dec 2022 11:03:50 -0500 Subject: [PATCH] Update comments. --- mentos/inc/mem/zone_allocator.h | 23 ++++++++++++----------- mentos/inc/system/signal.h | 4 +++- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/mentos/inc/mem/zone_allocator.h b/mentos/inc/mem/zone_allocator.h index e0aa447..e828ef1 100644 --- a/mentos/inc/mem/zone_allocator.h +++ b/mentos/inc/mem/zone_allocator.h @@ -23,29 +23,30 @@ /// @brief Page descriptor. Use as a bitmap to understand the order of the block /// and if it is free or allocated. typedef struct page_t { - /// Array of flags encoding also the zone number to which the page frame - /// belongs. + /// @brief Array of flags encoding also the zone number to which the page + /// frame belongs. unsigned long flags; - /// Page frame’s reference counter. 0 free, 1 used, 2+ copy on write + /// @brief Page frame’s reference counter. 0 free, 1 used, 2+ copy on write atomic_t count; - /// Buddy system page definition + /// @brief Buddy system page definition bb_page_t bbpage; - /// Contains pointers to the slabs doubly linked list of pages. + /// @brief Contains pointers to the slabs doubly linked list of pages. list_head slabs; - // Slab allocator variables / Contains the total number of objects in this - //page, 0 if not managed by the slub + /// @brief Slab allocator variables / Contains the total number of objects + /// in this page, 0 if not managed by the slub. unsigned int slab_objcnt; - /// Tracks the number of free objects in the current page + /// @brief Tracks the number of free objects in the current page unsigned int slab_objfree; - /// Holds the first free object (if slab_objfree is > 0) + /// @brief Holds the first free object (if slab_objfree is > 0) list_head slab_freelist; /// @brief This union can either contain the pointer to the slab main page /// that handles this page, or the cache that contains it. union { - /// Holds the slab page used to handle this memory region (root page) + /// @brief Holds the slab page used to handle this memory region (root + /// page). struct page_t *slab_main_page; - /// Holds the slab cache pointer on the main page + /// @brief Holds the slab cache pointer on the main page. kmem_cache_t *slab_cache; } container; } page_t; diff --git a/mentos/inc/system/signal.h b/mentos/inc/system/signal.h index ab7b832..34daf91 100644 --- a/mentos/inc/system/signal.h +++ b/mentos/inc/system/signal.h @@ -268,13 +268,15 @@ int sys_kill(pid_t pid, int sig); /// @brief Sets the disposition of the signal signum to handler. /// @param signum The signal number. /// @param handler The handler for the signal. +/// @param sigreturn_addr The address of the sigreturn function. /// @return The previous value of the signal handler, or SIG_ERR on error. sighandler_t sys_signal(int signum, sighandler_t handler, uint32_t sigreturn_addr); /// @brief Examine and change a signal action. /// @param signum Specifies the signal and can be any valid signal except SIGKILL and SIGSTOP. -/// @param act If non-NULL, the new action for signal signum is installed from act. +/// @param act If non-NULL, the new action for signal signum is installed from act. /// @param oldact If non-NULL, the previous action is saved in oldact. +/// @param sigreturn_addr The address of the sigreturn function. /// @return returns 0 on success; on error, -1 is returned, and errno is set to indicate the error. int sys_sigaction(int signum, const sigaction_t *act, sigaction_t *oldact, uint32_t sigreturn_addr);