Функция CreateFileMappingA (winbase.h)
Создает или открывает именованный или неименованный объект сопоставления файлов для указанного файла.
Сведения об указании узла NUMA для физической памяти см. в разделе CreateFileMappingNuma.
Синтаксис
HANDLE CreateFileMappingA(
[in] HANDLE hFile,
[in, optional] LPSECURITY_ATTRIBUTES lpFileMappingAttributes,
[in] DWORD flProtect,
[in] DWORD dwMaximumSizeHigh,
[in] DWORD dwMaximumSizeLow,
[in, optional] LPCSTR lpName
);
Параметры
[in] hFile
Дескриптор файла, из которого создается объект сопоставления файлов.
Файл должен быть открыт с правами доступа, совместимыми с флагами защиты, указанными параметром flProtect . Это не обязательно, но рекомендуется открывать файлы, которые планируется сопоставить, для монопольного доступа. Дополнительные сведения см. в разделе Безопасность файлов и права доступа.
Если hFileINVALID_HANDLE_VALUE, вызывающий процесс должен также указать размер объекта сопоставления файлов в параметрах dwMaximumSizeHigh и dwMaximumSizeLow . В этом сценарии CreateFileMapping создает объект сопоставления файлов указанного размера, который поддерживается системным файлом подкачки, а не файлом в файловой системе.
[in, optional] lpFileMappingAttributes
Указатель на структуру SECURITY_ATTRIBUTES , которая определяет, может ли возвращаемый дескриптор наследоваться дочерними процессами. Член lpSecurityDescriptor структуры SECURITY_ATTRIBUTES задает дескриптор безопасности для нового объекта сопоставления файлов.
Если lpFileMappingAttributes имеет значение NULL, дескриптор не может быть унаследован, а объект сопоставления файлов получает дескриптор безопасности по умолчанию. Списки управления доступом (ACL) в дескрипторе безопасности по умолчанию для объекта сопоставления файлов поступают из основного маркера или маркера олицетворения создателя. Дополнительные сведения см. в разделе Безопасность сопоставления файлов и права доступа.
[in] flProtect
Задает защиту страницы объекта сопоставления файлов. Все сопоставленные представления объекта должны быть совместимы с этой защитой.
Этот параметр может принимать одно из указанных ниже значений.
Приложение может указать один или несколько следующих атрибутов для объекта сопоставления файлов, объединяя их с одним из предыдущих значений защиты страниц.
| Значение | Значение |
|---|---|
|
Если объект сопоставления файлов поддерживается файлом подкачки операционной системы (параметр hfileINVALID_HANDLE_VALUE), указывает, что при сопоставлении представления файла с адресным пространством процесса весь диапазон страниц фиксируется, а не резервируется. Система должна иметь достаточно зафиксируемых страниц для хранения всего сопоставления. В противном случае createFileMapping завершается ошибкой .
Этот атрибут не влияет на объекты сопоставления файлов, которые поддерживаются исполняемыми файлами изображений или файлами данных (параметр hfile является дескриптором файла). SEC_COMMIT нельзя сочетать с SEC_RESERVE. Если атрибут не указан, предполагается SEC_COMMIT . |
|
Указывает, что файл, который указывает параметр hFile , является исполняемым файлом образа.
Атрибут SEC_IMAGE должен быть объединён со значением защиты страницы, например PAGE_READONLY. Однако это значение защиты страницы не влияет на представления исполняемого файла образа. Защита страниц для представлений исполняемого файла образа определяется самим исполняемым файлом. Никакие другие атрибуты не являются допустимыми для SEC_IMAGE. |
|
Указывает, что файл, который указывает параметр hFile , является исполняемым файлом образа, который не будет выполняться, а загруженный файл образа не будет выполняться принудительной проверки целостности.
Кроме того, сопоставление представления объекта сопоставления файлов, созданного с помощью атрибута SEC_IMAGE_NO_EXECUTE , не будет вызывать обратные вызовы драйвера, зарегистрированные с помощью API ядра PsSetLoadImageNotifyRoutine .
Атрибут SEC_IMAGE_NO_EXECUTE должен быть объединён со значением защиты страницы PAGE_READONLY . Никакие другие атрибуты не являются допустимыми для SEC_IMAGE_NO_EXECUTE. Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 и Windows XP: Это значение не поддерживается до Windows Server 2012 и Windows 8. |
|
Позволяет использовать большие страницы для объектов сопоставления файлов, которые поддерживаются файлом подкачки операционной системы (параметр hfileINVALID_HANDLE_VALUE). Этот атрибут не поддерживается для объектов сопоставления файлов, которые поддерживаются исполняемыми файлами изображений или файлами данных (параметр hFile — это дескриптор исполняемого изображения или файла данных).
Максимальный размер объекта сопоставления файлов должен быть кратным минимальному размеру большой страницы, возвращаемой функцией GetLargePageMinimum . Если это не так, createFileMapping завершается ошибкой . При сопоставлении представления объекта сопоставления файлов, созданного с помощью SEC_LARGE_PAGES, базовый адрес и размер представления также должны быть кратными минимальному большому размеру страницы. SEC_LARGE_PAGES требует, чтобы в токене вызывающего объекта была включена привилегия SeLockMemoryPrivilege . Если указан SEC_LARGE_PAGES , необходимо также указать SEC_COMMIT . Windows Server 2003: Это значение не поддерживается до Windows Server 2003 с пакетом обновления 1 (SP1). Windows XP: Это значение не поддерживается. |
|
Задает все страницы, которые не кэшируются.
Приложения не должны использовать этот атрибут, за исключением случаев, когда это явно необходимо для устройства. Использование взаимосвязанных функций с памятью, сопоставленной с SEC_NOCACHE , может привести к EXCEPTION_ILLEGAL_INSTRUCTION исключению. SEC_NOCACHE требуется задать атрибут SEC_RESERVE или SEC_COMMIT . |
|
Если объект сопоставления файлов поддерживается файлом подкачки операционной системы (параметр hfile — INVALID_HANDLE_VALUE), указывает, что при сопоставлении представления файла с адресным пространством процесса весь диапазон страниц резервируется для последующего использования процессом, а не фиксируется.
Зарезервированные страницы можно зафиксировать в последующих вызовах функции VirtualAlloc . После фиксации страницы не могут быть освобождены или списаны с помощью функции VirtualFree . Этот атрибут не влияет на объекты сопоставления файлов, которые поддерживаются исполняемыми файлами изображений или файлами данных (параметр hfile является дескриптором файла). SEC_RESERVE нельзя сочетать с SEC_COMMIT. |
|
Задает все страницы для объединения записей.
Приложения не должны использовать этот атрибут, за исключением случаев, когда это явно требуется для устройства. Использование заблокированных функций с памятью, сопоставленной с SEC_WRITECOMBINE , может привести к EXCEPTION_ILLEGAL_INSTRUCTION исключению. SEC_WRITECOMBINE требуется задать атрибут SEC_RESERVE или SEC_COMMIT . Windows Server 2003 и Windows XP: Этот флаг не поддерживается до Windows Vista. |
[in] dwMaximumSizeHigh
DWORD высокого порядка максимального размера объекта сопоставления файлов.
[in] dwMaximumSizeLow
DWORD нижнего порядка максимального размера объекта сопоставления файлов.
Если этот параметр и dwMaximumSizeHigh имеют значение 0 (ноль), максимальный размер объекта сопоставления файлов равен текущему размеру файла, определяемого hFile .
Попытка сопоставить файл длиной 0 (ноль) завершается ошибкой с кодом ERROR_FILE_INVALID. Приложения должны тестировать файлы длиной 0 (ноль) и отклонять эти файлы.
[in, optional] lpName
Имя объекта сопоставления файлов.
Если этот параметр соответствует имени существующего объекта сопоставления, функция запрашивает доступ к объекту с защитой, указанной flProtect .
Если этот параметр имеет значение NULL, объект сопоставления файлов создается без имени.
Если lpName соответствует имени существующего события, семафора, мьютекса, таймера ожидания или объекта задания, функция завершается ошибкой, а функция GetLastError возвращает ERROR_INVALID_HANDLE. Это происходит потому, что эти объекты используют одно и то же пространство имен.
Имя может иметь префикс "Global" или "Local" для явного создания объекта в глобальном пространстве имен или пространстве имен сеанса. Оставшаяся часть имени может содержать любой символ, кроме символа обратной косой черты (\). Для создания объекта сопоставления файлов в глобальном пространстве имен из сеанса, отличного от нулевого сеанса, требуется привилегия SeCreateGlobalPrivilege . Дополнительные сведения см. в разделе Пространства имен объектов ядра.
Быстрое переключение пользователей реализуется с помощью сеансов служб терминалов. Первый пользователь для входа использует сеанс 0 (ноль), следующий пользователь для входа использует сеанс 1 (один) и т. д. Имена объектов ядра должны соответствовать рекомендациям, приведенным для служб терминалов, чтобы приложения могли поддерживать нескольких пользователей.
Возвращаемое значение
Если функция выполняется успешно, возвращаемое значение представляет собой дескриптор созданного объекта сопоставления файлов.
Если объект существует до вызова функции, функция возвращает дескриптор существующему объекту (с его текущим размером, а не указанным размером), а GetLastError возвращает ERROR_ALREADY_EXISTS.
Если функция завершается сбоем, возвращается значение NULL. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.
Комментарии
После создания объекта сопоставления файлов размер файла не должен превышать размер объекта сопоставления файлов; Если это так, не все содержимое файла доступно для общего доступа.
Если приложение указывает размер объекта сопоставления файлов, превышающий размер фактического именованного файла на диске и если защита страницы разрешает доступ на запись (то есть параметр flProtect указывает PAGE_READWRITE или PAGE_EXECUTE_READWRITE), файл на диске увеличивается до указанного размера объекта сопоставления файлов. Если файл расширен, содержимое файла между старым и новым концами файла не гарантируется равным нулю; поведение определяется файловой системой. Если файл на диске не может быть увеличен, createFileMapping завершается сбоем и GetLastError возвращает ERROR_DISK_FULL.
Начальное содержимое страниц в объекте сопоставления файлов, поддерживаемом файлом подкачки операционной системы, равно 0 (ноль).
Дескриптор, возвращаемый CreateFileMapping , имеет полный доступ к новому объекту сопоставления файлов и может использоваться с любой функцией, требующей дескриптора для объекта сопоставления файлов.
Несколько процессов могут совместно использовать представление одного файла, используя один объект сопоставления общих файлов или создавая отдельные объекты сопоставления файлов, поддерживаемые одним файлом. Один объект сопоставления файлов может совместно использоваться несколькими процессами путем наследования дескриптора при создании процесса, дублирования дескриптора или открытия объекта сопоставления файлов по имени. Дополнительные сведения см. в разделе Функции CreateProcess, DuplicateHandle и OpenFileMapping .
Создание объекта сопоставления файлов фактически не сопоставляет представление с адресным пространством процесса. Функции MapViewOfFile и MapViewOfFileEx сопоставляют представление файла с адресным пространством процесса.
За одним важным исключением, представления файлов, производные от любого объекта сопоставления файлов, который поддерживается одним и тем же файлом, являются согласованными или идентичными в определенный момент времени. Когерентность гарантируется для представлений в рамках процесса и для представлений, сопоставленных различными процессами.
Исключение связано с удаленными файлами. Хотя CreateFileMapping работает с удаленными файлами, она не поддерживает их согласованность. Например, если два компьютера сопоставляют файл как доступный для записи, и оба изменяют одну и ту же страницу, каждый компьютер видит только собственные записи на страницу. При обновлении данных на диске они не объединяются.
Сопоставленный файл и файл, к которому осуществляется доступ с помощью функций ввода-вывода (ReadFile и WriteFile), не обязательно являются согласованными.
Сопоставленные представления объекта сопоставления файлов сохраняют внутренние ссылки на объект, а объект сопоставления файлов не закрывается до тех пор, пока не будут освобождены все ссылки на него. Таким образом, чтобы полностью закрыть объект сопоставления файлов, приложение должно отменить сопоставление всех сопоставленных представлений объекта сопоставления файлов путем вызова UnmapViewOfFile и закрыть дескриптор объекта сопоставления файлов, вызвав CloseHandle. Эти функции можно вызывать в любом порядке.
При изменении файла с помощью сопоставленного представления метка времени последнего изменения может не обновляться автоматически. При необходимости вызывающий объект должен использовать SetFileTime для задания метки времени.
Для создания объекта сопоставления файлов в глобальном пространстве имен из сеанса, отличного от нулевого сеанса, требуется привилегия SeCreateGlobalPrivilege . Обратите внимание, что эта привилегия проверка ограничена созданием объектов сопоставления файлов и не применяется к открытию существующих объектов. Например, если служба или система создает объект сопоставления файлов в глобальном пространстве имен, любой процесс, выполняющийся в любом сеансе, может получить доступ к объекту сопоставления файлов при условии, что вызывающий объект имеет необходимые права доступа.
Windows XP: Требование, описанное в предыдущем абзаце, появилось в Windows Server 2003 и Windows XP с пакетом обновления 2 (SP2)
Используйте структурированную обработку исключений для защиты любого кода, который записывает или считывает из представления файлов. Дополнительные сведения см. в разделе Чтение и запись из представления файлов.
Чтобы иметь сопоставление с разрешениями исполняемого файла, приложение должно вызвать CreateFileMapping с PAGE_EXECUTE_READWRITE или PAGE_EXECUTE_READ, а затем вызвать MapViewOfFile с FILE_MAP_EXECUTE | FILE_MAP_WRITE или FILE_MAP_EXECUTE | FILE_MAP_READ.
В Windows Server 2012 эта функция поддерживается следующими технологиями.
| Технология | Поддерживается |
|---|---|
| Протокол SMB 3.0 | Да |
| SMB 3.0 Transparent Failover (TFO) | Да |
| SMB 3.0 с масштабируемыми общими папками (SO) | Да |
| Файловая система общего тома кластера (CSVFS) | Да |
| Восстанавливаемая файловая система (ReFS) | Да |
Примеры
Пример см. в разделе Создание именованной общей памяти или Создание сопоставления файлов с использованием больших страниц.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows XP [только классические приложения] |
| Минимальная версия сервера | Windows Server 2003 [только классические приложения] |
| Целевая платформа | Windows |
| Header | winbase.h (включая Windows.h, Memoryapi.h) |
| Библиотека | Kernel32.lib |
| DLL | Kernel32.dll |
См. также
Создание объекта сопоставления файлов
Функции сопоставления файлов