FPC Internals/Parameters: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | back to contents [[FPC internals]] | |
| 2 | 2 | ||
| 3 | 3 | FPC is using the CPU target specified parameter manager to manage the location of parameters passed into and routines. | |
| 4 | 4 | ||
| 5 | 5 | CPU target should implement parameter manager in **cpupara.pas** unit. | |
| 6 | 6 | ||
| 7 | 7 | The unit should initialize the global **ParaManager** variable if an instance of the CPU specific class. | |
| 8 | 8 | ||
| 9 | - | ||
| 9 | + | ``` pascal | |
| 10 | + | ParaManager:=tcpuparamanager.create | |
| 11 | + | ``` | |
| 10 | 12 | ||
| 11 | 13 | The basic TParaManager class cannot and should not be created, as it contain the abstract methods that should be implemented by CPU target implementation class. | |
| 12 | 14 | ||
| 13 | 15 | ## Methods to Implement | |
| 14 | 16 | ||
| 15 | 17 | The following methods are critical for CPU target implementation | |
| 16 | 18 | ||
| 17 | 19 | ### push_addr_param | |
| 18 | 20 | ||
| 19 | 21 | Returns true if a parameter is too large to copy and only the address is pushed or if the parameter should be passed by address reference at all time. | |
| 20 | 22 | ||
| 21 | 23 | ```delphi | |
| 22 | 24 | function push_addr_param(varspez: tvarspez; def: tdef; calloption: tproccalloption) : boolean; | |
| 23 | 25 | ``` | |
| 24 | 26 | ||
| 25 | 27 | The typical approach would be first to inspect variable specifier argument **varspez**. | |
| 26 | 28 | ||
| 27 | 29 | Normally, vs_var, vs_out, vs_constref are always passed by reference and **push_addr_param** should return true. | |
| 28 | 30 | ||
| 29 | 31 | In many cases **var_const** should return true as well, however, it's driven by CPU target ABI and calling convention. (for example, if definition (**def**) is a record and it can fit CPU word, then the value of the structure can be put into memory/register. Thus the function should return false) | |
| 30 | 32 | ||
| 31 | 33 | If there variable specifier doesn't indicate a need to pass by address, the next step is to inspect a definition. | |
| 32 | 34 | ||
| 33 | 35 | The following definition types (**def.typ**) are typically passed via address (and the function should return true for those): | |
| 34 | 36 | ||
| 35 | 37 | - Formal (formaldef) | |
| 36 | 38 | - Object instances (objectdef, but only if is_object() returns true) | |
| 37 | 39 | - Strings (stringdef) for types st_shortstring or st_longstring. | |
| 38 | 40 | - Arrays (arraydef) for open arrays, arrays of const. | |
| 39 | 41 | ||
| 40 | 42 | Depending on CPU type **calloption** should be considered, if different calling conventions apply for the CPU target. | |
| 41 | 43 | ||
| 42 | 44 | ### create_paraloc_info | |
| 43 | 45 | ||
| 44 | 46 | This is used to populate the location information on all parameters for the routine as seen in either the caller or the callee. It returns the size allocated on the stack | |
| 45 | 47 | ||
| 46 | 48 | ```delphi | |
| 47 | 49 | function create_paraloc_info(p : tabstractprocdef; side: tcallercallee):longint; | |
| 48 | 50 | ``` | |
| 49 | 51 | ||
| 50 | 52 | ### create_varargs_paraloc_info | |
| 51 | 53 | ||
| 52 | 54 | This is used to populate the location information on all parameters for the routine that are passed as varargs. It returns the size allocated on the stack (including the normal parameters) | |
| 53 | 55 | ||
| 54 | 56 | ```delphi | |
| 55 | 57 | function create_varargs_paraloc_info(p : tabstractprocdef; side: tcallercallee; varargspara:tvarargsparalist):longint; | |
| 56 | 58 | ``` | |
| 57 | 59 | ||
| 58 | 60 | ### get_funcretloc | |
| 59 | 61 | ||
| 60 | 62 | Returns the location of the function result if p had def as function result instead of its actual result. Used if the compiler forces the function result to something different than the real result. | |
| 61 | 63 | ||
| 62 | 64 | ```delphi | |
| 63 | 65 | function get_funcretloc(p : tabstractprocdef; side: tcallercallee; forcetempdef: tdef): tcgpara; | |
| 64 | 66 | ``` | |
| 65 | 67 | ||
| 66 | 68 | ## See Also | |
| 67 | 69 | ||
| 68 | 70 | - [[FPC Internals]] | |
| 69 | 71 | ||
| 70 | 72 | --- | |
| 71 | 73 | *From the Free Pascal wiki, page "FPC Internals/Parameters", as it stood on 2020-12-28 after a change by E-ric, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* |