Função IoCreateFileSpecifyDeviceObjectHint (ntddk.h)

A rotina IoCreateFileSpecifyDeviceObjectHint é usada por drivers de filtro do sistema de arquivos para enviar uma solicitação de criação somente para os filtros abaixo de um objeto de dispositivo especificado e para o sistema de arquivos.

Sintaxe

NTSTATUS IoCreateFileSpecifyDeviceObjectHint(
  [out]          PHANDLE            FileHandle,
  [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              Disposition,
  [in]           ULONG              CreateOptions,
  [in, optional] PVOID              EaBuffer,
  [in]           ULONG              EaLength,
  [in]           CREATE_FILE_TYPE   CreateFileType,
  [in, optional] PVOID              InternalParameters,
  [in]           ULONG              Options,
  [in, optional] PVOID              DeviceObject
);

Parâmetros

[out] FileHandle

Um ponteiro para uma variável que recebe um identificador para o objeto de arquivo se essa chamada for bem-sucedida.

[in] DesiredAccess

Uma máscara de bits de sinalizadores que especificam o tipo de acesso que o chamador requer para o arquivo ou diretório. O conjunto de sinalizadores DesiredAccess definidos pelo sistema determina os direitos de acesso específicos a seguir para objetos de arquivo.

Os chamadores de IoCreateFileSpecifyDeviceObjectHint podem especificar uma ou uma combinação do seguinte, possivelmente ORed com sinalizadores compatíveis adicionais da lista anterior de sinalizadoresDesiredAccess , para qualquer objeto de arquivo que não represente um arquivo de diretório:

O STANDARD_RIGHTS_XXX são valores predefinidos do sistema usados para impor a segurança em objetos do sistema.

Se o sinalizador FILE_DIRECTORY_FILE CreateOptions estiver definido, os chamadores de IoCreateFileSpecifyDeviceObjectHint poderão especificar uma ou uma combinação das seguintes opções, possivelmente ORed com um ou mais sinalizadores compatíveis da lista anterior de sinalizadoresDesiredAccess .

Os sinalizadores FILE_READ_DATA, FILE_WRITE_DATA, FILE_EXECUTE e FILE_APPEND_DATA DesiredAccess são incompatíveis com a criação ou abertura de um arquivo de diretório.

[in] ObjectAttributes

Um ponteiro para uma estrutura OBJECT_ATTRIBUTES já inicializada pela rotina InitializeObjectAttributes . Se o chamador estiver em execução no contexto do processo do sistema, esse parâmetro (ObjectAttributes) poderá ser NULL. Caso contrário, o chamador deverá definir o atributo OBJ_KERNEL_HANDLE na chamada para a rotina InitializeObjectAttributes . Os membros da estrutura OBJECT_ATTRIBUTES de um objeto de arquivo incluem o seguinte.

[out] IoStatusBlock

Um ponteiro para uma estrutura IO_STATUS_BLOCK que recebe a status de conclusão final e informações sobre a operação solicitada. No retorno de IoCreateFileSpecifyDeviceObjectHint, o membro Information contém um dos seguintes valores:

• FILE_CREATED

• FILE_OPENED

• FILE_OVERWRITTEN

• FILE_SUPERSEDED

• FILE_EXISTS

• FILE_DOES_NOT_EXIST

[in, optional] AllocationSize

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

[in] FileAttributes

Atributos explicitamente especificados são aplicados somente quando o arquivo é criado, substituído ou, em alguns casos, substituído. Por padrão, esse valor é FILE_ATTRIBUTE_NORMAL, que pode ser substituído por qualquer outro sinalizador ou por uma combinação ORed de sinalizadores compatíveis. Os possíveis sinalizadores FileAttributes incluem o seguinte.

[in] ShareAccess

Especifica o tipo de acesso de compartilhamento ao arquivo que o chamador gostaria, como zero, ou um, ou uma combinação dos sinalizadores a seguir. Para solicitar acesso exclusivo, defina esse parâmetro como zero. Se o sinalizador IO_IGNORE_SHARE_ACCESS_CHECK for especificado no parâmetro Options , o gerenciador de E/S ignorará esse parâmetro. No entanto, o sistema de arquivos ainda pode executar verificações de acesso. Portanto, é importante especificar o modo de compartilhamento que você gostaria para esse parâmetro, mesmo ao usar o sinalizador IO_IGNORE_SHARE_ACCESS_CHECK. Para obter a maior chance de evitar erros de violação de compartilhamento, especifique todos os sinalizadores de acesso de compartilhamento a seguir.

[in] Disposition

Especifica um valor que determina a ação a ser tomada, dependendo se o arquivo já existe. O valor pode ser qualquer um dos descritos a seguir.

[in] CreateOptions

Especifica as opções a serem aplicadas ao criar ou abrir o arquivo. Essas opções são especificadas como uma combinação compatível dos sinalizadores a seguir.

[in, optional] EaBuffer

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

[in] EaLength

O comprimento, em bytes, de EaBuffer.

[in] CreateFileType

Os drivers devem definir esse parâmetro como CreateFileTypeNone.

[in, optional] InternalParameters

Os drivers devem definir esse parâmetro como NULL.

[in] Options

Especifica as opções a serem usadas durante a criação da solicitação de criação. A tabela a seguir lista as opções disponíveis.

[in, optional] DeviceObject

Um ponteiro para o objeto de dispositivo para o qual a solicitação de criação deve ser enviada. O objeto do dispositivo deve ser um objeto de dispositivo de sistema de arquivos ou filtro na pilha de driver do sistema de arquivos para o volume no qual 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 do dispositivo na parte superior da pilha do driver.

Retornar valor

IoCreateFileSpecifyDeviceObjectHint retorna STATUS_SUCCESS ou um valor NTSTATUS apropriado, como um dos seguintes:

IoCreateFileSpecifyDeviceObjectHint 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 IoCreateFileSpecifyDeviceObjectHint tentar lidar com essa situação.

Comentários

Essa rotina é usada por drivers de filtro do sistema de arquivos para enviar uma solicitação de criação somente para os filtros abaixo de um objeto de dispositivo especificado e para o sistema de arquivos. Os filtros anexados acima do objeto de dispositivo especificado na pilha do driver não recebem a solicitação de criação.

A rotina IoCreateFileEx do Windows Vista é semelhante à rotina IoCreateFileSpecifyDeviceObjectHint , mas fornece uma funcionalidade maior do que a rotina IoCreateFileSpecifyDeviceObjectHint , incluindo acesso a parâmetros de criação extra (ECPs) e informações de transação.

Se você usar a rotina IoCreateFileEx em vez da rotina IoCreateFileSpecifyDeviceObjectHint , observe que o parâmetro DriverContext da rotina IoCreateFileSpecifyDeviceObjectHint foi movido para o membro DeviceObjectHint da estrutura IO_DRIVER_CREATE_CONTEXT . A estrutura IO_DRIVER_CREATE_CONTEXT é passada para a rotina IoCreateFileEx por meio de seu parâmetro DriverContext .

Os drivers de filtro do sistema de arquivos chamam IoCreateFileSpecifyDeviceObjectHint para enviar uma solicitação de criação somente para um objeto de dispositivo especificado, os filtros anexados abaixo dele e o sistema de arquivos. Os filtros anexados acima do objeto de dispositivo especificado na pilha do driver não recebem a solicitação de criação. O mesmo vale para qualquer solicitação de limpeza ou fechamento no objeto de arquivo criado por IoCreateFileSpecifyDeviceObjectHint.

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

1. Como um nome de caminho totalmente qualificado, fornecido no membro ObjectName da entrada ObjectAttributes

2. Como um nome de caminho relativo ao arquivo de diretório representado pelo identificador no membro RootDirectory do ObjectAttributes de entrada

Qualquer identificador obtido de IoCreateFileSpecifyDeviceObjectHint deverá eventualmente ser liberado chamando ZwClose.

As rotinas de driver executadas em um contexto de processo diferente do processo do sistema devem definir o atributo OBJ_KERNEL_HANDLE para o parâmetro ObjectAttributes de IoCreateFileSpecifyDeviceObjectHint. Isso restringe o uso do identificador retornado por IoCreateFileSpecifyDeviceObjectHint aos 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.

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 todas as informações de deslocamento sobre gravações no arquivo serão ignoradas. No entanto, o arquivo será automaticamente estendido 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á ler nem gravar dados diretamente no arquivo usando o FileHandle retornado; ou seja, todas as operações no arquivo ocorrem por meio do pager do sistema em resposta a instruções e acessos a dados.

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

Para que um arquivo compartilhado seja aberto com êxito, o DesiredAccess solicitado para o 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 zwClose. Ou seja, o DesiredAccess especificado para IoCreateFileSpecifyDeviceObjectHint para um determinado arquivo não deve entrar em conflito com os acessos que outros abridores do arquivo não permitiram.

Se IO_IGNORE_SHARE_ACCESS_CHECK for especificado no parâmetro Options , o gerente 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ê gostaria para o parâmetro ShareAccess , mesmo ao usar o sinalizador IO_IGNORE_SHARE_ACCESS_CHECK.

O valor disposition FILE_SUPERSEDE requer que o chamador tenha acesso DELETE a um objeto de arquivo existente. Nesse caso, uma chamada bem-sucedida para IoCreateFileSpecifyDeviceObjectHint 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 substituir arquivos.

Os valores disposição FILE_OVERWRITE_IF e FILE_SUPERSEDE são semelhantes. Se IoCreateFileSpecifyDeviceObjectHint for chamado com um arquivo existente e qualquer um desses valores de Disposição , 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 IoCreateFileSpecifyDeviceObjectHint não poderá desabilitar os sinalizadores FileAttributes existentes , mas poderá habilitar sinalizadores adicionais para o mesmo arquivo.

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 Disposition , a chamada para IoCreateFileSpecifyDeviceObjectHint falhará.

O sinalizador CreateOptions FILE_NO_INTERMEDIATE_BUFFERING 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 outros Zw.. Rotinas de arquivo, incluindo o seguinte:

• Qualquer valor de deslocamento de byte passado para ZwReadFile ou ZwWriteFile deve ser um múltiplo do tamanho do setor do dispositivo subjacente.

• O Comprimento passado para ZwReadFile ou ZwWriteFile deve ser um múltiplo do tamanho do setor. Observe que especificar uma operação de leitura para um buffer cujo comprimento é exatamente o tamanho do setor pode resultar em um número menor de 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 subjacente. Essas informações podem ser obtidas chamando IoCreateFileSpecifyDeviceObjectHint para obter um identificador para o objeto de arquivo que representa o dispositivo físico e, em seguida, chamando ZwQueryInformationFile com esse identificador. Para obter uma lista dos valores FILE_XXX_ALIGNMENT do sistema, consulte DEVICE_OBJECT.

• As chamadas para ZwSetInformationFile com o parâmetro FileInformationClass definido como FilePositionInformation devem especificar um deslocamento que seja um múltiplo do tamanho do setor.

As CreateOptions mutuamente exclusivas, FILE_SYNCHRONOUS_IO_ALERT e FILE_SYNCHRONOUS_IO_NONALERT, especificam que todas as operações de E/S no arquivo devem ser síncronas, desde que ocorram por meio do objeto de arquivo referido pelo FileHandle retornado. Toda a E/S em um arquivo desse tipo é serializada em todos os threads usando o identificador retornado. Com qualquer uma dessas CreateOptions, o sinalizador DesiredAccess SYNCHRONIZE deve ser definido para que o Gerenciador de E/S use o objeto de arquivo como um objeto de sincronização. Com qualquer um desses Conjuntos de CreateOptions , o Gerenciador de E/S mantém o "contexto de posição do arquivo" para o objeto de arquivo, um deslocamento de posição de arquivo interno e atual. Esse deslocamento pode ser usado em chamadas para ZwReadFile e ZwWriteFile. Sua posição também pode ser consultada chamando ZwQueryInformationFile ou definida chamando ZwSetInformationFile.

Se o sinalizador CreateOptions FILE_OPEN_REPARSE_POINT não for especificado e IoCreateFileSpecifyDeviceObjectHint 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 normal de nova análise não ocorrerá e IoCreateFileSpecifyDeviceObjectHint tentará abrir diretamente o arquivo de ponto de nova análise. Em ambos os casos, se a operação aberta tiver sido bem-sucedida, IoCreateFileSpecifyDeviceObjectHint retornará STATUS_SUCCESS; caso contrário, a rotina retorna um código de erro NTSTATUS. IoCreateFileSpecifyDeviceObjectHint 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 IoCreateFileSpecifyDeviceObjectHint 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.

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:

1. 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.

2. Se a solicitação de criação for bem-sucedida, solicite um oplock.

3. 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.

IoCreateFileSpecifyDeviceObjectHint não pode ser usado para obter um identificador para um volume.

Se o caminho do nome do arquivo que é passado para IoCreateFileSpecifyDeviceObjectHint contiver um ponto de nova análise, o ponto de nova análise deverá resolve para o mesmo volume em que o arquivo ou diretório reside. Se isso não acontecer, o erro STATUS_INVALID_DEVICE_OBJECT_PARAMETER ou STATUS_MOUNT_POINT_NOT_RESOLVED será retornado.

Requisitos

Confira também

ACCESS_MASK

ACL

FILE_FULL_EA_INFORMATION

IO_DRIVER_CREATE_CONTEXT

InitializeObjectAttributes

IoCheckEaBufferValidity

IoCreateFile

IoCreateFileEx

UNICODE_STRING

ZwClose

ZwCreateFile

ZwQueryInformationFile

ZwReadFile

ZwSetInformationFile

ZwWriteFile