Função FltCreateFileEx (fltkernel.h)

Artigo
08/07/2023

Os drivers de minifiltro chamam FltCreateFileEx para criar um arquivo ou abrir um arquivo existente.

Sintaxe

NTSTATUS FLTAPI FltCreateFileEx(
  [in]           PFLT_FILTER        Filter,
  [in, optional] PFLT_INSTANCE      Instance,
  [out]          PHANDLE            FileHandle,
  [out]          PFILE_OBJECT       *FileObject,
  [in]           ACCESS_MASK        DesiredAccess,
  [in]           POBJECT_ATTRIBUTES ObjectAttributes,
  [out]          PIO_STATUS_BLOCK   IoStatusBlock,
  [in, optional] PLARGE_INTEGER     AllocationSize,
  [in]           ULONG              FileAttributes,
  [in]           ULONG              ShareAccess,
  [in]           ULONG              CreateDisposition,
  [in]           ULONG              CreateOptions,
  [in, optional] PVOID              EaBuffer,
  [in]           ULONG              EaLength,
  [in]           ULONG              Flags
);

Parâmetros

[in] Filter

Um ponteiro de filtro opaco para o chamador.

[in, optional] Instance

Um ponteiro de instância opaco para a instância de driver de minifiltro para a qual a solicitação de criação deve ser enviada. A instância deve ser anexada ao volume em que o arquivo ou diretório reside. Esse parâmetro é opcional e pode ser NULL. Se esse parâmetro for NULL, a solicitação será enviada para o objeto de dispositivo na parte superior da pilha de driver do sistema de arquivos para o volume. Se não for NULL, a solicitação será enviada somente para instâncias de driver de minifiltro anexadas abaixo da instância especificada.

[out] FileHandle

Um ponteiro para uma variável alocada pelo chamador que receberá o identificador de arquivo se a chamada para FltCreateFileEx for bem-sucedida.

[out] FileObject

Um ponteiro para uma variável alocada pelo chamador que receberá o ponteiro do objeto de arquivo se a chamada para FltCreateFileEx for bem-sucedida. Esse parâmetro é opcional e pode ser NULL.

[in] DesiredAccess

Uma máscara de bits de sinalizadores que especifica o tipo de acesso ao arquivo ou diretório exigido pelo chamador. Consulte o parâmetro DesiredAccess de IoCreateFileEx para obter mais informações sobre esse parâmetro e para obter a lista de valores de sinalizador.

[in] ObjectAttributes

Ponteiro para uma estrutura de OBJECT_ATTRIBUTES opaca que já está inicializada com InitializeObjectAttributes. Consulte o parâmetro ObjectAttributes de IoCreateFileEx para obter mais informações e para obter uma descrição de cada membro da estrutura.

[out] IoStatusBlock

Ponteiro para uma estrutura IO_STATUS_BLOCK que recebe a status de conclusão final e informações sobre a operação solicitada. Consulte o parâmetro IoStatusBlock de IoCreateFileEx.

[in, optional] AllocationSize

Opcionalmente, especifica o tamanho da alocação inicial, em bytes, para o fluxo de arquivos. Um valor diferente de zero não tem efeito, a menos que o arquivo esteja sendo criado, substituído ou substituído.

[in] FileAttributes

Especifica um ou mais sinalizadores FILE_ATTRIBUTE_XXX , que representam os atributos de arquivo a serem definidos se você estiver criando, substituindo ou substituindo um arquivo. Consulte o parâmetro FileAttributes de IoCreateFileEx para obter mais detalhes e para obter a lista de sinalizadores.

[in] ShareAccess

Especifica o tipo de acesso de compartilhamento ao arquivo que o chamador requer, como zero ou um, ou uma combinação dos sinalizadores. Consulte o parâmetro ShareAccess de IoCreateFileEx para obter mais detalhes e para obter a lista de sinalizadores.

[in] CreateDisposition

Especifica um valor que determina a ação a ser tomada, dependendo se o arquivo já existe. Consulte o parâmetro Disposition de IoCreateFileEx para obter a lista de valores possíveis.

[in] CreateOptions

Especifica as opções a serem aplicadas ao criar ou abrir o arquivo. Esse parâmetro é uma combinação compatível dos sinalizadores listados e descritos no parâmetro CreateOptions de IoCreateFileEx.

[in, optional] EaBuffer

Um ponteiro para um buffer estruturado FILE_FULL_EA_INFORMATION fornecido pelo chamador que contém informações de EA (atributo estendido) a serem aplicadas ao arquivo.

[in] EaLength

Comprimento, em bytes, de EaBuffer.

[in] Flags

Especifica as opções a serem usadas durante a criação da solicitação de criação. Consulte o parâmetro Options de IoCreateFileEx para obter a lista de opções possíveis.

Retornar valor

FltCreateFileEx retorna STATUS_SUCCESS ou um valor NTSTATUS apropriado. Consulte a seção Valor retornado de IoCreateFileEx para obter uma lista de possíveis códigos de retorno.

Observação

FltCreateFileEx pode retornar STATUS_FILE_LOCK_CONFLICT como o valor retornado ou no membro Status da estrutura IO_STATUS_BLOCK apontada pelo parâmetro IoStatusBlock. Isso ocorrerá somente se o arquivo de log NTFS estiver cheio e ocorrer um erro enquanto FltCreateFileEx tentar lidar com essa situação.

Comentários

Os drivers de minifiltro do sistema de arquivos devem chamar FltCreateFileEx em vez de FltCreateFile para obter um ponteiro de objeto de arquivo para uso com rotinas de E/S do FltXxx , como FltReadFile e FltQueryInformationFile.

FltCreateFileEx envia a solicitação de criação somente para as instâncias anexadas abaixo da instância de driver de minifiltro especificada e para o sistema de arquivos. A instância especificada e as instâncias anexadas acima dela não recebem a solicitação de criação. Se nenhuma instância for especificada, a solicitação irá para a parte superior da pilha e será recebida por todas as instâncias e pelo sistema de arquivos.

Há duas maneiras alternativas de especificar o nome do arquivo a ser criado ou aberto com FltCreateFileEx:

Como um nome de caminho totalmente qualificado, fornecido no membro ObjectName do ObjectAttributes de entrada.
Como um nome de caminho relativo ao arquivo de diretório representado pelo identificador no membro RootDirectory do ObjectAttributes de entrada.

Qualquer FileHandle obtido de FltCreateFileEx deve eventualmente ser liberado chamando FltClose. Além disso, qualquer ponteiro FileObject retornado deve ser desreferenciado quando não for mais necessário chamando ObDereferenceObject.

As rotinas de driver que não são executadas no contexto do processo do sistema devem definir o atributo OBJ_KERNEL_HANDLE para o parâmetro ObjectAttributes de FltCreateFileEx. Definir esse atributo restringe o uso do identificador retornado por FltCreateFileEx a processos em execução no modo kernel. Caso contrário, o identificador pode ser acessado pelo processo em cujo contexto o driver está em execução.

Observação

Não chame essa rotina com um valor IRP de nível superior não NULL, pois isso pode causar um deadlock do sistema.

Determinados sinalizadores DesiredAccess e combinações de sinalizadores têm os seguintes efeitos:

Para que um chamador sincronize uma conclusão de E/S aguardando que o FileHandle retornado seja definido como o estado Sinalizado, o sinalizador SYNCHRONIZE deve ser definido.
Se apenas os sinalizadores FILE_APPEND_DATA e SYNCHRONIZE estiverem definidos, o chamador poderá gravar somente no final do arquivo e qualquer informação de deslocamento sobre gravações no arquivo será ignorada. No entanto, o arquivo é estendido automaticamente conforme necessário para esse tipo de operação de gravação.
Definir o sinalizador FILE_WRITE_DATA para um arquivo também permite que as gravações além do final do arquivo ocorram. O arquivo também é estendido automaticamente para esse tipo de gravação.
Se apenas os sinalizadores FILE_EXECUTE e SYNCHRONIZE estiverem definidos, o chamador não poderá usar o FileHandle retornado para ler ou gravar diretamente dados de ou para o arquivo. Ou seja, todas as operações no arquivo devem usar a E/S de paginação do sistema para ler ou gravar dados de arquivo.

O parâmetro ShareAccess determina se threads separados podem acessar o mesmo arquivo, possivelmente simultaneamente. Se ambos os abridores de arquivos tiverem o privilégio de acessar um arquivo da maneira especificada, o arquivo poderá ser aberto e compartilhado com êxito. Se o chamador original de FltCreateFileEx não especificar FILE_SHARE_READ, FILE_SHARE_WRITE ou FILE_SHARE_DELETE, nenhuma outra operação aberta poderá ser executada no arquivo porque o chamador original recebe acesso exclusivo ao arquivo.

Para que um arquivo compartilhado seja aberto com êxito, o DesiredAccess solicitado ao arquivo deve ser compatível com as especificações DesiredAccess e ShareAccess de todas as aberturas anteriores que ainda não foram lançadas com FltClose. Ou seja, o DesiredAccess especificado para FltCreateFileEx para um determinado arquivo não deve entrar em conflito com os acessos que outros abridores do arquivo não permitiram.

Observação

Se IO_IGNORE_SHARE_ACCESS_CHECK for especificado no parâmetro Flags , o gerenciador de E/S ignorará o parâmetro ShareAccess . No entanto, o sistema de arquivos ainda pode executar verificações de acesso. Portanto, é importante especificar o modo de compartilhamento que você deseja para o parâmetro ShareAccess , mesmo ao usar o sinalizador IO_IGNORE_SHARE_ACCESS_CHECK. Além disso, observe que, quando IO_IGNORE_SHARE_ACCESS_CHECK é especificado, o sistema de arquivos não controla o acesso desejado ou o acesso compartilhado do open atual. Por isso, chamadas abertas subsequentes no mesmo arquivo podem ter êxito.

O valor CreateDisposition FILE_SUPERSEDE requer que o chamador tenha acesso DELETE a um objeto de arquivo existente. Nesse caso, uma chamada bem-sucedida para FltCreateFileEx com FILE_SUPERSEDE em um arquivo existente exclui efetivamente esse arquivo e o recria. Isso implica que, se o arquivo já tiver sido aberto por outro thread, ele abriu o arquivo especificando um parâmetro ShareAccess com o sinalizador FILE_SHARE_DELETE definido. Observe que esse tipo de disposição é consistente com o estilo POSIX de substituição de arquivos.

Os valores CreateDisposition FILE_OVERWRITE_IF e FILE_SUPERSEDE são semelhantes. Se FltCreateFileEx for chamado com um arquivo existente e qualquer um desses valores CreateDisposition , o arquivo será substituído.

Substituir um arquivo é semanticamente equivalente a uma operação de substituição, exceto pelo seguinte:

O chamador deve ter acesso de gravação ao arquivo, em vez de excluir o acesso. Isso implica que, se o arquivo já tiver sido aberto por outro thread, ele abriu o arquivo com o sinalizador FILE_SHARE_WRITE definido no ShareAccess de entrada.
Os atributos de arquivo especificados são logicamente ORed com aqueles que já estão no arquivo. Isso implica que, se o arquivo já tiver sido aberto por outro thread, um chamador subsequente de FltCreateFileEx não poderá desabilitar sinalizadores FileAttributes existentes , mas poderá habilitar sinalizadores adicionais para o mesmo arquivo. Observe que esse estilo de substituição de arquivos é consistente com MS-DOS, Windows 3.1 e SO/2.

O valor FILE_DIRECTORY_FILE CreateOptions especifica que o arquivo a ser criado ou aberto é um arquivo de diretório. Quando um arquivo de diretório é criado, o sistema de arquivos cria uma estrutura apropriada no disco para representar um diretório vazio para a estrutura no disco desse sistema de arquivos específico. Se essa opção tiver sido especificada e o arquivo fornecido a ser aberto não for um arquivo de diretório ou se o chamador tiver especificado um valor inconsistente de CreateOptions ou CreateDisposition , a chamada para FltCreateFileEx falhará.

O sinalizador FILE_NO_INTERMEDIATE_BUFFERING CreateOptions impede que o sistema de arquivos execute qualquer buffer intermediário em nome do chamador. Especificar esse valor coloca determinadas restrições nos parâmetros do chamador para outro Flt.. Rotinas de arquivo ou Zw.. Rotinas de arquivo, incluindo o seguinte:

Qualquer valor de Deslocamento de bytes passado para FltReadFile, ZwReadFile, FltWriteFile ou ZwWriteFile deve ser um múltiplo do tamanho do setor.
O Length passado para FltReadFile, ZwReadFile, FltWriteFile ou ZwWriteFile deve ser um múltiplo do tamanho do setor. Observe que especificar uma operação de leitura para um buffer cujo tamanho é exatamente o tamanho do setor pode resultar em menos bytes significativos sendo transferidos para esse buffer se o final do arquivo foi atingido durante a transferência.
Os buffers devem ser alinhados de acordo com o requisito de alinhamento do dispositivo de armazenamento subjacente. Essas informações podem ser obtidas chamando FltCreateFileEx para obter um identificador para o objeto de arquivo que representa o dispositivo físico e, em seguida, chamando ZwQueryInformationFile com esse identificador, especificando FileAlignmentInformation como FileInformationClass. Para obter mais informações sobre os valores FILE_XXX_ALIGNMENT do sistema, definidos em ntifs.h, consulte DEVICE_OBJECT e Inicializando um objeto device.
Chamadas para FltSetInformationFile ou ZwSetInformationFile com o parâmetro FileInformationClass definido como FilePositionInformation devem especificar um deslocamento que seja um múltiplo do tamanho do setor.

As FILE_SYNCHRONOUS_IO_ALERT e FILE_SYNCHRONOUS_IO_NONALERT CreateOptions , que são mutuamente exclusivas como seus nomes sugerem, especificam que o arquivo está sendo aberto para E/S síncrona. Isso significa que todas as operações de E/S no arquivo devem ser síncronas, desde que ocorram por meio do objeto de arquivo ao qual o FileHandle retornado se refere. Todas as E/S em um arquivo desse tipo são serializadas em todos os threads usando o identificador retornado. Com qualquer um desses Conjuntos de CreateOptions , o Gerenciador de E/S mantém o deslocamento de posição do arquivo atual no campo CurrentByteOffset do objeto de arquivo. Esse deslocamento pode ser usado em chamadas para ZwReadFile e ZwWriteFile. Ele também pode ser consultado ou definido chamando ZwQueryInformationFile ou ZwSetInformationFile.

Se o sinalizador CreateOptions FILE_OPEN_REPARSE_POINT não for especificado e FltCreateFileEx tentar abrir um arquivo com um ponto de nova análise, o processamento normal do ponto de nova análise ocorrerá para o arquivo. Se, por outro lado, o sinalizador FILE_OPEN_REPARSE_POINT for especificado, o processamento de nova análise normal não ocorrerá e FltCreateFileEx tentará abrir diretamente o arquivo de ponto de nova análise. Em ambos os casos, se a operação aberta tiver sido bem-sucedida, FltCreateFileEx retornará STATUS_SUCCESS; caso contrário, a rotina retorna um código de erro NTSTATUS. FltCreateFileEx nunca retorna STATUS_REPARSE.

O sinalizador CreateOptions FILE_OPEN_REQUIRING_OPLOCK elimina o tempo entre quando você abre o arquivo e solicita um oplock que poderia potencialmente permitir que terceiros abrissem o arquivo e recebessem uma violação de compartilhamento. Um aplicativo pode usar o sinalizador FILE_OPEN_REQUIRING_OPLOCK em FltCreateFileEx e solicitar qualquer oplock. Isso garante que um proprietário do oplock seja notificado de qualquer solicitação aberta posterior que cause uma violação de compartilhamento.

No Windows 7, se outros identificadores existirem no arquivo quando um aplicativo usar o sinalizador FILE_OPEN_REQUIRING_OPLOCK, a operação de criação falhará com STATUS_OPLOCK_NOT_GRANTED. Essa restrição não existe mais começando com Windows 8.

Se essa operação de criação interromper um oplock que já existe no arquivo, definir o sinalizador FILE_OPEN_REQUIRING_OPLOCK fará com que a operação de criação falhe com STATUS_CANNOT_BREAK_OPLOCK. O oplock existente não será quebrado por essa operação de criação.

Um aplicativo que usa esse sinalizador deve solicitar um oplock depois que essa chamada for bem-sucedida ou todas as tentativas posteriores de abrir o arquivo serão bloqueadas sem o benefício do processamento de oplock típico. Da mesma forma, se essa chamada for bem-sucedida, mas a solicitação oplock posterior falhar, um aplicativo que usa esse sinalizador deverá fechar seu identificador depois de detectar que a solicitação oplock falhou.

Observação

O sinalizador FILE_OPEN_REQUIRING_OPLOCK está disponível nos sistemas operacionais Windows 7, Windows Server 2008 R2 e posteriores do Windows. Os sistemas de arquivos da Microsoft que implementam esse sinalizador no Windows 7 são NTFS, FAT e exFAT.

O sinalizador CreateOptions FILE_RESERVE_OPFILTER permite que um aplicativo solicite um oplock de nível 1, lote ou filtro para impedir que outros aplicativos receberem violações de compartilhamento. No entanto, FILE_RESERVE_OPFILTER só é praticamente útil para oplocks de filtro. Para usá-lo, você deve concluir as seguintes etapas:

Emita uma solicitação de criação com CreateOptions de FILE_RESERVE_OPFILTER, DesiredAccess de exatamente FILE_READ_ATTRIBUTES e ShareAccess de exatamente FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE.
- Se já houver identificadores abertos, a solicitação de criação falhará com STATUS_OPLOCK_NOT_GRANTED e o próximo oplock solicitado também falhará.
- Se você abrir com mais acesso ou menos compartilhamento, também causará uma falha de STATUS_OPLOCK_NOT_GRANTED.
Se a solicitação de criação for bem-sucedida, solicite um oplock.
Abra outro identificador no arquivo para fazer E/S.

A etapa três torna isso prático apenas para oplocks de filtro. O identificador aberto na etapa 3 pode ter um DesiredAccess que contém um máximo de FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | FILE_READ_DATA | FILE_READ_EA | FILE_EXECUTE | SYNCHRONIZE | READ_CONTROL e ainda não quebrar um oplock de filtro. No entanto, qualquer DesiredAccess maior que FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | SYNCHRONIZE interromperá um oplock de nível 1 ou lote e tornará o sinalizador FILE_RESERVE_OPFILTER inútil para esses tipos de oplock.

O NTFS é o único sistema de arquivos da Microsoft que implementa FILE_RESERVE_OPFILTER.

Os drivers de minifiltro devem usar FltSetInformationFile, não ZwSetInformationFile, para renomear um arquivo.

Observação

Se você tentar abrir um volume, mas especificar apenas uma combinação dos sinalizadores a seguir para o parâmetro DesiredAccess , FltCreateFileEx2 abrirá um identificador, independentemente do sistema de arquivos, que tem acesso direto ao dispositivo de armazenamento para o volume.

FILE_READ_ATTRIBUTES
READ_CONTROL
WRITE_DAC
WRITE_OWNER
SYNCHRONIZE

Você não deve usar FltCreateFileEx para abrir um identificador com acesso direto ao dispositivo de armazenamento para o volume ou você vai vazar recursos do sistema. Se você quiser abrir um identificador com acesso direto a um dispositivo de armazenamento, chame a função IoCreateFileEx, IoCreateFileSpecifyDeviceObjectHint ou ZwCreateFile .

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Disponível no Pacote Cumulativo de Atualizações do Microsoft Windows 2000 1 para SP4, Windows XP SP3, Windows Server 2003 SP1 e versões posteriores do sistema operacional Windows.
Plataforma de Destino	Universal
Cabeçalho	fltkernel.h (inclua FltKernel.h)
Biblioteca	Fltmgr.lib
IRQL	PASSIVE_LEVEL