annotate doc/manual/manual_design.tex @ 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 b47168dacba6
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 %//////////////////////////////////////////////////////////////////////////////
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
2 %
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
3 % Copyright (c) 2007,2009 Daniel Adler <dadler@uni-goettingen.de>,
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
4 % Tassilo Philipp <tphilipp@potion-studios.com>
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
5 %
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
6 % Permission to use, copy, modify, and distribute this software for any
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
7 % purpose with or without fee is hereby granted, provided that the above
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
8 % copyright notice and this permission notice appear in all copies.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
9 %
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
10 % THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
11 % WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
12 % MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
13 % ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
14 % WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
15 % ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
16 % OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
17 %
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
18 %//////////////////////////////////////////////////////////////////////////////
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
19
467
b47168dacba6 manual:
Tassilo Philipp
parents: 0
diff changeset
20 \clearpage
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
21 \section{Library Design}
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
22
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
23
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
24 \subsection{Design considerations}
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
25
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
26 The \product{dyncall} library encapsulates function call invocation semantics
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
27 that depend on the compiler, operating system and architecture.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
28 The core library is driven by a function call invocation engine,
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
29 named \emph{CallVM}, that encapsulates a call stack to foreign functions
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
30 and manages the following three phases that constitute a truly dynamic function
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
31 call:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
32
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
33 \begin{enumerate}
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
34 \item Specify the calling convention. Some run-time platforms, such as
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
35 Microsoft Windows on a 32-bit X86 architecture, even support multiple calling
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
36 conventions.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
37 \item Specify the function call arguments in a specific order. The
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
38 interface design dictates a \emph{left to right} order for C and C++ function
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
39 calls in which the arguments are bound.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
40 \item Specify the target function address, expected return value and
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
41 invoke the function call.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
42 \end{enumerate}
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
43
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
44 The calling convention mode entirely depends on the way the foreign function
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
45 has been compiled and specifies the low-level details on how a function
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
46 actually expects input parameters (in memory, in registers or both) and how to
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
47 return its result(s).
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
48
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
49