{"id":109095,"date":"2023-12-04T07:00:00","date_gmt":"2023-12-04T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=109095"},"modified":"2023-12-04T13:46:06","modified_gmt":"2023-12-04T21:46:06","slug":"20231204-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20231204-00\/?p=109095","title":{"rendered":"What is a static chain pointer in the context of calling convention ABI?"},"content":{"rendered":"

Buried deep in the System V Application Binary Interface document for the AMD64 Architecture, there is a footnote on page 24 that says, “%r10<\/code> is used for passing a function’s static chain pointer.” What is a static chain pointer?<\/p>\n

Some languages, such as Pascal, supported nested functions such that the nested function is permitted to access variables from its parent.<\/p>\n

function Outer(n: integer) : integer;\r\n    var i: integer;\r\n\r\n    procedure Inner(m: integer);\r\n    begin\r\n        i := i + m\r\n    end;\r\n\r\n(* Outer body begins here *)\r\nbegin\r\n    i := 0;\r\n    Inner(n);\r\n    Outer := i\r\nend;\r\n<\/pre>\n
The Outer<\/code> function doesn’t do anything useful, but it does it in an interesting way.<\/p>\n
It begins with a local variable declaration for i<\/code>, and then defines a local procedure Inner<\/code> which adds its parameter m<\/code> to the Outer<\/code> variable i<\/code>. The Outer<\/code> function then initializes i<\/code> to zero, calls Inner(n)<\/code> (which adds n<\/code> to i<\/code>), and then returns the modified value of i<\/code>.<\/p>\n
This is just the identity function, but it calculates the result with the help of an inner function.<\/p>\n
The way this works is that the Inner<\/code> function receives a hidden parameter that tells it where the Outer<\/code> procedure’s local variables are.<\/p>\n
In practice, what is passed is a pointer to the Outer<\/code> procedure’s stack frame.<\/p>\n
Now, if the containing function or precedure happens itself to be nested, then you can use the parent’s frame to access the local variables of the grandparent.<\/p>\n
function Outer(n: integer) : integer;\r\n    var i: integer;\r\n\r\n    procedure Inner(m: integer);\r\n\r\n        procedure MoreInner<\/span>\r\n        begin\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>\r\n         \u00a0\u00a0\u00a0i := i + m\u00a0\u00a0\u00a0\u00a0 <\/span>\r\n        end\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>\r\n    begin\r\n        MoreInner\r\n    end;\r\n\r\n(* Outer body begins here *)\r\nbegin\r\n    i := 0;\r\n    Inner(n);\r\n    Outer := i\r\nend;\r\n<\/pre>\n
In this case, the MoreInner<\/code> receives a hidden pointer to Inner<\/code>‘s stack frame, which lets it access the m<\/code> parameter from Inner<\/code>. But Inner<\/code> is itself a nested procedure and therefore received a pointer to Outer<\/code>‘s stack frame. Therefore, MoreInner<\/code> can use that pointer to access Outer<\/code>‘s local variable i<\/code>.<\/p>\n
Here’s what it looks like in a diagram:<\/p>\n
\u00a0<\/div>\n
\u00a0<\/div>\n\n\n\n\n\n
MoreInner<\/td>\n <\/td>\nInner<\/td>\n <\/td>\nOuter<\/td>\n<\/tr>\n
chain<\/td>\n\u279d<\/td>\nchain<\/td>\n\u279d<\/td>\nn<\/code><\/td>\n<\/tr>\n
 <\/td>\n <\/td>\nm<\/code><\/td>\n <\/td>\ni<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
This is called a static<\/i> chain because the structure of the chain is based on lexical scoping, not dynamic scoping. You can see the difference in this example:<\/p>\n
function Outer(n: integer) : integer;\r\n    var i: integer;\r\n\r\n    procedure Update(j: integer);\r\n    begin\r\n        i := i + j\r\n    end;\r\n\r\n    procedure Inner(m: integer);\r\n\r\n        procedure MoreInner;\r\n        begin\r\n            Update(m)\r\n        end;\r\n\r\n    (* Inner body begins here *)\r\n    begin\r\n        MoreInner\r\n    end;\r\n\r\n(* Outer body begins here *)\r\nbegin\r\n    i := 0;\r\n    Inner(n);\r\n    Outer := i\r\nend;\r\n<\/pre>\n
This version is even more useless than the previous one: MoreInner<\/code> doesn’t update i<\/code> directly, but instead asks Update<\/code> (an uncle procedure) to do it.<\/p>\n
At the point that MoreInner<\/code> calls Update<\/code>, it does not pass its own stack frame as the static chain pointer. Instead, it passes Outer<\/code>‘s stack frame, because Update<\/code>‘s parent is Outer<\/code>.<\/p>\n
The static chain does not match the dynamic call stack: The call stack says that Update<\/code>‘s caller is MoreInner<\/code> but the static chain says that Update<\/code>‘s parent is Outer<\/code>.<\/p>\n\n\n\n\n\n\n\n
Update<\/td>\n <\/td>\nMoreInner<\/td>\n <\/td>\nInner<\/td>\n <\/td>\nOuter<\/td>\n<\/tr>\n
frame pointer<\/td>\n\u279d<\/td>\nframe pointer<\/td>\n\u279d<\/td>\nframe pointer<\/td>\n\u279d<\/td>\nframe pointer<\/td>\n<\/tr>\n
chain<\/td>\n\u279d\u279d\u279d\u279d\u279d\u279d\u279d\u279d\u279d\u279d\u279d\u279d\u279d\u279d\u279d\u279d<\/td>\nn<\/code><\/td>\n<\/tr>\n
 <\/td>\n <\/td>\nchain<\/td>\n\u279d<\/td>\nchain<\/td>\n\u2b67<\/span><\/td>\ni<\/code><\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n <\/td>\nm<\/code><\/td>\n <\/td>\n <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
The authors of the Application Binary Interface document assume you are familiar with how nested functions are implemented and are just noting that the calling convention for nested functions is to pass the static chain in the %r10<\/code> register.<\/p>\n