Функция NtCreateFile (ntifs.h)

Подпрограмма NtCreateFile создает новый файл или открывает существующий.

Синтаксис

__kernel_entry NTSYSCALLAPI NTSTATUS NtCreateFile(
  [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              CreateDisposition,
  [in]           ULONG              CreateOptions,
  [in, optional] PVOID              EaBuffer,
  [in]           ULONG              EaLength
);

Параметры

[out] FileHandle

Указатель на переменную HANDLE, которая получает дескриптор файла.

[in] DesiredAccess

Задает значение ACCESS_MASK , определяющее запрошенный доступ к объекту.

Помимо стандартных прав доступа, определенных для всех типов объектов, вызывающий объект может указать любое из следующих конкретных прав доступа: то есть права, относящиеся к файлам.

Вызывающий объект также может указать следующие универсальные права доступа (права, которые применяются ко всем типам объектов, где значение каждого универсального права доступа зависит от типа объекта). Универсальные права доступа для файлового объекта соответствуют определенным правам доступа, как показано в следующей таблице. (Обратите внимание, что "соответствовать" означает "сопоставляется с" и не означает, что значение универсального права "равно" значению побитового или сопоставления его конкретных прав. Диспетчер ввода-вывода определяет фактическое сопоставление.

Например, если указать GENERIC_READ для объекта файла, подпрограмма сопоставляет это значение с FILE_GENERIC_READ битовой маской определенных прав доступа. В предыдущей таблице конкретные права доступа, перечисленные для GENERIC_READ соответствуют (но не равны) флагам доступа, содержащимся в FILE_GENERIC_READ битовой маске.

Если файл фактически является каталогом, вызывающий объект также может указать следующие универсальные права доступа.

Дополнительные сведения о правах доступа см. в разделе ACCESS_MASK и права доступа.

[in] ObjectAttributes

Указатель на структуру OBJECT_ATTRIBUTES , указывающую имя объекта и другие атрибуты. Используйте InitializeObjectAttributes для инициализации этой структуры. Если вызывающий объект не выполняется в контексте системного потока, он должен задать атрибут OBJ_KERNEL_HANDLE при вызове InitializeObjectAttributes.

[out] IoStatusBlock

Указатель на структуру IO_STATUS_BLOCK , которая получает состояние окончательного завершения и другие сведения о запрошенной операции. В частности, элемент Information получает одно из следующих значений:

• FILE_CREATED
• FILE_OPENED
• FILE_OVERWRITTEN
• FILE_SUPERSEDED
• FILE_EXISTS
• FILE_DOES_NOT_EXIST

[in, optional] AllocationSize

Указатель на LARGE_INTEGER, содержащий начальный размер выделения (в байтах) для созданного или перезаписываемого файла. Если значение AllocationSize равно NULL, размер выделения не указан. Если файл не создан или не перезаписан, AllocationSize игнорируется.

[in] FileAttributes

Задает один или несколько флагов FILE_ATTRIBUTE_XXX , которые представляют атрибуты файла, устанавливаемые при создании или перезаписи файла. Вызывающий объект обычно задает FILE_ATTRIBUTE_NORMAL, который задает атрибуты по умолчанию. Список допустимых флагов FILE_ATTRIBUTE_XXX см. в подпрограмме CreateFile документации по Microsoft Windows SDK. Если файл не создается или не перезаписывается, атрибуты FileAttributes игнорируются.

[in] ShareAccess

Тип доступа к общей папке, который указывается как ноль или любое сочетание следующих флагов.

Драйверы устройств и промежуточных водителей обычно устанавливают для ShareAccess нулевое значение, что предоставляет вызывающей объекту монопольный доступ к открытому файлу.

[in] CreateDisposition

Указывает действие, которое необходимо выполнить, если файл существует или не существует. CreateDisposition может быть одним из значений в следующей таблице.

[in] CreateOptions

Задает параметры, применяемые при создании или открытии файла драйвером. Используйте один или несколько флагов в следующей таблице.

[in, optional] EaBuffer

Для драйверов устройств и промежуточных драйверов этот параметр должен быть указателем NULL .

[in] EaLength

Для драйверов устройств и промежуточных драйверов этот параметр должен быть равен нулю.

Возвращаемое значение

NtCreateFile возвращает STATUS_SUCCESS об успешном выполнении или соответствующий код ошибки NTSTATUS при сбое. В последнем случае вызывающий объект может определить причину сбоя, проверив параметр IoStatusBlock .

Комментарии

NtCreateFile предоставляет дескриптор, который вызывающий объект может использовать для управления данными файла или состоянием и атрибутами объекта файла. Дополнительные сведения см. в разделе Использование файлов в драйвере.

Когда дескриптор, на который указывает FileHandle , больше не используется, драйвер должен вызвать NtClose , чтобы закрыть его.

Если вызывающий объект не работает в контексте системного потока, он должен убедиться, что все создаваемые им дескрипторы являются частными. В противном случае дескриптор может получить доступ к процессу, в контексте которого выполняется драйвер. Дополнительные сведения см. в разделе Дескрипторы объектов.

Существует два альтернативных способа указать имя файла, который будет создан или открыт с помощью NtCreateFile:

• В качестве полного имени пути, указанного в элементе ObjectName входного объекта ObjectAttributes.
• Значение pathname относительно файла каталога, представленного дескриптором в элементе RootDirectory входного объекта ObjectAttributes.

Установка определенных флагов в параметре DesiredAccess приводит к следующим последствиям:

• Чтобы вызывающий объект синхронизировать завершение ввода-вывода, ожидая возвращаемого объекта FileHandle, необходимо установить флаг SYNCHRONIZE. В противном случае вызывающий объект, который является устройством или промежуточным драйвером, должен синхронизировать завершение ввода-вывода с помощью объекта события.
• Если вызывающий объект задает только флаги FILE_APPEND_DATA и SYNCHRONIZE, он может выполнять запись только в конец файла, а любые сведения о смещении операций записи в файл игнорируются. Файл будет автоматически расширен по мере необходимости для этого типа операции.
• Установка флага FILE_WRITE_DATA для файла также позволяет вызывающей стороне выполнять запись за пределами конца файла. Опять же, файл автоматически расширяется по мере необходимости.
• Если вызывающий объект задает только флаги FILE_EXECUTE и SYNCHRONIZE, он не может напрямую считывать или записывать данные в файл с помощью возвращенного fileHandle. То есть все операции с файлом выполняются через системный пейджер в ответ на инструкции и операции доступа к данным. Драйверы устройств и промежуточных драйверов не должны устанавливать флаг FILE_EXECUTE.

Параметр ShareAccess определяет, могут ли отдельные потоки получать доступ к одному файлу, возможно, одновременно. При условии, что у обоих вызывающих абонентов есть соответствующие права доступа, файл можно успешно открыть и предоставить к ним общий доступ. Если исходный вызывающий объект NtCreateFile не указывает FILE_SHARE_READ, FILE_SHARE_WRITE или FILE_SHARE_DELETE, другой вызывающий объект не может открыть файл, то есть исходному вызывающему объекту предоставляется монопольный доступ.

Чтобы успешно открыть общий файл, флаги DesiredAccess должны быть совместимы с флагами DesiredAccess и ShareAccess всех предыдущих открытых операций, которые еще не были выпущены через . То есть desiredAccess , указанный в ntCreateFile для данного файла, не должен конфликтовать с доступом, запрещенным другими средствами открытия файла.

Значение CreateDisposition FILE_SUPERSEDE требует, чтобы вызывающий объект был иметь доступ DELETE к существующему объекту файла. Если это так, успешный вызов NtCreateFile с FILE_SUPERSEDE в существующем файле фактически удаляет этот файл, а затем повторно создает его. Это означает, что, если файл уже был открыт другим потоком, он открыл файл, указав параметр ShareAccess с флагом FILE_SHARE_DELETE. Обратите внимание, что этот тип ликвидации согласуется со стилем POSIX для перезаписи файлов.

Значения CreateDisposition FILE_OVERWRITE_IF и FILE_SUPERSEDE похожи. Если ntCreateFile вызывается с существующим файлом и любое из этих значений CreateDisposition , файл будет заменен.

Перезапись файла семантически эквивалентна операции замены, за исключением следующих:

• Вызывающий объект должен иметь доступ на запись к файлу, а не доступ к удалению. Это означает, что, если файл уже открыт другим потоком, он открыл файл с флагом FILE_SHARE_WRITE, установленным во входных данных ShareAccess.
• Указанные атрибуты файла логически определяются вместе с атрибутами, уже имеющимися в файле. Это означает, что, если файл уже был открыт другим потоком, последующий вызывающий объект NtCreateFile не может отключить существующие флаги FileAttributes , но может включить дополнительные флаги для того же файла. Обратите внимание, что этот стиль перезаписи файлов согласуется с MS-DOS, Microsoft Windows 3.1 и OS/2.

Значение FILE_DIRECTORY_FILE CreateOptions указывает, что создаваемый или открытый файл является каталогом. При создании файла каталога файловая система создает соответствующую структуру на диске, чтобы представлять пустой каталог для структуры на диске конкретной файловой системы. Если этот параметр был указан и файл, который необходимо открыть, не является файлом каталога или если вызывающий объект указал несогласованное значение CreateOptions или CreateDisposition , вызов NtCreateFile завершится ошибкой.

Флаг createOptions FILE_NO_INTERMEDIATE_BUFFERING запрещает файловой системе выполнять промежуточную буферизацию от имени вызывающего объекта. Если указать этот флаг, следующие ограничения на параметры вызывающего объекта накладывается на другие подпрограммы ZwXxxFile .

• Любой необязательный параметр ByteOffset , передаваемый в NtReadFile или NtWriteFile, должен быть кратным размеру сектора.
• Длина, передаваемая в NtReadFile или NtWriteFile, должна быть целой частью размера сектора. Обратите внимание, что указание операции чтения в буфер, длина которого точно равна размеру сектора, может привести к меньшему числу значительных байтов, передаваемых в этот буфер, если во время передачи был достигнут конец файла.
• Буферы должны быть выровнены в соответствии с требованиями выравнивания базового устройства. Чтобы получить эти сведения, вызовите NtCreateFile , чтобы получить дескриптор для объекта файла, представляющего физическое устройство, и передайте этот дескриптор в NtQueryInformationFile. Список системных значений FILE_XXX_ALIGNMENT см. в разделе DEVICE_OBJECT.
• Вызовы NtSetInformationFile с параметром FileInformationClass , равным FilePositionInformation, должны указывать смещение, кратное размеру сектора.

Флаги FILE_SYNCHRONOUS_IO_ALERT и FILE_SYNCHRONOUS_IO_NONALERT CreateOptions (которые являются взаимоисключающими) указывают, что все операции ввода-вывода с файлом будут синхронными, если операции выполняются через объект file, на который ссылается возвращаемый FileHandle. Все операции ввода-вывода в таком файле сериализуются во всех потоках с помощью возвращенного дескриптора. Если задан любой из этих флагов CreateOptions , необходимо также установить флаг SYNCHRONIZE DesiredAccess , чтобы заставить диспетчер ввода-вывода использовать файловый объект в качестве объекта синхронизации. В таких случаях диспетчер ввода-вывода отслеживает текущее смещение позиции файла, которое можно передать в NtReadFile и NtWriteFile. Вызовите NtQueryInformationFile или NtSetInformationFile , чтобы получить или задать эту позицию.

Если флаг createOptions FILE_OPEN_REPARSE_POINT не задан и NtCreateFile пытается открыть файл с точкой повторного обработки, для файла выполняется обычная обработка точки повторного вычисления. Если, с другой стороны, указан флаг FILE_OPEN_REPARSE_POINT, обычная обработка повторного вычисления не выполняется, и NtCreateFile пытается открыть файл точки повторного вычисления напрямую. В любом случае, если операция открытия прошла успешно, NtCreateFile возвращает STATUS_SUCCESS; В противном случае подпрограмма возвращает код ошибки NTSTATUS. NtCreateFile никогда не возвращает STATUS_REPARSE.

Флаг CreateOptions FILE_OPEN_REQUIRING_OPLOCK исключает время между открытием файла и запросом блокировки операции, которая потенциально может позволить третьей стороне открыть файл и получить нарушение общего доступа. Приложение может использовать флаг FILE_OPEN_REQUIRING_OPLOCK в NtCreateFile , а затем запросить любой oplock. Это гарантирует, что владелец oplock будет уведомлен о любом последующем открытом запросе, который вызывает нарушение общего доступа.

В Windows 7, если в файле существуют другие дескрипторы, когда приложение использует флаг FILE_OPEN_REQUIRING_OPLOCK, операция создания завершится сбоем с STATUS_OPLOCK_NOT_GRANTED. Это ограничение больше не существует, начиная с Windows 8.

Если эта операция создания приведет к прерыванию блокировки операции, которая уже существует в файле, установка флага FILE_OPEN_REQUIRING_OPLOCK приведет к сбою операции создания с STATUS_CANNOT_BREAK_OPLOCK. Существующая блокировка не будет нарушена этой операцией создания.

Приложение, использующее флаг FILE_OPEN_REQUIRING_OPLOCK, должно запросить блокировку после успешного вызова, иначе все последующие попытки открыть файл будут заблокированы без обычной обработки блокировки. Аналогичным образом, если этот вызов завершается успешно, но последующий запрос oplock завершается ошибкой, приложение, использующее этот флаг, должно закрыть свой дескриптор после обнаружения сбоя запроса oplock.

Флаг CreateOptions FILE_RESERVE_OPFILTER позволяет приложению запрашивать блокировку уровня 1, пакетной службы или фильтра, чтобы другие приложения не получали нарушения общего доступа. Однако FILE_RESERVE_OPFILTER практически полезно только для операций фильтрации. Чтобы использовать его, необходимо выполнить следующие действия.

1. Отправьте запрос на создание с параметром CreateOptions FILE_RESERVE_OPFILTER, DesiredAccess точно FILE_READ_ATTRIBUTES и ShareAccess точно FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE.
   • Если дескрипторы уже открыты, запрос на создание завершается ошибкой с STATUS_OPLOCK_NOT_GRANTED, а следующая запрошенная блокировка также завершается ошибкой.
   • При открытии с большим доступом или меньшим общим доступом также произойдет сбой STATUS_OPLOCK_NOT_GRANTED.
2. Если запрос на создание выполнен успешно, запросите блокировку операции.
3. Откройте другой дескриптор файла для выполнения операций ввода-вывода.

Шаг 3 делает это практичным только для фильтрации блокировок. Дескриптор, открытый на шаге 3, может иметь desiredAccess , который содержит не более FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | FILE_READ_DATA | FILE_READ_EA | FILE_EXECUTE | SYNCHRONIZE | READ_CONTROL и по-прежнему не прерывает блокировку фильтра. Однако любой объект DesiredAccess больше FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | Функция SYNCHRONIZE разорвёт блокировку на уровне 1 или пакетной службе и сделает флаг FILE_RESERVE_OPFILTER бесполезным для этих типов oplock.

NTFS — единственная файловая система Майкрософт, реализующая FILE_RESERVE_OPFILTER.

Для флага CreateOptions FILE_OPEN_BY_FILE_ID пример имени устройства будет иметь следующий формат:

\??\C:\<FileID>
\device\HardDiskVolume1\<ObjectID>

Где FileID — 8 байт, а ObjectID — 16 байт:

• В NTFS это может быть 8-байтовый или 16-байтовый номер ссылки или идентификатор объекта. 16-байтовое ссылочный номер совпадает с 8-байтным числом, заполненным нулями.
• В ReFS это может быть 8-байтовый или 16-байтовый ссылочный номер. 16-байтовое число не связано с 8-байтным числом. Идентификаторы объектов не поддерживаются.
• Файловые системы FAT, ExFAT, UDFS и CDFS не поддерживают флаг FILE_OPEN_BY_FILE_ID.

Этот номер присваивается и зависит от конкретной файловой системы. Так как поле имени файла будет частично содержать двоичный BLOB-объект, неправильно предполагать, что это допустимая строка Юникода, и что более важно, может не быть строкой, завершающейся null.

Вызывающие объект NtCreateFile должны выполняться в IRQL = PASSIVE_LEVEL и с включенными специальными APC ядра.

Для вызовов из драйверов режима ядра версии NtXxx и ZwXxx подпрограммы собственных системных служб Windows могут вести себя по-разному, так как они обрабатывают и интерпретируют входные параметры. Дополнительные сведения о связи между версиями процедуры NtXxx и ZwXxx см. в разделе Использование версий Nt и Zw для процедур собственных системных служб.

Требования

См. также раздел

ACCESS_MASK

DEVICE_OBJECT

EXTENDED_CREATE_INFORMATION

IO_STATUS_BLOCK

InitializeObjectAttributes

NtClose

NtOpenFile

NtQueryInformationFile

NtReadFile

NtSetInformationFile

NtWriteFile