Index: generic/src/mm/as.c =================================================================== --- generic/src/mm/as.c (revision a9e8b391eb50bc107c79551596bd8b68710ead90) +++ generic/src/mm/as.c (revision a98cdc75925619cf46177b7e734930398d02a8e2) @@ -27,8 +27,18 @@ */ -/* +/** + * @file as.c + * @brief Address space related functions. + * * This file contains address space manipulation functions. * Roughly speaking, this is a higher-level client of * Virtual Address Translation (VAT) subsystem. + * + * Functionality provided by this file allows one to + * create address space and create, resize and share + * address space areas. + * + * @see page.c + * */ @@ -685,5 +695,5 @@ * * @param as Address space. - * @param as_locked If false, do not attempt to lock as->lock. + * @param lock If false, do not attempt to lock as->lock. */ void page_table_lock(as_t *as, bool lock) @@ -698,5 +708,5 @@ * * @param as Address space. - * @param as_locked If false, do not attempt to unlock as->lock. + * @param unlock If false, do not attempt to unlock as->lock. */ void page_table_unlock(as_t *as, bool unlock) Index: generic/src/mm/buddy.c =================================================================== --- generic/src/mm/buddy.c (revision a9e8b391eb50bc107c79551596bd8b68710ead90) +++ generic/src/mm/buddy.c (revision a98cdc75925619cf46177b7e734930398d02a8e2) @@ -27,4 +27,13 @@ */ +/** + * @file buddy.c + * @brief Buddy allocator framework. + * + * This file contains buddy system allocator framework. + * Specialized functions are needed for this abstract framework + * to be useful. + */ + #include #include Index: generic/src/mm/frame.c =================================================================== --- generic/src/mm/frame.c (revision a9e8b391eb50bc107c79551596bd8b68710ead90) +++ generic/src/mm/frame.c (revision a98cdc75925619cf46177b7e734930398d02a8e2) @@ -26,4 +26,14 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** + * @file frame.c + * @brief Physical frame allocator. + * + * This file contains the physical frame allocator and memory zone management. + * The frame allocator is built on top of the buddy allocator. + * + * @see buddy.c */ Index: generic/src/mm/page.c =================================================================== --- generic/src/mm/page.c (revision a9e8b391eb50bc107c79551596bd8b68710ead90) +++ generic/src/mm/page.c (revision a98cdc75925619cf46177b7e734930398d02a8e2) @@ -27,6 +27,12 @@ */ -/* - * Virtual Address Translation subsystem. +/** + * @file page.c + * @brief Virtual Address Translation subsystem. + * + * This file contains code for creating, destroying and searching + * mappings between virtual addresses and physical addresses. + * Functions here are mere wrappers that call the real implementation. + * They however, define the single interface. */ @@ -74,6 +80,6 @@ /** Insert mapping of page to frame. * - * Map virtual address @page to physical address @frame - * using @flags. Allocate and setup any missing page tables. + * Map virtual address page to physical address frame + * using flags. Allocate and setup any missing page tables. * * The page table must be locked and interrupts must be disabled. @@ -94,5 +100,5 @@ /** Remove mapping of page. * - * Remove any mapping of @page within address space @as. + * Remove any mapping of page within address space as. * TLB shootdown should follow in order to make effects of * this call visible. Index: generic/src/mm/slab.c =================================================================== --- generic/src/mm/slab.c (revision a9e8b391eb50bc107c79551596bd8b68710ead90) +++ generic/src/mm/slab.c (revision a98cdc75925619cf46177b7e734930398d02a8e2) @@ -27,30 +27,33 @@ */ -/* - * The SLAB allocator is closely modelled after OpenSolaris SLAB allocator - * http://www.usenix.org/events/usenix01/full_papers/bonwick/bonwick_html/ +/** + * @file slab.c + * @brief Slab allocator. + * + * The slab allocator is closely modelled after OpenSolaris slab allocator. + * @see http://www.usenix.org/events/usenix01/full_papers/bonwick/bonwick_html/ * * with the following exceptions: - * - empty SLABS are deallocated immediately + * @li empty slabs are deallocated immediately * (in Linux they are kept in linked list, in Solaris ???) - * - empty magazines are deallocated when not needed + * @li empty magazines are deallocated when not needed * (in Solaris they are held in linked list in slab cache) * - * Following features are not currently supported but would be easy to do: - * - cache coloring - * - dynamic magazine growing (different magazine sizes are already + * Following features are not currently supported but would be easy to do: + * @li cache coloring + * @li dynamic magazine growing (different magazine sizes are already * supported, but we would need to adjust allocation strategy) * - * The SLAB allocator supports per-CPU caches ('magazines') to facilitate + * The slab allocator supports per-CPU caches ('magazines') to facilitate * good SMP scaling. * * When a new object is being allocated, it is first checked, if it is * available in CPU-bound magazine. If it is not found there, it is - * allocated from CPU-shared SLAB - if partial full is found, it is used, + * allocated from CPU-shared slab - if partial full is found, it is used, * otherwise a new one is allocated. * * When an object is being deallocated, it is put to CPU-bound magazine. * If there is no such magazine, new one is allocated (if it fails, - * the object is deallocated into SLAB). If the magazine is full, it is + * the object is deallocated into slab). If the magazine is full, it is * put into cpu-shared list of magazines and new one is allocated. * @@ -61,13 +64,13 @@ * * Every cache contains list of full slabs and list of partialy full slabs. - * Empty SLABS are immediately freed (thrashing will be avoided because + * Empty slabs are immediately freed (thrashing will be avoided because * of magazines). * - * The SLAB information structure is kept inside the data area, if possible. + * The slab information structure is kept inside the data area, if possible. * The cache can be marked that it should not use magazines. This is used - * only for SLAB related caches to avoid deadlocks and infinite recursion - * (the SLAB allocator uses itself for allocating all it's control structures). - * - * The SLAB allocator allocates lot of space and does not free it. When + * only for slab related caches to avoid deadlocks and infinite recursion + * (the slab allocator uses itself for allocating all it's control structures). + * + * The slab allocator allocates lot of space and does not free it. When * frame allocator fails to allocate the frame, it calls slab_reclaim(). * It tries 'light reclaim' first, then brutal reclaim. The light reclaim @@ -77,5 +80,6 @@ * magazines. * - * TODO: For better CPU-scaling the magazine allocation strategy should + * TODO:@n + * For better CPU-scaling the magazine allocation strategy should * be extended. Currently, if the cache does not have magazine, it asks * for non-cpu cached magazine cache to provide one. It might be feasible @@ -86,9 +90,8 @@ * magazine cache. * - * - it might be good to add granularity of locks even to slab level, - * we could then try_spinlock over all partial slabs and thus improve - * scalability even on slab level - */ - + * @li it might be good to add granularity of locks even to slab level, + * we could then try_spinlock over all partial slabs and thus improve + * scalability even on slab level + */ #include @@ -114,5 +117,5 @@ /** Cache for external slab descriptors * This time we want per-cpu cache, so do not make it static - * - using SLAB for internal SLAB structures will not deadlock, + * - using slab for internal slab structures will not deadlock, * as all slab structures are 'small' - control structures of * their caches do not require further allocation @@ -142,5 +145,5 @@ /**************************************/ -/* SLAB allocation functions */ +/* Slab allocation functions */ /** @@ -191,5 +194,5 @@ /** - * Deallocate space associated with SLAB + * Deallocate space associated with slab * * @return number of freed frames @@ -213,5 +216,5 @@ /**************************************/ -/* SLAB functions */ +/* Slab functions */ @@ -274,5 +277,5 @@ if (list_empty(&cache->partial_slabs)) { /* Allow recursion and reclaiming - * - this should work, as the SLAB control structures + * - this should work, as the slab control structures * are small and do not need to allocte with anything * other ten frame_alloc when they are allocating, @@ -510,5 +513,5 @@ /**************************************/ -/* SLAB CACHE functions */ +/* Slab cache functions */ /** Return number of objects that fit in certain cache size */ @@ -790,5 +793,5 @@ ipl = interrupts_disable(); spinlock_lock(&slab_cache_lock); - printf("SLAB name\t Osize\t Pages\t Obj/pg\t Slabs\t Cached\tAllocobjs\tCtl\n"); + printf("slab name\t Osize\t Pages\t Obj/pg\t Slabs\t Cached\tAllocobjs\tCtl\n"); for (cur = slab_cache_list.next;cur!=&slab_cache_list; cur=cur->next) { cache = list_get_instance(cur, slab_cache_t, link); Index: generic/src/mm/tlb.c =================================================================== --- generic/src/mm/tlb.c (revision a9e8b391eb50bc107c79551596bd8b68710ead90) +++ generic/src/mm/tlb.c (revision a98cdc75925619cf46177b7e734930398d02a8e2) @@ -25,4 +25,9 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** + * @file tlb.c + * @brief Generic TLB shootdown algorithm. */