Skip to content

pkg/tlsf: add documentation. #8994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jcarrano wants to merge 1 commit into from
+19 −0
Closed

pkg/tlsf: add documentation. #8994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions pkg/tlsf/doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/**
* @defgroup pkg_tlsf Two-Level Segregated Fit memory allocator
* @ingroup pkg
* @brief TLSF is a general purpose dynamic memory allocator specifically
* designed to meet real-time requirements:

@jia200x jia200x Apr 20, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Colon in the end. Should be dot.

* @see http://www.gii.upv.es/tlsf/
* @see https://github.com/mattconte/tlsf
*
* TLSF provides an implementation of malloc/realloc/free/etc with the following
* characteristics:
*
* - O(1) Performance
* - Works on a user supplied block of memory instead of a global heap.
* - Efficient both in terms of memory overhead and processor time.
* - Low fragmentation.
*

@jia200x jia200x Apr 20, 2018 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I know, this implementation/adoption doesn't support 16-bit platforms and maybe should be pointed out here. @OlegHahm can you confirm this?

@jcarrano jcarrano Apr 23, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not building for 16 bit, see #4612

*/
2 changes: 2 additions & 0 deletions sys/oneway-malloc/include/malloc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
*
* @note You should prefer statically allocated memory whenever possible.
*
* @see pkg_tlsf

@jia200x jia200x Apr 20, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See discussion

*
* @{
* @file
*
Expand Down