os.stat fails for block devices such as //./PhysicalDrive0

[eryksun]

BPO	38030
Nosy	@pfmoore, @tjguk, @zware, @eryksun, @zooba, @miss-islington
PRs	bpo-38030: Fix os.stat failures on block devices on Windows #15681 [3.8] bpo-38030: Fix os.stat failures on block devices on Windows (GH-15681) #15682

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/zooba'
closed_at = <Date 2019-09-04.22:18:27.827>
created_at = <Date 2019-09-04.20:26:32.107>
labels = ['type-bug', '3.8', 'expert-IO', 'OS-windows', '3.9']
title = 'os.stat fails for block devices such as //./PhysicalDrive0'
updated_at = <Date 2019-09-04.22:18:27.826>
user = 'https://github.com/eryksun'

bugs.python.org fields:

activity = <Date 2019-09-04.22:18:27.826>
actor = 'steve.dower'
assignee = 'steve.dower'
closed = True
closed_date = <Date 2019-09-04.22:18:27.827>
closer = 'steve.dower'
components = ['Windows', 'IO']
creation = <Date 2019-09-04.20:26:32.107>
creator = 'eryksun'
dependencies = []
files = []
hgrepos = []
issue_num = 38030
keywords = ['patch']
message_count = 3.0
messages = ['351149', '351151', '351152']
nosy_count = 6.0
nosy_names = ['paul.moore', 'tim.golden', 'zach.ware', 'eryksun', 'steve.dower', 'miss-islington']
pr_nums = ['15681', '15682']
priority = 'high'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue38030'
versions = ['Python 3.8', 'Python 3.9']

[eryksun]

In bpo-37834, I posted a suggest implementation of win32_xstat_impl that included the following snippet of code:

        if (!GetFileInformationByHandle(hFile, &fileInfo)) {
            error = GetLastError();
            if (error != ERROR_INVALID_PARAMETER &&
                error != ERROR_INVALID_FUNCTION &&
                error != ERROR_NOT_SUPPORTED) {
                retval = -1;
                goto cleanup;
            }
            /* Volumes and physical disks are block devices, e.g.
               \\.\C: and \\.\PhysicalDrive0. */
            memset(result, 0, sizeof(*result));
            result->st_mode = 0x6000; /* S_IFBLK */
            goto cleanup;
        }

This is meant to handle the above errors. We know we have FILE_TYPE_DISK. If GetFileInformationByHandle fails with one of the above error codes, then we must have a disk or volume device without a mounted file-system device. This should be reported as a block device.

However it was changed in the final version as follows:

        if (!GetFileInformationByHandle(hFile, &fileInfo)) {
            switch (GetLastError()) {
            case ERROR_INVALID_PARAMETER:
            case ERROR_INVALID_FUNCTION:
            case ERROR_NOT_SUPPORTED:
                retval = -1;
                goto cleanup;
            }
            /* Volumes and physical disks are block devices, e.g.
               \\.\C: and \\.\PhysicalDrive0. */
            memset(result, 0, sizeof(*result));
            result->st_mode = 0x6000; /* S_IFBLK */
            goto cleanup;
        }

Now it's failing on the errors that should be handled, and succeeding on all other errors that should fail. If we want to use a switch statement here, I suggest the following:

        if (!GetFileInformationByHandle(hFile, &fileInfo)) {
            switch (GetLastError()) {
            case ERROR_INVALID_PARAMETER:
            case ERROR_INVALID_FUNCTION:
            case ERROR_NOT_SUPPORTED:
                /* Volumes and physical disks are block devices, e.g.
                   \\.\C: and \\.\PhysicalDrive0. */
                memset(result, 0, sizeof(*result));
                result->st_mode = 0x6000; /* S_IFBLK */
                goto cleanup;
            }
            retval = -1;
            goto cleanup;
        }

[zooba]

New changeset 772ec0f by Steve Dower in branch 'master':
bpo-38030: Fix os.stat failures on block devices on Windows (GH-15681)
772ec0f

[miss-islington]

New changeset cad7abf by Miss Islington (bot) in branch '3.8':
bpo-38030: Fix os.stat failures on block devices on Windows (GH-15681)
cad7abf