Encaminhar uma invocação de uma função variável em C

189

Em C, é possível encaminhar a invocação de uma função variável? Como em,

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

O encaminhamento da invocação da maneira acima obviamente não é estritamente necessário neste caso (já que você pode registrar invocações de outras maneiras ou usar vfprintf), mas a base de código em que estou trabalhando exige que o wrapper faça algum trabalho real, e não possui (e não pode ter adicionado) uma função auxiliar semelhante ao vfprintf.

[Atualização: parece haver alguma confusão com base nas respostas que foram fornecidas até agora. Para formular a pergunta de outra maneira: em geral, você pode agrupar alguma função variável arbitrária sem modificar a definição dessa função .]

Patrick
fonte
1
pergunta incrível - felizmente, posso adicionar uma sobrecarga vFunc que requer uma va_list. Obrigado por publicar.
Gishu 03/06/09

Respostas:

157

Se você não tiver uma função análoga à vfprintfque exige um va_listnúmero variável de argumentos, não poderá fazê-lo . Vejohttp://c-faq.com/varargs/handoff.html .

Exemplo:

void myfun(const char *fmt, va_list argp) {
    vfprintf(stderr, fmt, argp);
}
Adam Rosenfield
fonte
5
Dependendo de quão crucial seja o problema, a chamada por montagem em linha ainda oferece essa possibilidade.
filip
60

Não diretamente, no entanto, é comum (e você encontrará quase universalmente o caso na biblioteca padrão) para funções variadas virem em pares com uma varargsfunção alternativa de estilo. por exemplo printf/vprintf

As funções v ... assumem um parâmetro va_list, cuja implementação geralmente é feita com 'macro magic' específica do compilador, mas você tem certeza de que chamar a função estilo v ... de uma função variável como esta funcionará:

#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;
}

Isso deve lhe dar o efeito que você está procurando.

Se você estiver pensando em escrever uma função de biblioteca variável, considere também disponibilizar um companheiro de estilo va_list como parte da biblioteca. Como você pode ver na sua pergunta, pode ser útil para seus usuários.

CB Bailey
fonte
Tenho certeza de que você precisa chamar va_copyantes de passar a myargsvariável para outra função. Consulte o MSC39-C , onde afirma que o que você está fazendo é um comportamento indefinido.
aviggiano 26/02
2
@aviggiano: A regra é "Não chame va_arg()um va_listque tenha um valor indeterminado", não faço isso porque nunca uso va_argna minha função de chamada. O valor de myargsapós a chamada (neste caso) para vprintfé indeterminado (supondo que ele nos faça va_arg). A norma diz que myargs"deve ser passado para a va_endmacro antes de qualquer referência adicional a [it]"; que é exatamente o que eu faço. Não preciso copiar esses argumentos, porque não tenho a intenção de iterá-los na função de chamada.
26416 CB Bailey
1
Você está certo. A página de manual do Linux confirma isso. Se apfor passado para uma função que usa va_arg(ap,type), o valor de apé indefinido após o retorno dessa função.
aviggiano 26/02
48

O C99 suporta macros com argumentos variados ; dependendo do seu compilador, você poderá declarar uma macro que faz o que deseja:

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

Em geral, porém, a melhor solução é usar a forma va_list da função que você está tentando agrupar , caso exista.

Comodoro Jaeger
fonte
12

Quase, usando as facilidades disponíveis em <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;
}

Observe que você precisará usar a vprintfversão em vez de simples printf. Não existe uma maneira de chamar diretamente uma função variável nesta situação sem usar va_list.

Greg Hewgill
fonte
1
Obrigado, mas a partir da pergunta: "a base de código em que estou trabalhando [...] não possui (e não pode ter adicionado) uma função auxiliar semelhante ao vfprintf."
Patrick
11

Como não é realmente possível encaminhar essas chamadas de maneira agradável, resolvemos isso configurando um novo quadro de pilha com uma cópia do quadro de pilha original. No entanto, isso é altamente não transportável e faz todos os tipos de suposições , por exemplo, que o código usa ponteiros de quadro e as convenções de chamada 'padrão'.

Esse arquivo de cabeçalho permite agrupar funções variadas para x86_64 e i386 (GCC). Ele não funciona para argumentos de ponto flutuante, mas deve ser direto para estender o suporte a eles.

#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

No final, você pode encerrar chamadas assim:

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;
}
coltox
fonte
3

Use 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;
}
Greg Rogers
fonte
1
Obrigado, mas a partir da pergunta: "a base de código em que estou trabalhando [...] não possui (e não pode ter adicionado) uma função auxiliar semelhante ao vfprintf."
Patrick
2

Não há como encaminhar essas chamadas de função porque o único local onde você pode recuperar os elementos brutos da pilha está my_print(). A maneira usual de agrupar chamadas dessa maneira é ter duas funções, uma que apenas converte os argumentos em várias varargsestruturas, e outra que realmente opera sobre essas estruturas. Usando esse modelo de função dupla, você pode (por exemplo) quebrar printf(), inicializando as estruturas my_printf()com va_start()e depois passá-las para vfprintf().

John Millikin
fonte
Portanto, não há como encaminhar a chamada se você não puder modificar a implementação da função que deseja agrupar?
Patrick
Certo. Sua melhor aposta é pressionar para que um invólucro no estilo vprintf seja adicionado.
John Millikin
1

Sim, você pode fazê-lo, mas é um pouco feio e você precisa saber o número máximo de argumentos. Além disso, se você estiver em uma arquitetura em que os argumentos não sejam passados ​​na pilha como o x86 (por exemplo, PowerPC), será necessário saber se tipos "especiais" (double, floats, altivec etc.) são usados ​​e se então, lide com eles de acordo. Pode ser doloroso rapidamente, mas se você estiver no x86 ou se a função original tiver um perímetro bem definido e limitado, ela poderá funcionar. Ainda será um hack , use-o para fins de depuração. Não crie seu software em torno disso. De qualquer forma, aqui está um exemplo de trabalho no 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;
}

Por alguma razão, você não pode usar carros alegóricos com va_arg, o gcc diz que eles são convertidos para o dobro, mas o programa trava. Isso por si só demonstra que esta solução é um hack e que não há uma solução geral. No meu exemplo, assumi que o número máximo de argumentos era 8, mas você pode aumentar esse número. A função empacotada também usou apenas números inteiros, mas funciona da mesma maneira com outros parâmetros 'normais', pois eles sempre são convertidos em números inteiros. A função de destino conhecerá seus tipos, mas seu invólucro intermediário não precisa. O wrapper também não precisa saber o número certo de argumentos, pois a função de destino também o conhecerá. Para fazer um trabalho útil (exceto apenas registrar a chamada), você provavelmente precisará conhecer as duas coisas.

user10146
fonte
1

O gcc oferece uma extensão que pode fazer isso: __builtin_applye parentes. Consulte Construindo chamadas de função no manual do gcc.

Um exemplo:

#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;
}

Experimente no godbolt

Existem alguns cuidados na documentação que podem não funcionar em situações mais complicadas. E você tem que codificar um tamanho máximo para os argumentos (aqui eu usei 1000). Mas pode ser uma alternativa razoável às outras abordagens que envolvem dissecar a pilha na linguagem C ou assembly.

Nate Eldredge
fonte
Útil. Obrigado!
rsmoorthy 10/07
0

Existem essencialmente três opções.

Uma é não repassá-lo, mas usar a implementação variável de sua função de destino e não repassar as elipses. O outro é usar uma macro variável. A terceira opção é tudo o que está faltando.

Eu costumo ir com a opção um, porque eu sinto que isso é realmente fácil de manusear. A opção dois tem uma desvantagem, porque existem algumas limitações para chamar macros variadicas.

Aqui está um exemplo de código:

#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");
}
Johannes
fonte
0

A melhor maneira de fazer isso é

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;
}
SSpoke
fonte
0

Não tenho certeza se isso ajuda a responder à pergunta do OP, pois não sei por que a restrição de uso de uma função auxiliar semelhante a vfprintf na função wrapper se aplica. Penso que o principal problema aqui é que é difícil encaminhar a lista de argumentos variados sem interpretá-los. O que é possível é executar a formatação (usando uma função auxiliar semelhante a vfprintf: vsnprintf) e encaminhar a saída formatada para a função agrupada com argumentos variados (isto é, não modificar a definição da função agrupada). Aqui vamos nos:

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;
}

Me deparei com esta solução aqui .

Bert Regelink
fonte