1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright (c) 2018 Oracle. All rights reserved.
5 * Trace point definitions for the "rpcgss" subsystem.
9 #define TRACE_SYSTEM rpcgss
11 #if !defined(_TRACE_RPCGSS_H) || defined(TRACE_HEADER_MULTI_READ)
12 #define _TRACE_RPCGSS_H
14 #include <linux/tracepoint.h>
16 #include <trace/misc/sunrpc.h>
19 ** GSS-API related trace events
22 TRACE_DEFINE_ENUM(RPC_GSS_SVC_NONE);
23 TRACE_DEFINE_ENUM(RPC_GSS_SVC_INTEGRITY);
24 TRACE_DEFINE_ENUM(RPC_GSS_SVC_PRIVACY);
26 #define show_gss_service(x) \
28 { RPC_GSS_SVC_NONE, "none" }, \
29 { RPC_GSS_SVC_INTEGRITY, "integrity" }, \
30 { RPC_GSS_SVC_PRIVACY, "privacy" })
32 TRACE_DEFINE_ENUM(GSS_S_BAD_MECH);
33 TRACE_DEFINE_ENUM(GSS_S_BAD_NAME);
34 TRACE_DEFINE_ENUM(GSS_S_BAD_NAMETYPE);
35 TRACE_DEFINE_ENUM(GSS_S_BAD_BINDINGS);
36 TRACE_DEFINE_ENUM(GSS_S_BAD_STATUS);
37 TRACE_DEFINE_ENUM(GSS_S_BAD_SIG);
38 TRACE_DEFINE_ENUM(GSS_S_NO_CRED);
39 TRACE_DEFINE_ENUM(GSS_S_NO_CONTEXT);
40 TRACE_DEFINE_ENUM(GSS_S_DEFECTIVE_TOKEN);
41 TRACE_DEFINE_ENUM(GSS_S_DEFECTIVE_CREDENTIAL);
42 TRACE_DEFINE_ENUM(GSS_S_CREDENTIALS_EXPIRED);
43 TRACE_DEFINE_ENUM(GSS_S_CONTEXT_EXPIRED);
44 TRACE_DEFINE_ENUM(GSS_S_FAILURE);
45 TRACE_DEFINE_ENUM(GSS_S_BAD_QOP);
46 TRACE_DEFINE_ENUM(GSS_S_UNAUTHORIZED);
47 TRACE_DEFINE_ENUM(GSS_S_UNAVAILABLE);
48 TRACE_DEFINE_ENUM(GSS_S_DUPLICATE_ELEMENT);
49 TRACE_DEFINE_ENUM(GSS_S_NAME_NOT_MN);
50 TRACE_DEFINE_ENUM(GSS_S_CONTINUE_NEEDED);
51 TRACE_DEFINE_ENUM(GSS_S_DUPLICATE_TOKEN);
52 TRACE_DEFINE_ENUM(GSS_S_OLD_TOKEN);
53 TRACE_DEFINE_ENUM(GSS_S_UNSEQ_TOKEN);
54 TRACE_DEFINE_ENUM(GSS_S_GAP_TOKEN);
56 #define show_gss_status(x) \
57 __print_flags(x, "|", \
58 { GSS_S_BAD_MECH, "GSS_S_BAD_MECH" }, \
59 { GSS_S_BAD_NAME, "GSS_S_BAD_NAME" }, \
60 { GSS_S_BAD_NAMETYPE, "GSS_S_BAD_NAMETYPE" }, \
61 { GSS_S_BAD_BINDINGS, "GSS_S_BAD_BINDINGS" }, \
62 { GSS_S_BAD_STATUS, "GSS_S_BAD_STATUS" }, \
63 { GSS_S_BAD_SIG, "GSS_S_BAD_SIG" }, \
64 { GSS_S_NO_CRED, "GSS_S_NO_CRED" }, \
65 { GSS_S_NO_CONTEXT, "GSS_S_NO_CONTEXT" }, \
66 { GSS_S_DEFECTIVE_TOKEN, "GSS_S_DEFECTIVE_TOKEN" }, \
67 { GSS_S_DEFECTIVE_CREDENTIAL, "GSS_S_DEFECTIVE_CREDENTIAL" }, \
68 { GSS_S_CREDENTIALS_EXPIRED, "GSS_S_CREDENTIALS_EXPIRED" }, \
69 { GSS_S_CONTEXT_EXPIRED, "GSS_S_CONTEXT_EXPIRED" }, \
70 { GSS_S_FAILURE, "GSS_S_FAILURE" }, \
71 { GSS_S_BAD_QOP, "GSS_S_BAD_QOP" }, \
72 { GSS_S_UNAUTHORIZED, "GSS_S_UNAUTHORIZED" }, \
73 { GSS_S_UNAVAILABLE, "GSS_S_UNAVAILABLE" }, \
74 { GSS_S_DUPLICATE_ELEMENT, "GSS_S_DUPLICATE_ELEMENT" }, \
75 { GSS_S_NAME_NOT_MN, "GSS_S_NAME_NOT_MN" }, \
76 { GSS_S_CONTINUE_NEEDED, "GSS_S_CONTINUE_NEEDED" }, \
77 { GSS_S_DUPLICATE_TOKEN, "GSS_S_DUPLICATE_TOKEN" }, \
78 { GSS_S_OLD_TOKEN, "GSS_S_OLD_TOKEN" }, \
79 { GSS_S_UNSEQ_TOKEN, "GSS_S_UNSEQ_TOKEN" }, \
80 { GSS_S_GAP_TOKEN, "GSS_S_GAP_TOKEN" })
83 DECLARE_EVENT_CLASS(rpcgss_gssapi_event,
85 const struct rpc_task *task,
89 TP_ARGS(task, maj_stat),
92 __field(unsigned int, task_id)
93 __field(unsigned int, client_id)
94 __field(u32, maj_stat)
99 __entry->task_id = task->tk_pid;
100 __entry->client_id = task->tk_client->cl_clid;
101 __entry->maj_stat = maj_stat;
104 TP_printk(SUNRPC_TRACE_TASK_SPECIFIER " maj_stat=%s",
105 __entry->task_id, __entry->client_id,
106 __entry->maj_stat == 0 ?
107 "GSS_S_COMPLETE" : show_gss_status(__entry->maj_stat))
110 #define DEFINE_GSSAPI_EVENT(name) \
111 DEFINE_EVENT(rpcgss_gssapi_event, rpcgss_##name, \
113 const struct rpc_task *task, \
116 TP_ARGS(task, maj_stat))
118 TRACE_EVENT(rpcgss_import_ctx,
130 __entry->status = status;
133 TP_printk("status=%d", __entry->status)
136 DEFINE_GSSAPI_EVENT(get_mic);
137 DEFINE_GSSAPI_EVENT(verify_mic);
138 DEFINE_GSSAPI_EVENT(wrap);
139 DEFINE_GSSAPI_EVENT(unwrap);
141 DECLARE_EVENT_CLASS(rpcgss_ctx_class,
143 const struct gss_cred *gc
149 __field(const void *, cred)
150 __field(unsigned long, service)
151 __string(principal, gc->gc_principal)
156 __entry->service = gc->gc_service;
157 __assign_str(principal, gc->gc_principal);
160 TP_printk("cred=%p service=%s principal='%s'",
161 __entry->cred, show_gss_service(__entry->service),
162 __get_str(principal))
165 #define DEFINE_CTX_EVENT(name) \
166 DEFINE_EVENT(rpcgss_ctx_class, rpcgss_ctx_##name, \
168 const struct gss_cred *gc \
172 DEFINE_CTX_EVENT(init);
173 DEFINE_CTX_EVENT(destroy);
175 DECLARE_EVENT_CLASS(rpcgss_svc_gssapi_class,
177 const struct svc_rqst *rqstp,
181 TP_ARGS(rqstp, maj_stat),
185 __field(u32, maj_stat)
186 __string(addr, rqstp->rq_xprt->xpt_remotebuf)
190 __entry->xid = __be32_to_cpu(rqstp->rq_xid);
191 __entry->maj_stat = maj_stat;
192 __assign_str(addr, rqstp->rq_xprt->xpt_remotebuf);
195 TP_printk("addr=%s xid=0x%08x maj_stat=%s",
196 __get_str(addr), __entry->xid,
197 __entry->maj_stat == 0 ?
198 "GSS_S_COMPLETE" : show_gss_status(__entry->maj_stat))
201 #define DEFINE_SVC_GSSAPI_EVENT(name) \
202 DEFINE_EVENT(rpcgss_svc_gssapi_class, rpcgss_svc_##name, \
204 const struct svc_rqst *rqstp, \
207 TP_ARGS(rqstp, maj_stat))
209 DEFINE_SVC_GSSAPI_EVENT(unwrap);
210 DEFINE_SVC_GSSAPI_EVENT(mic);
212 TRACE_EVENT(rpcgss_svc_unwrap_failed,
214 const struct svc_rqst *rqstp
221 __string(addr, rqstp->rq_xprt->xpt_remotebuf)
225 __entry->xid = be32_to_cpu(rqstp->rq_xid);
226 __assign_str(addr, rqstp->rq_xprt->xpt_remotebuf);
229 TP_printk("addr=%s xid=0x%08x", __get_str(addr), __entry->xid)
232 TRACE_EVENT(rpcgss_svc_seqno_bad,
234 const struct svc_rqst *rqstp,
239 TP_ARGS(rqstp, expected, received),
242 __field(u32, expected)
243 __field(u32, received)
245 __string(addr, rqstp->rq_xprt->xpt_remotebuf)
249 __entry->expected = expected;
250 __entry->received = received;
251 __entry->xid = __be32_to_cpu(rqstp->rq_xid);
252 __assign_str(addr, rqstp->rq_xprt->xpt_remotebuf);
255 TP_printk("addr=%s xid=0x%08x expected seqno %u, received seqno %u",
256 __get_str(addr), __entry->xid,
257 __entry->expected, __entry->received)
260 TRACE_EVENT(rpcgss_svc_accept_upcall,
262 const struct svc_rqst *rqstp,
267 TP_ARGS(rqstp, major_status, minor_status),
270 __field(u32, minor_status)
271 __field(unsigned long, major_status)
273 __string(addr, rqstp->rq_xprt->xpt_remotebuf)
277 __entry->minor_status = minor_status;
278 __entry->major_status = major_status;
279 __entry->xid = be32_to_cpu(rqstp->rq_xid);
280 __assign_str(addr, rqstp->rq_xprt->xpt_remotebuf);
283 TP_printk("addr=%s xid=0x%08x major_status=%s (0x%08lx) minor_status=%u",
284 __get_str(addr), __entry->xid,
285 (__entry->major_status == 0) ? "GSS_S_COMPLETE" :
286 show_gss_status(__entry->major_status),
287 __entry->major_status, __entry->minor_status
291 TRACE_EVENT(rpcgss_svc_authenticate,
293 const struct svc_rqst *rqstp,
294 const struct rpc_gss_wire_cred *gc
302 __string(addr, rqstp->rq_xprt->xpt_remotebuf)
306 __entry->xid = be32_to_cpu(rqstp->rq_xid);
307 __entry->seqno = gc->gc_seq;
308 __assign_str(addr, rqstp->rq_xprt->xpt_remotebuf);
311 TP_printk("addr=%s xid=0x%08x seqno=%u", __get_str(addr),
312 __entry->xid, __entry->seqno)
317 ** GSS auth unwrap failures
320 TRACE_EVENT(rpcgss_unwrap_failed,
322 const struct rpc_task *task
328 __field(unsigned int, task_id)
329 __field(unsigned int, client_id)
333 __entry->task_id = task->tk_pid;
334 __entry->client_id = task->tk_client->cl_clid;
337 TP_printk(SUNRPC_TRACE_TASK_SPECIFIER,
338 __entry->task_id, __entry->client_id)
341 TRACE_EVENT(rpcgss_bad_seqno,
343 const struct rpc_task *task,
348 TP_ARGS(task, expected, received),
351 __field(unsigned int, task_id)
352 __field(unsigned int, client_id)
353 __field(u32, expected)
354 __field(u32, received)
358 __entry->task_id = task->tk_pid;
359 __entry->client_id = task->tk_client->cl_clid;
360 __entry->expected = expected;
361 __entry->received = received;
364 TP_printk(SUNRPC_TRACE_TASK_SPECIFIER
365 " expected seqno %u, received seqno %u",
366 __entry->task_id, __entry->client_id,
367 __entry->expected, __entry->received)
370 TRACE_EVENT(rpcgss_seqno,
372 const struct rpc_task *task
378 __field(unsigned int, task_id)
379 __field(unsigned int, client_id)
385 const struct rpc_rqst *rqst = task->tk_rqstp;
387 __entry->task_id = task->tk_pid;
388 __entry->client_id = task->tk_client->cl_clid;
389 __entry->xid = be32_to_cpu(rqst->rq_xid);
390 __entry->seqno = rqst->rq_seqno;
393 TP_printk(SUNRPC_TRACE_TASK_SPECIFIER " xid=0x%08x seqno=%u",
394 __entry->task_id, __entry->client_id,
395 __entry->xid, __entry->seqno)
398 TRACE_EVENT(rpcgss_need_reencode,
400 const struct rpc_task *task,
405 TP_ARGS(task, seq_xmit, ret),
408 __field(unsigned int, task_id)
409 __field(unsigned int, client_id)
411 __field(u32, seq_xmit)
417 __entry->task_id = task->tk_pid;
418 __entry->client_id = task->tk_client->cl_clid;
419 __entry->xid = be32_to_cpu(task->tk_rqstp->rq_xid);
420 __entry->seq_xmit = seq_xmit;
421 __entry->seqno = task->tk_rqstp->rq_seqno;
425 TP_printk(SUNRPC_TRACE_TASK_SPECIFIER
426 " xid=0x%08x rq_seqno=%u seq_xmit=%u reencode %sneeded",
427 __entry->task_id, __entry->client_id,
428 __entry->xid, __entry->seqno, __entry->seq_xmit,
429 __entry->ret ? "" : "un")
432 TRACE_EVENT(rpcgss_update_slack,
434 const struct rpc_task *task,
435 const struct rpc_auth *auth
441 __field(unsigned int, task_id)
442 __field(unsigned int, client_id)
444 __field(const void *, auth)
445 __field(unsigned int, rslack)
446 __field(unsigned int, ralign)
447 __field(unsigned int, verfsize)
451 __entry->task_id = task->tk_pid;
452 __entry->client_id = task->tk_client->cl_clid;
453 __entry->xid = be32_to_cpu(task->tk_rqstp->rq_xid);
454 __entry->auth = auth;
455 __entry->rslack = auth->au_rslack;
456 __entry->ralign = auth->au_ralign;
457 __entry->verfsize = auth->au_verfsize;
460 TP_printk(SUNRPC_TRACE_TASK_SPECIFIER
461 " xid=0x%08x auth=%p rslack=%u ralign=%u verfsize=%u\n",
462 __entry->task_id, __entry->client_id, __entry->xid,
463 __entry->auth, __entry->rslack, __entry->ralign,
467 DECLARE_EVENT_CLASS(rpcgss_svc_seqno_class,
469 const struct svc_rqst *rqstp,
473 TP_ARGS(rqstp, seqno),
481 __entry->xid = be32_to_cpu(rqstp->rq_xid);
482 __entry->seqno = seqno;
485 TP_printk("xid=0x%08x seqno=%u",
486 __entry->xid, __entry->seqno)
489 #define DEFINE_SVC_SEQNO_EVENT(name) \
490 DEFINE_EVENT(rpcgss_svc_seqno_class, rpcgss_svc_seqno_##name, \
492 const struct svc_rqst *rqstp, \
495 TP_ARGS(rqstp, seqno))
497 DEFINE_SVC_SEQNO_EVENT(large);
498 DEFINE_SVC_SEQNO_EVENT(seen);
500 TRACE_EVENT(rpcgss_svc_seqno_low,
502 const struct svc_rqst *rqstp,
508 TP_ARGS(rqstp, seqno, min, max),
518 __entry->xid = be32_to_cpu(rqstp->rq_xid);
519 __entry->seqno = seqno;
524 TP_printk("xid=0x%08x seqno=%u window=[%u..%u]",
525 __entry->xid, __entry->seqno, __entry->min, __entry->max)
529 ** gssd upcall related trace events
532 TRACE_EVENT(rpcgss_upcall_msg,
544 __assign_str(msg, buf);
547 TP_printk("msg='%s'", __get_str(msg))
550 TRACE_EVENT(rpcgss_upcall_result,
556 TP_ARGS(uid, result),
566 __entry->result = result;
569 TP_printk("for uid %u, result=%d", __entry->uid, __entry->result)
572 TRACE_EVENT(rpcgss_context,
575 unsigned long expiry,
577 unsigned int timeout,
582 TP_ARGS(window_size, expiry, now, timeout, len, data),
585 __field(unsigned long, expiry)
586 __field(unsigned long, now)
587 __field(unsigned int, timeout)
588 __field(u32, window_size)
590 __string(acceptor, data)
594 __entry->expiry = expiry;
596 __entry->timeout = timeout;
597 __entry->window_size = window_size;
599 strncpy(__get_str(acceptor), data, len);
602 TP_printk("win_size=%u expiry=%lu now=%lu timeout=%u acceptor=%.*s",
603 __entry->window_size, __entry->expiry, __entry->now,
604 __entry->timeout, __entry->len, __get_str(acceptor))
609 ** Miscellaneous events
612 TRACE_DEFINE_ENUM(RPC_AUTH_GSS_KRB5);
613 TRACE_DEFINE_ENUM(RPC_AUTH_GSS_KRB5I);
614 TRACE_DEFINE_ENUM(RPC_AUTH_GSS_KRB5P);
616 #define show_pseudoflavor(x) \
617 __print_symbolic(x, \
618 { RPC_AUTH_GSS_KRB5, "RPC_AUTH_GSS_KRB5" }, \
619 { RPC_AUTH_GSS_KRB5I, "RPC_AUTH_GSS_KRB5I" }, \
620 { RPC_AUTH_GSS_KRB5P, "RPC_AUTH_GSS_KRB5P" })
623 TRACE_EVENT(rpcgss_createauth,
629 TP_ARGS(flavor, error),
632 __field(unsigned int, flavor)
638 __entry->flavor = flavor;
639 __entry->error = error;
642 TP_printk("flavor=%s error=%d",
643 show_pseudoflavor(__entry->flavor), __entry->error)
646 TRACE_EVENT(rpcgss_oid_to_mech,
658 __assign_str(oid, oid);
661 TP_printk("mech for oid %s was not found", __get_str(oid))
664 #endif /* _TRACE_RPCGSS_H */
666 #include <trace/define_trace.h>