T-Kernel Specification (1.B0.02)

148 CHAPTER 4. T-KERNEL/OS FUNCTIONS
tk cre mpf
Create Fixed-size Memory Pool
[C Language Interface]
ID mpfid = tk_cre_mpf ( T_CMPF *pk_cmpf ) ;
[Parameters]
T CMPF* pk cmpf Information about the memory pool to be created
pk cmpf detail:
VP exinf Extended information
ATR mpfatr Memory pool attributes
INT mpfcnt Memory pool block count
INT blfsz Memory block size (in bytes)
(Other implementation-dependent parameters may be added beyond this point.)
[Return Parameters]
ID mpfid Fixed-size memory pool ID
or Error Code
[Error Codes]
E OK
E NOMEM
E LIMIT
E RSATR
E PAR
Normal completion
Insufficient memory (memory for control block or memory pool area cannot be allocated)
Number of fixed-size memory pools exceeds the system limit
Reserved attribute (mpfatr is invalid or cannot be used)
Parameter error (pk cmpf is invalid; mpfsz or blfsz is negative or invalid)
[Description]
Creates a fixed-size memory pool, assigning to it a fixed-size memory pool ID.
This system call allocates a memory space for use as a memory pool based on the information designated
in parameters mpfcnt and blfsz, and assigns a control block to the memory pool. A memory block of
size blfsz can be allocated from the created memory pool by calling the tk get mpf system call.
exinf can be used freely by the user to set miscellaneous information about the created memory pool.
The information set in this parameter can be referenced by tk ref mpf. If a larger area is needed
for indicating user information, or if the information may need to be changed after the memory pool
is created, this can be done by allocating separate memory for this purpose and putting the memory
packet address in exinf. The OS pays no attention to the contents of exinf.
mpfatr indicates system attributes in its low bits and implementation-dependent information in the
high bits. Designation in the system attributes part of mpfatr is as follows.
Copyright c○ 2002, 2003 by T-Engine Forum
T-Kernel 1.B0.02