File: ioctl_helper_xe_perf.cpp

package info (click to toggle)
intel-compute-runtime 25.44.36015.8-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 79,632 kB
  • sloc: cpp: 931,547; lisp: 2,074; sh: 719; makefile: 162; python: 21
file content (176 lines) | stat: -rw-r--r-- 7,629 bytes parent folder | download
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
/*
 * Copyright (C) 2024-2025 Intel Corporation
 *
 * SPDX-License-Identifier: MIT
 *
 */

#include "shared/source/os_interface/linux/sys_calls.h"
#include "shared/source/os_interface/linux/xe/ioctl_helper_xe.h"
#include "shared/source/os_interface/linux/xe/xedrm.h"

#include <algorithm>

#define RETURN_ME(X) return X

namespace NEO {

uint64_t getClosestSamplingRate(uint64_t requestedRate, uint64_t *samplingRates, uint64_t size) {
    uint64_t samplingUnit = 0;

    for (uint64_t index = 0; index < size; index++) {
        // Need to find the sampling rate which is closest to the requested rate
        if (samplingRates[index] >= requestedRate) {
            if (index == 0) {
                // The requested sampling rate is smaller than all supported sampling rates or equal to the 1st sampling rate. Pick the smallest supported rate and exit.
                samplingUnit = samplingRates[index];
                break;
            }
            uint64_t oneLowerIndex = index - 1;
            uint64_t oneHigherIndex = index;

            uint64_t deltaWithOneLowerIndex = requestedRate - samplingRates[oneLowerIndex];
            uint64_t deltaWithOneHigherIndex = samplingRates[oneHigherIndex] - requestedRate;

            samplingUnit = deltaWithOneHigherIndex <= deltaWithOneLowerIndex ? samplingRates[oneHigherIndex] : samplingRates[oneLowerIndex];
            break;
        }
    }

    // Requested sampling rate is higher than the max supported rate. Select the highest sampling rate supported.
    if (samplingUnit == 0) {
        samplingUnit = samplingRates[size - 1];
    }
    return samplingUnit;
}

bool IoctlHelperXe::perfOpenEuStallStream(uint32_t euStallFdParameter, uint32_t &samplingPeriodNs, uint64_t engineInstance, uint64_t notifyNReports, uint64_t gpuTimeStampfrequency, int32_t *stream) {

    // Query Sampling rates
    drm_xe_query_eu_stall *euStallQueryData = nullptr;
    drm_xe_device_query euStallDeviceQuery = {};
    euStallDeviceQuery.extensions = 0;
    euStallDeviceQuery.query = DRM_XE_DEVICE_QUERY_EU_STALL;
    euStallDeviceQuery.size = 0;
    euStallDeviceQuery.data = 0;

    int ret = ioctl(DrmIoctl::perfQuery, &euStallDeviceQuery);
    if (ret != 0 || euStallDeviceQuery.size == 0) {
        PRINT_DEBUG_STRING(NEO::debugManager.flags.PrintDebugMessages.get() && (ret != 0), stderr,
                           "%s failed errno = %d | ret = %d \n", "DRM_IOCTL_XE_DEVICE_QUERY", errno, ret);
        return false;
    }

    std::vector<uint8_t> allocateMemory(euStallDeviceQuery.size);
    euStallQueryData = reinterpret_cast<drm_xe_query_eu_stall *>(allocateMemory.data());

    euStallDeviceQuery.data = reinterpret_cast<uint64_t>(euStallQueryData);
    ret = ioctl(DrmIoctl::perfQuery, &euStallDeviceQuery);
    if (ret != 0 || euStallQueryData->num_sampling_rates == 0) {
        PRINT_DEBUG_STRING(NEO::debugManager.flags.PrintDebugMessages.get() && (ret != 0), stderr,
                           "%s failed errno = %d | ret = %d \n", "DRM_IOCTL_XE_DEVICE_QUERY", errno, ret);
        return false;
    }

    // Select sampling rate.
    uint64_t gpuClockPeriodNs = CommonConstants::nsecPerSec / gpuTimeStampfrequency;
    uint64_t numberOfClocks = samplingPeriodNs / gpuClockPeriodNs;
    uint64_t samplingUnit = getClosestSamplingRate(numberOfClocks, reinterpret_cast<uint64_t *>(&euStallQueryData->sampling_rates), euStallQueryData->num_sampling_rates);
    samplingPeriodNs = static_cast<uint32_t>(samplingUnit) * static_cast<uint32_t>(gpuClockPeriodNs);

    // Populate the EU stall properties. The array will have property type and value in successive index.
    std::array<uint64_t, 6u> properties;
    properties[0] = drm_xe_eu_stall_property_id::DRM_XE_EU_STALL_PROP_SAMPLE_RATE;
    properties[1] = samplingUnit;
    properties[2] = drm_xe_eu_stall_property_id::DRM_XE_EU_STALL_PROP_WAIT_NUM_REPORTS;
    properties[3] = notifyNReports;
    properties[4] = drm_xe_eu_stall_property_id::DRM_XE_EU_STALL_PROP_GT_ID;
    properties[5] = engineInstance;

    // Call perf open ioctl.
    uint32_t numProperties = sizeof(properties) / (sizeof(properties[0]) * 2);
    std::vector<drm_xe_ext_set_property> extensionProperty(numProperties);
    drm_xe_observation_param observationParam = {};
    observationParam.extensions = 0;
    observationParam.observation_type = drm_xe_observation_type::DRM_XE_OBSERVATION_TYPE_EU_STALL;
    observationParam.observation_op = drm_xe_observation_op::DRM_XE_OBSERVATION_OP_STREAM_OPEN;
    observationParam.param = reinterpret_cast<uint64_t>(extensionProperty.data());

    // Chain the properties for perfOpen ioctl.
    drm_xe_ext_set_property *ext = extensionProperty.data();

    for (uint32_t i = 0; i < numProperties; i++) {
        ext->base.name = DRM_XE_EU_STALL_EXTENSION_SET_PROPERTY;
        ext->property = static_cast<uint32_t>(properties[i * 2]);
        ext->value = properties[(i * 2) + 1];
        ext++;
    }

    ext = extensionProperty.data();
    for (uint32_t j = 0; j < numProperties - 1; j++) {
        ext[j].base.next_extension = reinterpret_cast<uint64_t>(&ext[j + 1]);
    }

    *stream = ioctl(DrmIoctl::perfOpen, &observationParam);
    if (*stream < 0) {
        PRINT_DEBUG_STRING(NEO::debugManager.flags.PrintDebugMessages.get() && (*stream < 0), stderr,
                           "%s failed errno = %d | ret = %d \n", "DRM_IOCTL_XE_OBSERVATION", errno, *stream);
        return false;
    }

    auto flags = SysCalls::fcntl(*stream, F_GETFL);
    if (flags == -1) {
        PRINT_DEBUG_STRING(NEO::debugManager.flags.PrintDebugMessages.get(), stderr, "fcntl system call failed with return code %d\n", flags);
        return false;
    }
    auto status = SysCalls::fcntl(*stream, F_SETFL, flags | O_CLOEXEC | O_NONBLOCK);
    if (status != 0) {
        PRINT_DEBUG_STRING(NEO::debugManager.flags.PrintDebugMessages.get(), stderr, "fcntl system call failed with return code %d\n", status);
        return false;
    }

    ret = ioctl(*stream, DrmIoctl::perfEnable, 0);
    PRINT_DEBUG_STRING(NEO::debugManager.flags.PrintDebugMessages.get() && (ret < 0), stderr,
                       "%s failed errno = %d | ret = %d \n", "DRM_XE_OBSERVATION_IOCTL_ENABLE", errno, ret);
    return (ret == 0) ? true : false;
}

bool IoctlHelperXe::perfDisableEuStallStream(int32_t *stream) {
    int disableStatus = ioctl(*stream, DrmIoctl::perfDisable, 0);
    PRINT_DEBUG_STRING(NEO::debugManager.flags.PrintDebugMessages.get() && (disableStatus < 0), stderr,
                       "DRM_XE_OBSERVATION_IOCTL_DISABLE failed errno = %d | ret = %d \n", errno, disableStatus);

    int closeStatus = NEO::SysCalls::close(*stream);
    PRINT_DEBUG_STRING(NEO::debugManager.flags.PrintDebugMessages.get() && (closeStatus < 0), stderr,
                       "close() failed errno = %d | ret = %d \n", errno, closeStatus);
    *stream = -1;

    return ((closeStatus == 0) && (disableStatus == 0)) ? true : false;
}

unsigned int IoctlHelperXe::getIoctlRequestValuePerf(DrmIoctl ioctlRequest) const {
    switch (ioctlRequest) {
    case DrmIoctl::perfOpen:
        RETURN_ME(DRM_IOCTL_XE_OBSERVATION);
    case DrmIoctl::perfEnable:
        RETURN_ME(DRM_XE_OBSERVATION_IOCTL_ENABLE);
    case DrmIoctl::perfDisable:
        RETURN_ME(DRM_XE_OBSERVATION_IOCTL_DISABLE);
    case DrmIoctl::perfQuery:
        RETURN_ME(DRM_IOCTL_XE_DEVICE_QUERY);

    default:
        return 0;
    }
}

int IoctlHelperXe::perfOpenIoctl(DrmIoctl request, void *arg) {
    auto ret = IoctlHelper::ioctl(request, arg);
    return ret;
}

bool IoctlHelperXe::isEuStallSupported() {
    return true;
}

} // namespace NEO