Cの可変個関数の呼び出しを転送する


188

Cでは、可変個関数の呼び出しを転送できますか?のように、

int my_printf(char *fmt, ...) {
    fprintf(stderr, "Calling printf with fmt %s", fmt);
    return SOMEHOW_INVOKE_LIBC_PRINTF;
}

上記の方法で呼び出しを転送することは明らかにこの場合厳密には必要ありません(他の方法で呼び出しをログに記録したり、vfprintfを使用したりできるため)。 vfprintfと同様のヘルパー関数がない(および追加できない)。

[更新:これまでに提供された回答に基づいて、いくつかの混乱があるようです。質問を別の言い方で言うと、一般的に、関数の定義を変更せずに、任意の可変関数をラップできます。]


1
素晴らしい質問-幸い、va_listを受け取るvFuncオーバーロードを追加できます。投稿いただきありがとうございます。
岐阜

回答:



59

直接ではありませんが、可変関数がvarargsスタイルの代替関数とペアで使用されることは一般的です(ほとんどの場合、標準ライブラリのケースにあります)。例printf/vprintf

v ...関数はva_listパラメーターを受け取りますが、その実装はしばしばコンパイラー固有の「マクロマジック」で行われますが、次のようにvariadic関数からv ...スタイルの関数を呼び出すと確実に機能します。

#include <stdarg.h>

int m_printf(char *fmt, ...)
{
    int ret;

    /* Declare a va_list type variable */
    va_list myargs;

    /* Initialise the va_list variable with the ... after fmt */

    va_start(myargs, fmt);

    /* Forward the '...' to vprintf */
    ret = vprintf(fmt, myargs);

    /* Clean up the va_list */
    va_end(myargs);

    return ret;
}

これにより、探している効果が得られます。

可変ライブラリ関数の作成を検討している場合は、va_listスタイルのコンパニオンをライブラリの一部として使用できるようにすることも検討する必要があります。あなたの質問からわかるように、それはユーザーにとって有用であると証明できます。


変数を別の関数va_copyに渡す前に呼び出す必要があると確信していますmyargsMSC39-Cを参照してください。MSC39-Cには、実行中の動作が未定義の動作であると記載されています。
aviggiano

2
@aviggiano:ルールは「DOは呼んでいないva_arg()va_list不定値を持っている」私が使ったことがないので、私はあることをしないva_arg私の呼び出し元の関数に。への呼び出し(この場合)の後の不確定です(それが私たちを行うと仮定した場合)。この規格では、「[it]への参照を行う前にマクロに渡す必要がある」とされています。それはまさに私がすることです。呼び出し関数でそれらを反復するつもりはないので、その引数をコピーする必要はありません。myargsvprintfva_argmyargsva_end
CBベイリー

1
あなたが正しいです。Linuxのmanのページはそれを確認しました。がを使用する関数に渡された場合、その関数の戻り後の値は未定義です。apva_arg(ap,type)ap
aviggiano 2016

47

C99は、可変個引数を持つマクロをサポートしています。コンパイラによっては、必要なことを行うマクロを宣言できる場合があります。

#define my_printf(format, ...) \
    do { \
        fprintf(stderr, "Calling printf with fmt %s\n", format); \
        some_other_variadac_function(format, ##__VA_ARGS__); \
    } while(0)

ただし、一般的に、最善の解決策は、ラップしようとしている関数のva_list形式を使用することです。


11

ほとんど、で利用可能な機能を使用し<stdarg.h>ます:

#include <stdarg.h>
int my_printf(char *format, ...)
{
   va_list args;
   va_start(args, format);
   int r = vprintf(format, args);
   va_end(args);
   return r;
}

vprintfプレーンではなくバージョンを使用する必要があることに注意してくださいprintf。この状況では、を使用せずに可変関数を直接呼び出す方法はありませんva_list


1
おかげで、しかし質問から:「私が取り組んでいるコードベースには、vfprintfのようなヘルパー関数がありません(そして追加することはできません)。」
Patrick

11

このような呼び出しを適切に転送することは実際には不可能であるため、元のスタックフレームのコピーを使用して新しいスタックフレームを設定することで、これを回避しました。ただし、これは非常に移植性が低く、あらゆる種類の仮定を行います、コードがフレームポインターと「標準」の呼び出し規約を使用を行います。

このヘッダーファイルにより、x86_64およびi386(GCC)の可変個関数をラップできます。浮動小数点引数では機能しませんが、それらをサポートするために拡張するのは簡単です。

#ifndef _VA_ARGS_WRAPPER_H
#define _VA_ARGS_WRAPPER_H
#include <limits.h>
#include <stdint.h>
#include <alloca.h>
#include <inttypes.h>
#include <string.h>

/* This macros allow wrapping variadic functions.
 * Currently we don't care about floating point arguments and
 * we assume that the standard calling conventions are used.
 *
 * The wrapper function has to start with VA_WRAP_PROLOGUE()
 * and the original function can be called by
 * VA_WRAP_CALL(function, ret), whereas the return value will
 * be stored in ret.  The caller has to provide ret
 * even if the original function was returning void.
 */

#define __VA_WRAP_CALL_FUNC __attribute__ ((noinline))

#define VA_WRAP_CALL_COMMON()                                        \
    uintptr_t va_wrap_this_bp,va_wrap_old_bp;                        \
    va_wrap_this_bp  = va_wrap_get_bp();                             \
    va_wrap_old_bp   = *(uintptr_t *) va_wrap_this_bp;               \
    va_wrap_this_bp += 2 * sizeof(uintptr_t);                        \
    size_t volatile va_wrap_size = va_wrap_old_bp - va_wrap_this_bp; \
    uintptr_t *va_wrap_stack = alloca(va_wrap_size);                 \
    memcpy((void *) va_wrap_stack,                                   \
        (void *)(va_wrap_this_bp), va_wrap_size);


#if ( __WORDSIZE == 64 )

/* System V AMD64 AB calling convention */

static inline uintptr_t __attribute__((always_inline)) 
va_wrap_get_bp()
{
    uintptr_t ret;
    asm volatile ("mov %%rbp, %0":"=r"(ret));
    return ret;
}


#define VA_WRAP_PROLOGUE()           \
    uintptr_t va_wrap_ret;           \
    uintptr_t va_wrap_saved_args[7]; \
    asm volatile  (                  \
    "mov %%rsi,     (%%rax)\n\t"     \
    "mov %%rdi,  0x8(%%rax)\n\t"     \
    "mov %%rdx, 0x10(%%rax)\n\t"     \
    "mov %%rcx, 0x18(%%rax)\n\t"     \
    "mov %%r8,  0x20(%%rax)\n\t"     \
    "mov %%r9,  0x28(%%rax)\n\t"     \
    :                                \
    :"a"(va_wrap_saved_args)         \
    );

#define VA_WRAP_CALL(func, ret)            \
    VA_WRAP_CALL_COMMON();                 \
    va_wrap_saved_args[6] = (uintptr_t)va_wrap_stack;  \
    asm volatile (                         \
    "mov      (%%rax), %%rsi \n\t"         \
    "mov   0x8(%%rax), %%rdi \n\t"         \
    "mov  0x10(%%rax), %%rdx \n\t"         \
    "mov  0x18(%%rax), %%rcx \n\t"         \
    "mov  0x20(%%rax),  %%r8 \n\t"         \
    "mov  0x28(%%rax),  %%r9 \n\t"         \
    "mov           $0, %%rax \n\t"         \
    "call             *%%rbx \n\t"         \
    : "=a" (va_wrap_ret)                   \
    : "b" (func), "a" (va_wrap_saved_args) \
    :  "%rcx", "%rdx",                     \
      "%rsi", "%rdi", "%r8", "%r9",        \
      "%r10", "%r11", "%r12", "%r14",      \
      "%r15"                               \
    );                                     \
    ret = (typeof(ret)) va_wrap_ret;

#else

/* x86 stdcall */

static inline uintptr_t __attribute__((always_inline))
va_wrap_get_bp()
{
    uintptr_t ret;
    asm volatile ("mov %%ebp, %0":"=a"(ret));
    return ret;
}

#define VA_WRAP_PROLOGUE() \
    uintptr_t va_wrap_ret;

#define VA_WRAP_CALL(func, ret)        \
    VA_WRAP_CALL_COMMON();             \
    asm volatile (                     \
    "mov    %2, %%esp \n\t"            \
    "call  *%1        \n\t"            \
    : "=a"(va_wrap_ret)                \
    : "r" (func),                      \
      "r"(va_wrap_stack)               \
    : "%ebx", "%ecx", "%edx"   \
    );                                 \
    ret = (typeof(ret))va_wrap_ret;
#endif

#endif

最後に、次のように呼び出しをラップできます。

int __VA_WRAP_CALL_FUNC wrap_printf(char *str, ...)
{
    VA_WRAP_PROLOGUE();
    int ret;
    VA_WRAP_CALL(printf, ret);
    printf("printf returned with %d \n", ret);
    return ret;
}

3

vfprintfを使用します。

int my_printf(char *fmt, ...) {
    va_list va;
    int ret;

    va_start(va, fmt);
    ret = vfprintf(stderr, fmt, va);
    va_end(va);
    return ret;
}

1
おかげで、しかし質問から:「私が取り組んでいるコードベースには、vfprintfのようなヘルパー関数がありません(そして追加することはできません)。」
Patrick

2

生のスタック要素を取得できる唯一の場所はにあるため、このような関数呼び出しを転送する方法はありませんmy_print()。そのような呼び出しをラップする通常の方法は、2つの関数を使用することです。1つは単に引数をさまざまなvarargs構造体に変換するもので、もう1つはそれらの構造体を実際に操作するものです。このような二重関数モデルを使用すると、(たとえば)でprintf()構造体を初期化してラップmy_printf()va_start()、それをに渡すことができvfprintf()ます。


したがって、ラップする関数の実装を変更できない場合、呼び出しを転送する方法はありませんか?
Patrick

正しい。あなたの最善の策は、vprintfスタイルのラッパーを追加するようにプッシュすることです。
ジョンミリキン

1

はい、できますが、やや醜く、引数の最大数を知っておく必要があります。さらに、x86のようなスタックに引数が渡されないアーキテクチャ(PowerPCなど)を使用している場合は、「特別な」型(double、float、altivecなど)が使用されているかどうか、およびしたがって、それらに応じて対処してください。それはすぐに苦痛になる可能性がありますが、x86を使用している場合、または元の関数の境界が明確で制限されている場合は機能します。 それはまだハックですので、デバッグ目的で使用してください。その周りにソフトウェアを構築しないでください。とにかく、ここにx86での作業例があります:

#include <stdio.h>
#include <stdarg.h>

int old_variadic_function(int n, ...)
{
  va_list args;
  int i = 0;

  va_start(args, n);

  if(i++<n) printf("arg %d is 0x%x\n", i, va_arg(args, int));
  if(i++<n) printf("arg %d is %g\n",   i, va_arg(args, double));
  if(i++<n) printf("arg %d is %g\n",   i, va_arg(args, double));

  va_end(args);

  return n;
}

int old_variadic_function_wrapper(int n, ...)
{
  va_list args;
  int a1;
  int a2;
  int a3;
  int a4;
  int a5;
  int a6;
  int a7;
  int a8;

  /* Do some work, possibly with another va_list to access arguments */

  /* Work done */

  va_start(args, n);

  a1 = va_arg(args, int);
  a2 = va_arg(args, int);
  a3 = va_arg(args, int);
  a4 = va_arg(args, int);
  a5 = va_arg(args, int);
  a6 = va_arg(args, int);
  a7 = va_arg(args, int);

  va_end(args);

  return old_variadic_function(n, a1, a2, a3, a4, a5, a6, a7, a8);
}

int main(void)
{
  printf("Call 1: 1, 0x123\n");
  old_variadic_function(1, 0x123);
  printf("Call 2: 2, 0x456, 1.234\n");
  old_variadic_function(2, 0x456, 1.234);
  printf("Call 3: 3, 0x456, 4.456, 7.789\n");
  old_variadic_function(3, 0x456, 4.456, 7.789);
  printf("Wrapped call 1: 1, 0x123\n");
  old_variadic_function_wrapper(1, 0x123);
  printf("Wrapped call 2: 2, 0x456, 1.234\n");
  old_variadic_function_wrapper(2, 0x456, 1.234);
  printf("Wrapped call 3: 3, 0x456, 4.456, 7.789\n");
  old_variadic_function_wrapper(3, 0x456, 4.456, 7.789);

  return 0;
}

何らかの理由で、va_argでフロートを使用することはできません。gccは、floatはdoubleに変換されますが、プログラムがクラッシュすることを示しています。それだけでも、このソリューションはハックであり、一般的なソリューションはないことを示しています。私の例では、引数の最大数は8であると想定しましたが、その数を増やすことができます。ラップされた関数も整数のみを使用しましたが、それらは常に整数にキャストされるため、他の「通常の」パラメーターと同じように機能します。ターゲット関数は型を認識しますが、中間ラッパーはその必要はありません。ターゲット関数もそれを知っているので、ラッパーは正しい数の引数を知る必要もありません。便利な作業を行うには(呼び出しのログを記録する以外)、おそらく両方を知っておく必要があります。


0

基本的に3つのオプションがあります。

1つは、それを渡さないで、ターゲット関数の可変個実装を使用し、楕円を渡さないことです。もう1つは、可変個のマクロを使用することです。3番目のオプションは、私が不足しているすべてのものです。

私はこれが本当に扱いやすいように感じるので、私は通常オプション1で行きます。オプション2には、可変長マクロの呼び出しにいくつかの制限があるため、欠点があります。

ここにいくつかのサンプルコードがあります:

#include <stdio.h>
#include <stdarg.h>

#define Option_VariadicMacro(f, ...)\
    printf("printing using format: %s", f);\
    printf(f, __VA_ARGS__)

int Option_ResolveVariadicAndPassOn(const char * f, ... )
{
    int r;
    va_list args;

    printf("printing using format: %s", f);
    va_start(args, f);
    r = vprintf(f, args);
    va_end(args);
    return r;
}

void main()
{
    const char * f = "%s %s %s\n";
    const char * a = "One";
    const char * b = "Two";
    const char * c = "Three";
    printf("---- Normal Print ----\n");
    printf(f, a, b, c);
    printf("\n");
    printf("---- Option_VariadicMacro ----\n");
    Option_VariadicMacro(f, a, b, c);
    printf("\n");
    printf("---- Option_ResolveVariadicAndPassOn ----\n");
    Option_ResolveVariadicAndPassOn(f, a, b, c);
    printf("\n");
}

0

これを行う最良の方法は

static BOOL(__cdecl *OriginalVarArgsFunction)(BYTE variable1, char* format, ...)(0x12345678); //TODO: change address lolz

BOOL __cdecl HookedVarArgsFunction(BYTE variable1, char* format, ...)
{
    BOOL res;

    va_list vl;
    va_start(vl, format);

    // Get variable arguments count from disasm. -2 because of existing 'format', 'variable1'
    uint32_t argCount = *((uint8_t*)_ReturnAddress() + 2) / sizeof(void*) - 2;
    printf("arg count = %d\n", argCount);

    // ((int( __cdecl* )(const char*, ...))&oldCode)(fmt, ...);
    __asm
    {
        mov eax, argCount
        test eax, eax
        je noLoop
        mov edx, vl
        loop1 :
        push dword ptr[edx + eax * 4 - 4]
        sub eax, 1
        jnz loop1
        noLoop :
        push format
        push variable1
        //lea eax, [oldCode] // oldCode - original function pointer
        mov eax, OriginalVarArgsFunction
        call eax
        mov res, eax
        mov eax, argCount
        lea eax, [eax * 4 + 8] //+8 because 2 parameters (format and variable1)
        add esp, eax
    }
    return res;
}

0

gccは、これを実行できる拡張機能を提供しています__builtin_apply。gccマニュアルの関数呼び出しの作成を参照してください。

例:

#include <stdio.h>

int my_printf(const char *fmt, ...) {
    void *args = __builtin_apply_args();
    printf("Hello there! Format string is %s\n", fmt);
    void *ret = __builtin_apply((void (*)())printf, args, 1000);
    __builtin_return(ret);
}

int main(void) {
    my_printf("%d %f %s\n", -37, 3.1415, "spam");
    return 0;
}

ゴッドボルトで試してみてください

ドキュメントには、より複雑な状況では機能しない可能性があるという警告がいくつかあります。また、引数の最大サイズをハードコードする必要があります(ここでは1000を使用しました)。しかし、C言語またはアセンブリ言語のいずれかでスタックを分析することを含む他のアプローチの妥当な代替手段になる可能性があります。


0

ラッパー関数でvfprintfのようなヘルパー関数を使用するための制限が適用される理由がわからないので、これがOPの質問に答えるのに役立つかどうかはわかりません。ここでの主な問題は、可変引数リストを解釈せずに転送することが難しいことだと思います。可能なことは、フォーマットを実行し(vfprintf:vsnprintfのようなヘルパー関数を使用)、フォーマットされた出力を可変引数(つまり、ラップされた関数の定義を変更しない)でラップされた関数に転送することです。だから、ここに行きます:

int my_printf(char *fmt, ...)
{
    int ret;

    if (fmt == NULL) {
        /* Invalid format pointer */
        ret = -1;
    } else {
        va_list args;
        int len;

        va_start(args, fmt);

        /* Get length of format including arguments */
        len = vsnprintf(NULL, 0, fmt, args);

        if (len < 0) {
            /* vsnprintf failed */
            ret = -1;
        } else {
            /* Declare a character buffer and write the formatted string */
            char formatted[len + 1];
            vsnprintf(formatted, sizeof(formatted), fmt, args);

            /* Call the wrapped function using the formatted output and return */
            fprintf(stderr, "Calling printf with fmt %s", fmt);
            ret = printf(formatted);
        }

        va_end(args);
    }

    return ret;
}

私はこの解決策をここで見つけました

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.