Compartilhar via


CTRPP

A ferramenta CTRPP é um pré-processador que analisa e valida o manifesto para seu provedor V2. A ferramenta gera .rc recursos com as cadeias de caracteres necessárias para os consumidores do seu provedor e gera um .h cabeçalho com o código que você usa para fornecer os dados do contador. Você deve executar a ferramenta CTRPP durante a compilação do seu provedor. Você deve usar o código gerado como ponto de partida ao desenvolver seu provedor em vez de tentar gerar esse código por conta própria.

ctrpp -o codeFile -rc rcFile [-legacy] [-MemoryRoutines] [-NotificationCallback] [-prefix prefix] [-ch symFile] [-backcompat] inputFile

Argumentos

Opção Descrição
arquivo de entrada Necessário: Especifica o nome do arquivo (manifesto .man XML) que define seus contadores.
-oarquivo de código Necessário: Especifica o nome do arquivo de .h código a ser gerado pelo CTRPP. Esse arquivo conterá funções auxiliares embutidas C/C++ que simplificam a inicialização e a não inicialização do provedor.
-rcrcArquivo Necessário: Especifica o .rc nome do (arquivo de recurso) a ser gerado pelo CTRPP. Esse arquivo conterá a tabela de cadeias de caracteres do provedor.
-chsymFile Especifica o nome do arquivo de símbolo opcional .h a ser gerado pelo CTRPP. Esse arquivo conterá símbolos C/C++ para os nomes e GUIDs de cada contador no provedor.
-prefixoprefixo Especifica o prefixo a ser usado para as variáveis e funções definidas no arquivo de cabeçalho gerado.
-Retorno de chamada de notificação Altera a assinatura padrão da função CounterInitialize para incluir parâmetros para especificar o nome das funções de retorno de chamada ControlCallback, AllocateMemory e FreeMemory . Esse argumento tem o mesmo efeito que incluir o callback atributo no elemento provider .
-migrararquivo de saída Em vez de gerar .h arquivos e .rc , atualiza o manifesto inputFile para a versão mais recente e o salva em outputFile. Este switch não pode ser usado com outros switches. Uso: CTRPP -migrate NewFile.man OldFile.man
-BackCompat Deprecado: O suporte para provedores de modo kernel foi adicionado no Windows 7. Por padrão, o código gerado pelo CTRPP para provedores de modo kernel será incompatível com versões anteriores do Windows (o driver não será carregado devido a APIs ausentes Pcw*** ). Defina -BackCompat para habilitar a compatibilidade com versões anteriores do Windows. O driver carregará dinamicamente as APIs necessárias e o código gerado desabilitará silenciosamente o provedor se as APIs não estiverem disponíveis.
-Rotinas de memória Deprecado: Quando usado com a -Legacy opção, inclui modelos para rotinas de memória no código gerado. Caso contrário, esse argumento terá o mesmo efeito que a -NotificationCallback opção.
-Legado Deprecado: Gera *.harquivos , *.c, *.rce *_r.h usando os modelos de código do Windows Vista (gera PerfAutoInitialize e PerfAutoCleanup em vez de CounterInitialize e CounterCleanup). Essa opção pode ser usada com -MemoryRoutines e -NotificationCallback , mas não pode ser usada com outras opções. Não use as opções -o ou -rc com esta opção. Os arquivos gerados serão nomeados com base no nome do manifesto e serão gravados no diretório que continha o manifesto. Uso: CTRPP -legacy OldFile.man

Observações

A ferramenta CTRPP gera um arquivo de .h código, um .rc arquivo de recurso e, opcionalmente, gera um arquivo de .h símbolo.

Usando o arquivo de recurso gerado

A ferramenta CTRPP gerará um arquivo de .rc recurso que contém as cadeias de caracteres localizáveis necessárias para os consumidores dos contadores do provedor.

Importante

Os recursos desse arquivo devem ser incluídos no binário do provedor e o caminho completo para o binário do provedor deve ser registrado durante a instalação do manifesto do provedor. Os consumidores que não conseguirem localizar e carregar os recursos não poderão usar os contadores do provedor.

Os recursos de cadeia de caracteres devem ser tratados da seguinte maneira:

  • O desenvolvedor edita o arquivo de manifesto (.man) do provedor para definir o applicationIdentity atributo do provedor como o nome de um binário do provedor (.DLL, .SYS ou .EXE) que conterá os recursos de cadeia de caracteres para o provedor e será instalado como parte do componente do provedor.
  • A ferramenta CTRPP lê o manifesto do provedor e gera um .rc arquivo.
  • A ferramenta RC (compilador de recursos) compila os dados do arquivo gerado pelo .rc CTRPP para gerar um .res arquivo contendo os recursos binários. Isso pode ser feito compilando diretamente o arquivo gerado pelo .rc CTRPP OU compilando outro .rc arquivo que inclua o arquivo gerado pelo .rc CTRPP por meio de uma #include diretiva.
  • O vinculador insere os dados do arquivo gerado por .res RC no binário do provedor.
  • Durante a instalação, o binário do provedor é copiado para o sistema do usuário e o manifesto do provedor é registrado usando a ferramenta lodctr. A ferramenta lodctr converte o applicationIdentity atributo do manifesto do provedor em um caminho completo e registra o caminho completo para o binário do provedor no registro.
    • Se o binário do provedor estiver no mesmo diretório que o manifesto, use: lodctr.exe /m:"C:\full\manifest\path\manifest.man". lodctr combinará o caminho do manifesto especificado com o atributo do applicationIdentity manifesto para formar o caminho completo.
    • Caso contrário, use lodctr.exe /m:"C:\full\manifest\path\manifest.man" "c:\full\binary\path". lodctr combinará o caminho binário especificado com o atributo do applicationIdentity manifesto para formar o caminho completo.
    • Para fins de diagnóstico, você pode inspecionar o caminho completo gravado verificando o ApplicationIdentity valor da chave HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\_V2Providers\{<ProviderGuid>}do Registro.
    • Se o binário estiver usando MUI para localização, certifique-se de copiar o arquivo MUI junto com o binário.
  • Durante a coleta de contadores, o consumidor usa o caminho completo gravado para o binário do provedor para localizar e carregar as cadeias de caracteres necessárias dos recursos do binário do provedor.

Usando o arquivo de código gerado em um provedor de modo de usuário

A ferramenta CTRPP gerará um arquivo de .h código C/C++. Se o atributo do manifesto do providerType provedor for definido como userMode, o arquivo de código gerado conterá as seguintes definições que são úteis na codificação de um provedor de modo de usuário:

  • n função de inicialização do provedor chamada prefixoCounterInitialize.
  • Uma função de limpeza do provedor chamada prefixoCounterCleanup.
  • Uma variável de provedor global que armazena o identificador de provedor aberto pela função CounterInitialize de prefixo. O nome da variável é o valor do symbol atributo do provider elemento no manifesto. Essa variável deve ser usada em chamadas para PerfCreateInstance, PerfDeleteInstancee outras APIs para controlar os dados do seu provedor.
  • Para cada contador, uma variável GUID de contador global com o GUID do contador. O nome da variável é o valor do atributo do counterSetsymbol elemento mais o sufixo "GUID", por exemplo MyCounterSetGUID, . Essa variável deve ser usada em chamadas para PerfCreateInstance, PerfDeleteInstancee outras APIs para controlar os dados do seu provedor.
  • Para cada contador, uma macro de contador com o valor do id contador. O nome da macro é o valor do counter atributo do symbol elemento. Essa macro deve ser usada em chamadas para PerfSetCounterRefValue, PerfSetULongLongCounterValuee outras APIs para definir os dados do seu provedor.

Nos nomes de função, prefixo refere-se ao valor do parâmetro de linha de -prefix comando. Se o -prefix parâmetro não for usado, as funções serão nomeadas CounterInitialize e CounterCleanup.

Usando o arquivo de código gerado em um provedor de modo kernel

A ferramenta CTRPP gerará um arquivo de .h código C/C++. Se o atributo do manifesto do providerType provedor estiver definido como kernelMode, o arquivo de código gerado conterá as seguintes definições que são úteis na codificação dos contadores de um provedor de modo kernel:

  • Uma função de inicialização de contraconjunto chamada prefixoRegister Counterset. Essa função preenche uma estrutura RegInfo e, em seguida, invoca PcwRegister, colocando o identificador de registro de contraconjunto resultante na variável Counterset global.
  • Uma função de limpeza de contraconjunto chamada prefixoUnregisterCounterset. Essa função invoca PcwUnregister no identificador de registro de contador na variável de contador global.
  • Uma função de criação de instância chamada prefixCreateCounterset. Essa função preenche uma matriz de estruturas PcwData e, em seguida, invoca PcwCreateInstance usando o identificador de registro de contador na variável Counterset global.
  • Uma função de limpeza de instância chamada prefixoClose Counterset. Essa função invoca PcwCloseInstance.
  • Uma função de relatório de instância chamada prefixAddCounterset a ser usada a partir da função de retorno de chamada do counterset. Essa função preenche uma matriz de estruturas PcwData e, em seguida, invoca PcwAddInstance.
  • SDK do Windows 20H1 e posterior: Uma função de inicialização RegInfo chamada prefixoInitRegistrationInformationCounterset para uso em cenários avançados. Essa função preenche uma estrutura RegInfo . Essa função pode ser usada nos casos em que o prefixogeradoRegister Counterset não atende às suas necessidades, por exemplo, quando você deseja personalizar os valores na estrutura RegInfo ou quando deseja armazenar o identificador retornado em outra variável.

Nos nomes de função, prefixo refere-se ao valor do parâmetro de linha de -prefix comando. Se o -prefix parâmetro não for usado, as funções não terão prefixo.

Observação

A função AddCounterset de prefixo gerada é usada quando você tem um retorno de chamada de contraconjunto. As funções de prefixogerado Criarcontraconjunto e prefixoFecharcontraconjunto são usadas quando você não tem um retorno de chamada de contraconjunto.

Usando o arquivo de símbolo gerado

Se o parâmetro -ch for especificado na linha de comando, a ferramenta CTRPP gerará um arquivo de .h símbolo. Esse arquivo contém os símbolos C/C++ para os nomes e GUIDs de cada contador no provedor. Os símbolos podem ser usados ao escrever programas codificados para consumir os dados desse contador usando as funções PerfLib V2 Consumer.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]