From: Nicholas Nethercote <njn@valgrind.org>
Date: Mon, 20 Nov 2006 22:02:40 +0000 (+0000)
Subject: Clarify NON_SIMD_CALL instructions.
X-Git-Tag: svn/VALGRIND_3_3_0~523
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=688b71e4a19191bd305feff0ec10419d53a28705;p=thirdparty%2Fvalgrind.git

Clarify NON_SIMD_CALL instructions.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6362
---

diff --git a/include/valgrind.h b/include/valgrind.h
index dafc0d910e..9cc0af9b38 100644
--- a/include/valgrind.h
+++ b/include/valgrind.h
@@ -3652,7 +3652,19 @@ VALGRIND_PRINTF_BACKTRACE(const char *format, ...)
 
 
 /* These requests allow control to move from the simulated CPU to the
-   real CPU, calling an arbitary function */
+   real CPU, calling an arbitary function.
+   
+   Note that the current ThreadId is inserted as the first argument.
+   So this call:
+
+     VALGRIND_NON_SIMD_CALL2(f, arg1, arg2)
+
+   requires f to have this signature:
+
+     Word f(Word tid, Word arg1, Word arg2)
+
+   where "Word" is a word-sized type.
+*/
 #define VALGRIND_NON_SIMD_CALL0(_qyy_fn)                          \
    __extension__                                                  \
    ({unsigned long _qyy_res;                                      \