diff options
| author | Dmitry Vyukov <dvyukov@google.com> | 2018-01-06 14:46:52 +0100 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2018-01-08 12:52:31 +0100 |
| commit | 402a0dc87e7d51812a18fa76feeb46d66efda175 (patch) | |
| tree | 03ae2832257917a68829137b0a504f6f8c2e499a /docs/syscall_descriptions_syntax.md | |
| parent | 93b4c6f135aeecbb756fe8c8a3d46c7a05412a54 (diff) | |
sys: support type aliases (aka typedefs)
Complex types that are often repeated can be given short type aliases using the
following syntax:
```
type identifier underlying_type
```
For example:
```
type signalno int32[0:65]
type net_port proc[20000, 4, int16be]
```
Then, type alias can be used instead of the underlying type in any contexts.
Underlying type needs to be described as if it's a struct field, that is,
with the base type if it's required. However, type alias can be used as syscall
arguments as well. Underlying types are currently restricted to integer types,
`ptr`, `ptr64`, `const`, `flags` and `proc` types.
Diffstat (limited to 'docs/syscall_descriptions_syntax.md')
| -rw-r--r-- | docs/syscall_descriptions_syntax.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/syscall_descriptions_syntax.md b/docs/syscall_descriptions_syntax.md index 8bf6b64ee..bafe0480c 100644 --- a/docs/syscall_descriptions_syntax.md +++ b/docs/syscall_descriptions_syntax.md @@ -137,6 +137,28 @@ accept(fd sock, ...) sock listen(fd sock, backlog int32) ``` +## Type Aliases + +Complex types that are often repeated can be given short type aliases using the +following syntax: + +``` +type identifier underlying_type +``` + +For example: + +``` +type signalno int32[0:65] +type net_port proc[20000, 4, int16be] +``` + +Then, type alias can be used instead of the underlying type in any contexts. +Underlying type needs to be described as if it's a struct field, that is, +with the base type if it's required. However, type alias can be used as syscall +arguments as well. Underlying types are currently restricted to integer types, +`ptr`, `ptr64`, `const`, `flags` and `proc` types. + ## Length You can specify length of a particular field in struct or a named argument by using `len`, `bytesize` and `bitsize` types, for example: |
