annotate dyncall/README.txt @ 533:71c884e610f0

- integration of patches from Raphael Luba, Thekla, Inc.: * integration of aggregate-by-value (struct, union) support patch for x64 (win and sysv) * windows/x64 asm additions to specify how stack unwinds (help for debuggers, exception handling, etc.) * see Changelog for details - new calling convention modes for thiscalls (platform agnostic, was specific before) * new signature character for platform agnostic thiscalls ('*' / DC_SIGCHAR_CC_THISCALL) - dcCallF(), dcVCallF(), dcArgF() and dcVArgF(): * added support for aggregates-by-value (wasn't part of patch) * change that those functions don't implicitly call dcReset() anymore, which was unflexible (breaking change) - added macros to feature test implementation for aggregate-by-value and syscall support - changed libdyncall_s.lib and libdyncallback_s.lib order in callback test makefiles, as some toolchains are picky about order - doc: * man page updates to describe aggregate interface * manual overview changes to highlight platforms with aggregate-by-value support - test/plain: replaced tests w/ old/stale sctruct interface with new aggregate one
author Tassilo Philipp
date Thu, 21 Apr 2022 13:35:47 +0200
parents 3e629dc19168
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
1 Library Design
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
2
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
3 Overview:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
4 1. Call Kernel
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
5 2. Utilities (memory and static sized vectors)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
6 3. Call State Machine
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
7 4. Application Programming Interface
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
8 5. extension: high-level formatted C API (ellipsis style)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
9
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
10
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
11 1. Call Kernel
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
12
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
13 Assembly Implementation:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
14
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
15 gcc front-end: dyncall_call.S
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
16 uses the C preprocessor
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
17 will include the apropriate assembly source
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
18
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
19 architecture/tool specific sources:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
20 dyncall_call_<ARCH>_<ASMTOOL>.[s|asm]
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
21
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
22
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
23 2. Utilities (memory and static sized vectors)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
24
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
25 2.1 Memory Management
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
26
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
27 C Interface: dyncall_alloc.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
28
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
29
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
30 2.2 Static-sized Vector
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
31
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
32 C Interface: dyncall_vector.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
33
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
34 C Implementation: dyncall_vector.c
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
35
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
36
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
37 3. Call State Machine
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
38
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
39 C Implementation:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
40 Top-level: dynall_callvm.c
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
41 Sub-levels:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
42 dyncall_callvm_<ARCH>.c
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
43
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
44
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
45 4. Application Programming Interface
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
46
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
47 C Header:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
48 Top-level: dyncall.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
49 Sub-level headers:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
50 dyncall_macros.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
51 dyncall_config.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
52 dyncall_types.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
53 C Implementation: dyncall_api.c
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
54
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
55
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
56 5. Extension: High-level C API (ellipsis style)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
57
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
58 C Header:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
59 Top-level: dyncall_callf.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
60 Sub-level headers:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
61 dyncall_value.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
62 dyncall_signature.h
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
63 C Implementation: dyncall_callf.c
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
64
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
65