summaryrefslogtreecommitdiff
path: root/vcl/inc/driverblocklist.hxx
blob: f3fc81c6642d03a47cca18db90903e378d1954d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#ifndef INCLUDED_VCL_DRIVERBLOCKLIST_HXX
#define INCLUDED_VCL_DRIVERBLOCKLIST_HXX

#include <vcl/dllapi.h>
#include <xmlreader/xmlreader.hxx>

#include <string_view>
#include <vector>

namespace DriverBlocklist
{
// Details of how to treat a version number.
enum class VersionType
{
    OpenGL, // a.b.c.d, 1.98 > 1.978
    Vulkan // a.b.c , 1.98 < 1.978
};

VCL_DLLPUBLIC bool IsDeviceBlocked(const OUString& blocklistURL, VersionType versionType,
                                   std::u16string_view driverVersion, std::u16string_view vendorId,
                                   const OUString& deviceId);

#ifdef _WIN32
VCL_DLLPUBLIC int32_t GetWindowsVersion();
#endif

enum DeviceVendor
{
    VendorAll,
    VendorIntel,
    VendorNVIDIA,
    VendorAMD,
    VendorMicrosoft,
};
const int DeviceVendorMax = VendorMicrosoft + 1;

/// Returns vendor for the given vendor ID, or VendorAll if not known.
VCL_DLLPUBLIC DeviceVendor GetVendorFromId(uint32_t id);

VCL_DLLPUBLIC std::string_view GetVendorNameFromId(uint32_t id);

// The rest should be private (only for the unittest).

struct InvalidFileException
{
};

enum OperatingSystem
{
    DRIVER_OS_UNKNOWN = 0,
    DRIVER_OS_WINDOWS_FIRST,
    DRIVER_OS_WINDOWS_7 = DRIVER_OS_WINDOWS_FIRST,
    DRIVER_OS_WINDOWS_8,
    DRIVER_OS_WINDOWS_8_1,
    DRIVER_OS_WINDOWS_10,
    DRIVER_OS_WINDOWS_LAST = DRIVER_OS_WINDOWS_10,
    DRIVER_OS_WINDOWS_ALL,
    DRIVER_OS_LINUX,
    DRIVER_OS_OSX_FIRST,
    DRIVER_OS_OSX_10_5 = DRIVER_OS_OSX_FIRST,
    DRIVER_OS_OSX_10_6,
    DRIVER_OS_OSX_10_7,
    DRIVER_OS_OSX_10_8,
    DRIVER_OS_OSX_LAST = DRIVER_OS_OSX_10_8,
    DRIVER_OS_OSX_ALL,
    DRIVER_OS_ANDROID,
    DRIVER_OS_ALL
};

enum VersionComparisonOp
{
    DRIVER_LESS_THAN, // driver <  version
    DRIVER_LESS_THAN_OR_EQUAL, // driver <= version
    DRIVER_GREATER_THAN, // driver >  version
    DRIVER_GREATER_THAN_OR_EQUAL, // driver >= version
    DRIVER_EQUAL, // driver == version
    DRIVER_NOT_EQUAL, // driver != version
    DRIVER_BETWEEN_EXCLUSIVE, // driver > version && driver < versionMax
    DRIVER_BETWEEN_INCLUSIVE, // driver >= version && driver <= versionMax
    DRIVER_BETWEEN_INCLUSIVE_START, // driver >= version && driver < versionMax
    DRIVER_COMPARISON_IGNORED
};

struct DriverInfo
{
    DriverInfo(OperatingSystem os, OUString vendor, VersionComparisonOp op, uint64_t driverVersion,
               bool bAllowListed = false, const char* suggestedVersion = nullptr);

    DriverInfo();

    OperatingSystem meOperatingSystem;
    OUString maAdapterVendor;
    std::vector<OUString> maDevices;

    bool mbAllowlisted;

    VersionComparisonOp meComparisonOp;

    /* versions are assumed to be A.B.C.D packed as 0xAAAABBBBCCCCDDDD */
    uint64_t mnDriverVersion;
    uint64_t mnDriverVersionMax;

    OUString maSuggestedVersion;
    OUString maMsg;
};

class VCL_DLLPUBLIC Parser
{
public:
    Parser(OUString aURL, std::vector<DriverInfo>& rDriverList, VersionType versionType);
    bool parse();

private:
    void handleEntry(DriverInfo& rDriver, xmlreader::XmlReader& rReader);
    void handleList(xmlreader::XmlReader& rReader);
    void handleContent(xmlreader::XmlReader& rReader);
    static void handleDevices(DriverInfo& rDriver, xmlreader::XmlReader& rReader);
    uint64_t getVersion(std::string_view rString);

    enum class BlockType
    {
        ALLOWLIST,
        DENYLIST,
        UNKNOWN
    };

    BlockType meBlockType;
    std::vector<DriverInfo>& mrDriverList;
    OUString maURL;
    const VersionType mVersionType;
};

OUString VCL_DLLPUBLIC GetVendorId(DeviceVendor id);

bool VCL_DLLPUBLIC FindBlocklistedDeviceInList(std::vector<DriverInfo>& aDeviceInfos,
                                               VersionType versionType,
                                               std::u16string_view sDriverVersion,
                                               std::u16string_view sAdapterVendorID,
                                               OUString const& sAdapterDeviceID,
                                               OperatingSystem system,
                                               const OUString& blocklistURL = OUString());

#define GFX_DRIVER_VERSION(a, b, c, d)                                                             \
    ((uint64_t(a) << 48) | (uint64_t(b) << 32) | (uint64_t(c) << 16) | uint64_t(d))

inline uint64_t OpenGLVersion(uint32_t a, uint32_t b, uint32_t c, uint32_t d)
{
    // We make sure every driver number is padded by 0s, this will allow us the
    // easiest 'compare as if decimals' approach. See ParseDriverVersion for a
    // more extensive explanation of this approach.
    while (b > 0 && b < 1000)
    {
        b *= 10;
    }
    while (c > 0 && c < 1000)
    {
        c *= 10;
    }
    while (d > 0 && d < 1000)
    {
        d *= 10;
    }
    return GFX_DRIVER_VERSION(a, b, c, d);
}

} // namespace

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */