Есть ли лучшая альтернатива перенаправлению препроцессора для отслеживания времени выполнения внешнего API? - PullRequest
Новая
       9

Есть ли лучшая альтернатива перенаправлению препроцессора для отслеживания времени выполнения внешнего API?

1 голос
/ 22 февраля 2010

У меня какая-то сложная проблема, которую я пытаюсь решить. Прежде всего, обзор:

У меня есть внешний API, который не находится под моим контролем, который используется огромным количеством устаревшего кода.

  • Существует несколько классов ошибок в унаследованном коде, которые потенциально могут быть обнаружены во время выполнения, если только внешний API был написан для отслеживания его собственного использования, но это не так.
  • Мне нужно найти решение, которое позволило бы мне перенаправлять вызовы внешнего API в инфраструктуру отслеживания, которая бы отслеживала использование API и регистрировала ошибки.
  • В идеале я хотел бы, чтобы журнал отражал файл и номер строки вызова API, который вызвал ошибку, если это возможно.

Вот пример класса ошибок, которые я хотел бы отследить. API, который мы используем, имеет две функции. Я назову их GetAmount и SetAmount. Они выглядят примерно так: 

// Get an indexed amount
long GetAmount(short Idx);

// Set an indexed amount
void SetAmount(short Idx, long amount);

Это обычные C функции. Одна ошибка, которую я пытаюсь обнаружить во время выполнения, - это когда GetAmount вызывается с Idx, который еще не был установлен с SetAmount.

Теперь все вызовы API содержатся в пространстве имен (назовите его api_ns), однако они не всегда были в прошлом. Так что, конечно, старый код просто выбрасывал «using namespace api_ns;»; в их файле stdafx.h и назвал это хорошо.

Моей первой попыткой было использование препроцессора для перенаправления вызовов API на мою собственную инфраструктуру отслеживания. Выглядело это примерно так: 

// in FormTrackingFramework.h
class FormTrackingFramework
{
    private:
        static FormTrackingFramework* current;

    public:
        static FormTrackingFramework* GetCurrent();

        long GetAmount(short Idx, const std::string& file, size_t line)
        {
            // track usage, log errors as needed
            api_ns::GetAmount(Idx);
        }
};

#define GetAmount(Idx) (FormTrackingFramework::GetCurrent()->GetAmount(Idx, __FILE__, __LINE__))

Затем в stdafx.h: 

// in stdafx.h

#include "theAPI.h"

#include "FormTrackingFramework.h"

#include "LegacyPCHIncludes.h"

Теперь, это нормально работает для GetAmount и SetAmount, но есть проблема. API также имеет SetString (короткий Idx, const char * str). В какой-то момент наш старый код добавил перегрузку: SetString (короткий Idx, const std :: string & str) для удобства. Проблема в том, что препроцессор не знает или не заботится, вызываете ли вы SetString или определяете перегрузку SetString. Он просто видит «SetString» и заменяет его определением макроса. Что, конечно, не компилируется при определении новой перегрузки SetString.

Я мог бы изменить порядок #include в stdafx.h для включения FormTrackingFramework.h после LegacyPCHInclude.h, однако это означало бы, что ни один из кодов в дереве включения LegacyPCHInclude.h не будет отслеживаться.

Итак, я думаю, у меня есть два вопроса на данный момент: 1: как решить проблему с перегрузкой API? 2: Есть ли какой-то другой способ делать то, что я хочу сделать, который работает лучше?

Примечание. Я использую Visual Studio 2008 с пакетом обновления 1 (SP1).

Ответы [ 2 ]

1 голос
/ 22 февраля 2010

Ну, для случаев, когда вам нужны перегрузки, вы можете использовать экземпляр класса, который перегружает operater() для ряда параметров. 

#define GetAmount GetAmountFunctor(FormTrackingFramework::GetCurrent(), __FILE__, __LINE__)

затем создайте GetAmountFunctor: 

 class GetAmountFunctor
 {
    public:
      GetAmountFunctor(....) // capture relevant debug info for logging
      {}

      void operator() (short idx, std::string str) 
      {
           // logging here
           api_ns::GetAmount(idx, str);
      }

      void operator() (short idx) 
      {
           /// logging here
           api_ns::GetAmount(Idx);
      }
 };

Это очень псевдокод, но я думаю, вы поняли идею. Где бы в вашем унаследованном коде ни упоминалось конкретное имя функции, оно заменяется объектом функтора, и функция фактически вызывается в функторе. Учтите, что вам нужно делать это только для функций, где перегрузки являются проблемой. Чтобы уменьшить количество связующего кода, вы можете создать единую структуру для параметров __FILE__, __LINE__ и передать ее в конструктор в качестве одного аргумента.

0 голосов
/ 12 июня 2016

Проблема в том, что препроцессор не знает или не заботится, вызываете ли вы SetString или определяете перегрузку SetString.

Очевидно, что причина использования препроцессора в том, что он не обращает внимания на пространство имен.

Хороший подход состоит в том, чтобы прикусить пулю и перенастроить все большое приложение, чтобы использовать другое пространство имен api_wrapped_ns вместо api_ns.

Внутри api_wrapped_ns, могут быть предусмотрены встроенные функции, которые обертывают аналоги одинаковыми сигнатурами в api_ns.

Может даже быть переключатель времени компиляции, подобный этому: 

namespace api_wrapped_ns {
#ifdef CONFIG_API_NS_WRAPPER
  inline long GetAmount(short Idx, const std::string& file, size_t line)
  {
    // of course, do more than just wrapping here
    return api_ns::GetAmount(Idx, file, line);     
  } 
  // other inlines
#else
  // Wrapping turned off: just bring in api_ns into api_wrapper_ns
  using namespace api_ns;
#endif
}

Кроме того, упаковка может быть доставлена ​​по частям: 

namespace api_wrapped_ns {
  // This function is wrapped;
  inline long GetAmount(short Idx, const std::string& file, size_t line)
  {
    // of course, do more than just wrapping here
    return
  }
  // The api_ns::FooBar symbol is unwrapped (for now)
  using api_ns::FooBar;
}
...