T-Kernel Specification (1.B0.02)

154 CHAPTER 4. T-KERNEL/OS FUNCTIONS
tk ref mpf
Reference Fixed-size Memory Pool Status
[C Language Interface]
ER ercd = tk_ref_mpf ( ID mpfid, T_RMPF *pk_rmpf ) ;
[Parameters]
ID mpfid Fixed-size memory pool ID
T RMPF* pk rmpf Address of packet for returning status information
[Return Parameters]
ER ercd Error code
pk rmpf detail:
VP exinf Extended information
ID wtsk Waiting task information
INT frbcnt Free block count
(Other implementation-dependent parameters may be added beyond this point.)
[Error Codes]
E OK
E ID
E NOEXS
E PAR
Normal completion
Invalid ID number (mpfid is invalid or cannot be used)
Object does not exist (the fixed-size memory pool designated in mpfid does not exist)
Parameter error (the return parameter packet address cannot be used)
[Description]
References the status of the fixed-size memory pool designated in mpfid, passing in return parameters
the current free block count frbcnt, waiting task information (wtsk), and extended information (exinf).
wtsk indicates the ID of a task waiting for memory block allocation from this fixed-size memory pool.
If multiple tasks are waiting for the fixed-size memory pool, the ID of the task at the head of the queue
is returned. If there are no waiting tasks, wtsk = 0 is returned.
If the fixed-size memory pool designated with tk ref mpf does not exist, error code E NOEXS is returned.
At least one of frbcnt = 0 and wtsk = 0 is always true for this system call.
[Additional Notes]
Whereas frsz returned by tk ref mpl gives the total free memory size in bytes, frbcnt returns the
number of unused memory blocks.
Copyright c○ 2002, 2003 by T-Engine Forum
T-Kernel 1.B0.02