xref: /linux/Documentation/netlink/specs/binder.yaml (revision 4f38da1f027ea2c9f01bb71daa7a299c191b6940)
1# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
2#
3# Copyright 2025 Google LLC
4#
5---
6name: binder
7protocol: genetlink
8uapi-header: linux/android/binder_netlink.h
9doc: Binder interface over generic netlink
10
11attribute-sets:
12  -
13    name: report
14    doc: |
15      Attributes included within a transaction failure report. The elements
16      correspond directly with the specific transaction that failed, along
17      with the error returned to the sender e.g. BR_DEAD_REPLY.
18
19    attributes:
20      -
21        name: error
22        type: u32
23        doc: The enum binder_driver_return_protocol returned to the sender.
24      -
25        name: context
26        type: string
27        doc: The binder context where the transaction occurred.
28      -
29        name: from-pid
30        type: u32
31        doc: The PID of the sender process.
32      -
33        name: from-tid
34        type: u32
35        doc: The TID of the sender thread.
36      -
37        name: to-pid
38        type: u32
39        doc: |
40          The PID of the recipient process. This attribute may not be present
41          if the target could not be determined.
42      -
43        name: to-tid
44        type: u32
45        doc: |
46          The TID of the recipient thread. This attribute may not be present
47          if the target could not be determined.
48      -
49        name: is-reply
50        type: flag
51        doc: When present, indicates the failed transaction is a reply.
52      -
53        name: flags
54        type: u32
55        doc: The bitmask of enum transaction_flags from the transaction.
56      -
57        name: code
58        type: u32
59        doc: The application-defined code from the transaction.
60      -
61        name: data-size
62        type: u32
63        doc: The transaction payload size in bytes.
64
65operations:
66  list:
67    -
68      name: report
69      doc: |
70        A multicast event sent to userspace subscribers to notify them about
71        binder transaction failures. The generated report provides the full
72        details of the specific transaction that failed. The intention is for
73        programs to monitor these events and react to the failures as needed.
74
75      attribute-set: report
76      mcgrp: report
77      event:
78        attributes:
79          - error
80          - context
81          - from-pid
82          - from-tid
83          - to-pid
84          - to-tid
85          - is-reply
86          - flags
87          - code
88          - data-size
89
90mcast-groups:
91  list:
92    -
93      name: report
94