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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
// SPDX-License-Identifier: MIT
/*
* Copyright © 2026 Intel Corporation
*/
#include <kunit/static_stub.h>
#include <kunit/visibility.h>
#include "abi/xe_log_abi.h"
#include "xe_device.h"
#include "xe_log.h"
#include "xe_printk.h"
static void log_emit_cper(struct pci_dev *pdev, int cper_sev, enum xe_sigid sigid,
u32 component, u32 location, const void *data, size_t len,
struct va_format *vaf)
{
KUNIT_STATIC_STUB_REDIRECT(log_emit_cper, pdev, cper_sev, sigid,
component, location, data, len, vaf);
/* TODO */
}
static const char *log_unknown_component_prefix(u32 component)
{
u32 class = FIELD_GET(XE_LOG_COMPONENT_CLASS_MASK, component);
u32 type = FIELD_GET(XE_LOG_COMPONENT_TYPE_MASK, component);
WARN(IS_ENABLED(CONFIG_DRM_XE_DEBUG), "LOG: unrecognized component %u.%u\n", class, type);
switch (class) {
#define MAKE_XE_LOG_COMPONENT_CLASS_PREFIX(_CLASS) \
case XE_LOG_COMPONENT_CLASS_##_CLASS: return #_CLASS "? ";
MAKE_XE_LOG_COMPONENT_CLASS_PREFIX(SYSTEM)
MAKE_XE_LOG_COMPONENT_CLASS_PREFIX(DRIVER)
MAKE_XE_LOG_COMPONENT_CLASS_PREFIX(FEATURE)
MAKE_XE_LOG_COMPONENT_CLASS_PREFIX(FIRMWARE)
MAKE_XE_LOG_COMPONENT_CLASS_PREFIX(HARDWARE)
#undef MAKE_XE_LOG_COMPONENT_CLASS_PREFIX
}
return "COMP? ";
}
static const char *log_component_prefix(u32 component)
{
switch (component) {
#define MAKE_XE_LOG_COMPONENT_CASE_PREFIX(_CLASS, _ID, _TAG, _SIG, _NAME) \
case XE_LOG_COMPONENT_##_TAG: return #_TAG ": ";
DEFINE_XE_LOG_COMPONENTS(MAKE_XE_LOG_COMPONENT_CASE_PREFIX)
#undef MAKE_XE_LOG_COMPONENT_CASE_PREFIX
}
return component ? log_unknown_component_prefix(component) : "";
}
static struct xe_gt *get_gt_safe(struct pci_dev *pdev, u8 id)
{
struct xe_device *xe = pdev_to_xe_device(pdev);
return xe ? xe_device_get_gt(xe, id) : NULL;
}
static struct xe_tile *get_tile_safe(struct pci_dev *pdev, u8 id)
{
struct xe_device *xe = pdev_to_xe_device(pdev);
return xe && id < xe->info.tile_count ? &xe->tiles[id] : NULL;
}
static const char *log_location_prefix(struct pci_dev *pdev, u32 location, char *buf, size_t size)
{
u32 type = FIELD_GET(XE_LOG_LOCATION_TYPE_MASK, location);
u32 id = FIELD_GET(XE_LOG_LOCATION_ID_MASK, location);
if (!location || type == XE_LOG_LOCATION_TYPE_DEVICE) {
if (id)
goto unrecognized;
strscpy(buf, "", size);
} else if (type == XE_LOG_LOCATION_TYPE_TILE) {
struct xe_tile *tile = get_tile_safe(pdev, id);
if (!tile)
goto unrecognized;
snprintf(buf, size, "Tile%u: ", id);
} else if (type == XE_LOG_LOCATION_TYPE_GT) {
struct xe_gt *gt = get_gt_safe(pdev, id);
if (!gt)
goto unrecognized;
snprintf(buf, size, "Tile%u: GT%u: ", gt->tile->id, id);
} else {
goto unrecognized;
}
return buf;
unrecognized:
pci_WARN(pdev, IS_ENABLED(CONFIG_DRM_XE_DEBUG),
"LOG: unrecognized location %u.%u\n", type, id);
snprintf(buf, size, "LOC%u.%u? ", type, id);
return buf;
}
static bool is_hw_sigid(enum xe_sigid sigid)
{
return (int)sigid >= INTEL_SIGID_GPU_XE_HARDWARE_START;
}
static bool is_sev_error(int cper_sev)
{
return cper_sev != CPER_SEV_INFORMATIONAL;
}
static const char *log_hwe_prefix(int cper_sev, enum xe_sigid sigid)
{
return is_sev_error(cper_sev) && is_hw_sigid(sigid) ? HW_ERR : "";
}
static const char *log_sev_prefix(int cper_sev)
{
switch (cper_sev) {
case CPER_SEV_FATAL:
return "FATAL ";
case CPER_SEV_RECOVERABLE:
return "";
case CPER_SEV_CORRECTED:
return "CORRECTED ";
case CPER_SEV_INFORMATIONAL:
return "";
default:
WARN(IS_ENABLED(CONFIG_DRM_XE_DEBUG), "LOG: unknown severity %d\n", cper_sev);
return "";
}
}
#define __LOG_DRM_PRINTK_FMT(fmt, args...) "[drm] " fmt, ##args
#define __LOG_DRM_PRINTK_ERR_FMT(fmt, args...) __LOG_DRM_PRINTK_FMT("*ERROR* " fmt, args)
static void log_dmesg_vprintk(struct pci_dev *pdev, int cper_sev, struct va_format *vaf)
{
KUNIT_STATIC_STUB_REDIRECT(log_dmesg_vprintk, pdev, cper_sev, vaf);
if (cper_sev == CPER_SEV_INFORMATIONAL)
pci_info(pdev, __LOG_DRM_PRINTK_FMT("%pV", vaf));
else
pci_err(pdev, __LOG_DRM_PRINTK_ERR_FMT("%pV", vaf));
}
static void log_dmesg_printf(struct pci_dev *pdev, int cper_sev, const char *fmt, ...)
{
struct va_format vaf;
va_list args;
va_start(args, fmt);
vaf.fmt = fmt;
vaf.va = &args;
log_dmesg_vprintk(pdev, cper_sev, &vaf);
va_end(args);
}
static void log_emit_dmesg(struct pci_dev *pdev, int cper_sev, enum xe_sigid sigid,
u32 component, u32 location, const void *data, size_t len,
struct va_format *vaf)
{
char buf[32];
const char *loc_prefix = log_location_prefix(pdev, location, buf, sizeof(buf));
const char *comp_prefix = log_component_prefix(component);
const char *hwe_prefix = log_hwe_prefix(cper_sev, sigid);
const char *sev_prefix = log_sev_prefix(cper_sev);
if (IS_ERR(data))
log_dmesg_printf(pdev, cper_sev, "SIGID=%u %s(%pe) %s%s%s%pV",
sigid, sev_prefix, data, hwe_prefix,
loc_prefix, comp_prefix, vaf);
else if (data && len)
log_dmesg_printf(pdev, cper_sev, "SIGID=%u %s(%*phN) %s%s%s%pV",
sigid, sev_prefix, (int)len, data, hwe_prefix,
loc_prefix, comp_prefix, vaf);
else
log_dmesg_printf(pdev, cper_sev, "SIGID=%u %s%s%s%s%pV",
sigid, sev_prefix, hwe_prefix,
loc_prefix, comp_prefix, vaf);
}
/**
* __xe_log_emit() - Emit a structured SIGID log entry
* @pdev: the &pci_dev device
* @cper_sev: CPER severity (CPER_SEV_FATAL, CPER_SEV_RECOVERABLE, ...)
* @sigid: signature identifier, see &enum xe_sigid
* @component: component identifier
* @location: location details of the @component
* @data: pointer to the additional details, or ERR_PTR, or NULL if not applicable
* @len: length of the @data in bytes, or 0 if not applicable
* @fmt: printf-style format string
* @...: format arguments
*
* Emits a dmesg line that includes a single stable, machine-matchable token
* ``SIGID=<n>`` followed by the optional severity token (like ``FATAL``) and,
* when @data pointer is set, either the error printed with %pe or a packed hex
* dump of the @data binary blob. The dmesg line will also include printf-style
* text message.
*
* Note that the full dmesg line, with the free text message, is only a debugging
* aid, not an interface! Only the ``SIGID=<n>`` token is stable there.
* The durable machine record is the CPER carrying the same SIGID.
*
* Note: generation of the CPER record is a planned follow-up.
*
* Examples::
*
* <3> xe 0000:03:00.0: [drm] *ERROR* SIGID=104 FATAL (-EPROTO) Invalid GuC reply
* <3> xe 0000:03:00.0: [drm] *ERROR* SIGID=106 (-ETIMEDOUT) Engine 'rcs0' hung
* <6> xe 0000:03:00.0: [drm] SIGID=103 In survivability mode
*/
void __xe_log_emit(struct pci_dev *pdev, int cper_sev, enum xe_sigid sigid,
u32 component, u32 location, const void *data, size_t len,
const char *fmt, ...)
{
struct va_format vaf;
va_list args;
va_start(args, fmt);
vaf.fmt = fmt;
vaf.va = &args;
log_emit_dmesg(pdev, cper_sev, sigid, component, location, data, len, &vaf);
log_emit_cper(pdev, cper_sev, sigid, component, location, data, len, &vaf);
va_end(args);
}
#if IS_BUILTIN(CONFIG_DRM_XE_KUNIT_TEST)
#include "tests/xe_log_kunit.c"
#endif
|
