include/uapi/linux/android/binder.h

   1 /*
   2  * Copyright (C) 2008 Google, Inc.
   3  *
   4  * Based on, but no longer compatible with, the original
   5  * OpenBinder.org binder driver interface, which is:
   6  *
   7  * Copyright (c) 2005 Palmsource, Inc.
   8  *
   9  * This software is licensed under the terms of the GNU General Public
  10  * License version 2, as published by the Free Software Foundation, and
  11  * may be copied, distributed, and modified under those terms.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  */
  19
  20 #ifndef _UAPI_LINUX_BINDER_H
  21 #define _UAPI_LINUX_BINDER_H
  22
  23 #include <linux/ioctl.h>
  24
  25 #define B_PACK_CHARS(c1, c2, c3, c4) \
  26         ((((c1)<<24)) | (((c2)<<16)) | (((c3)<<8)) | (c4))
  27 #define B_TYPE_LARGE 0x85
  28
  29 enum {
  30         BINDER_TYPE_BINDER      = B_PACK_CHARS('s', 'b', '*', B_TYPE_LARGE),
  31         BINDER_TYPE_WEAK_BINDER = B_PACK_CHARS('w', 'b', '*', B_TYPE_LARGE),
  32         BINDER_TYPE_HANDLE      = B_PACK_CHARS('s', 'h', '*', B_TYPE_LARGE),
  33         BINDER_TYPE_WEAK_HANDLE = B_PACK_CHARS('w', 'h', '*', B_TYPE_LARGE),
  34         BINDER_TYPE_FD          = B_PACK_CHARS('f', 'd', '*', B_TYPE_LARGE),
  35         BINDER_TYPE_FDA         = B_PACK_CHARS('f', 'd', 'a', B_TYPE_LARGE),
  36         BINDER_TYPE_PTR         = B_PACK_CHARS('p', 't', '*', B_TYPE_LARGE),
  37 };
  38
  39 /**
  40  * enum flat_binder_object_shifts: shift values for flat_binder_object_flags
  41  * @FLAT_BINDER_FLAG_SCHED_POLICY_SHIFT: shift for getting scheduler policy.
  42  *
  43  */
  44 enum flat_binder_object_shifts {
  45         FLAT_BINDER_FLAG_SCHED_POLICY_SHIFT = 9,
  46 };
  47
  48 /**
  49  * enum flat_binder_object_flags - flags for use in flat_binder_object.flags
  50  */
  51 enum flat_binder_object_flags {
  52         /**
  53          * @FLAT_BINDER_FLAG_PRIORITY_MASK: bit-mask for min scheduler priority
  54          *
  55          * These bits can be used to set the minimum scheduler priority
  56          * at which transactions into this node should run. Valid values
  57          * in these bits depend on the scheduler policy encoded in
  58          * @FLAT_BINDER_FLAG_SCHED_POLICY_MASK.
  59          *
  60          * For SCHED_NORMAL/SCHED_BATCH, the valid range is between [-20..19]
  61          * For SCHED_FIFO/SCHED_RR, the value can run between [1..99]
  62          */
  63         FLAT_BINDER_FLAG_PRIORITY_MASK = 0xff,
  64         /**
  65          * @FLAT_BINDER_FLAG_ACCEPTS_FDS: whether the node accepts fds.
  66          */
  67         FLAT_BINDER_FLAG_ACCEPTS_FDS = 0x100,
  68         /**
  69          * @FLAT_BINDER_FLAG_SCHED_POLICY_MASK: bit-mask for scheduling policy
  70          *
  71          * These two bits can be used to set the min scheduling policy at which
  72          * transactions on this node should run. These match the UAPI
  73          * scheduler policy values, eg:
  74          * 00b: SCHED_NORMAL
  75          * 01b: SCHED_FIFO
  76          * 10b: SCHED_RR
  77          * 11b: SCHED_BATCH
  78          */
  79         FLAT_BINDER_FLAG_SCHED_POLICY_MASK =
  80                 3U << FLAT_BINDER_FLAG_SCHED_POLICY_SHIFT,
  81
  82         /**
  83          * @FLAT_BINDER_FLAG_INHERIT_RT: whether the node inherits RT policy
  84          *
  85          * Only when set, calls into this node will inherit a real-time
  86          * scheduling policy from the caller (for synchronous transactions).
  87          */
  88         FLAT_BINDER_FLAG_INHERIT_RT = 0x800,
  89 };
  90
  91 #ifdef BINDER_IPC_32BIT
  92 typedef __u32 binder_size_t;
  93 typedef __u32 binder_uintptr_t;
  94 #else
  95 typedef __u64 binder_size_t;
  96 typedef __u64 binder_uintptr_t;
  97 #endif
  98
  99 /**
 100  * struct binder_object_header - header shared by all binder metadata objects.
 101  * @type:       type of the object
 102  */
 103 struct binder_object_header {
 104         __u32        type;
 105 };
 106
 107 /*
 108  * This is the flattened representation of a Binder object for transfer
 109  * between processes.  The 'offsets' supplied as part of a binder transaction
 110  * contains offsets into the data where these structures occur.  The Binder
 111  * driver takes care of re-writing the structure type and data as it moves
 112  * between processes.
 113  */
 114 struct flat_binder_object {
 115         struct binder_object_header     hdr;
 116         __u32                           flags;
 117
 118         /* 8 bytes of data. */
 119         union {
 120                 binder_uintptr_t        binder; /* local object */
 121                 __u32                   handle; /* remote object */
 122         };
 123
 124         /* extra data associated with local object */
 125         binder_uintptr_t        cookie;
 126 };
 127
 128 /**
 129  * struct binder_fd_object - describes a filedescriptor to be fixed up.
 130  * @hdr:        common header structure
 131  * @pad_flags:  padding to remain compatible with old userspace code
 132  * @pad_binder: padding to remain compatible with old userspace code
 133  * @fd:         file descriptor
 134  * @cookie:     opaque data, used by user-space
 135  */
 136 struct binder_fd_object {
 137         struct binder_object_header     hdr;
 138         __u32                           pad_flags;
 139         union {
 140                 binder_uintptr_t        pad_binder;
 141                 __u32                   fd;
 142         };
 143
 144         binder_uintptr_t                cookie;
 145 };
 146
 147 /* struct binder_buffer_object - object describing a userspace buffer
 148  * @hdr:                common header structure
 149  * @flags:              one or more BINDER_BUFFER_* flags
 150  * @buffer:             address of the buffer
 151  * @length:             length of the buffer
 152  * @parent:             index in offset array pointing to parent buffer
 153  * @parent_offset:      offset in @parent pointing to this buffer
 154  *
 155  * A binder_buffer object represents an object that the
 156  * binder kernel driver can copy verbatim to the target
 157  * address space. A buffer itself may be pointed to from
 158  * within another buffer, meaning that the pointer inside
 159  * that other buffer needs to be fixed up as well. This
 160  * can be done by setting the BINDER_BUFFER_FLAG_HAS_PARENT
 161  * flag in @flags, by setting @parent buffer to the index
 162  * in the offset array pointing to the parent binder_buffer_object,
 163  * and by setting @parent_offset to the offset in the parent buffer
 164  * at which the pointer to this buffer is located.
 165  */
 166 struct binder_buffer_object {
 167         struct binder_object_header     hdr;
 168         __u32                           flags;
 169         binder_uintptr_t                buffer;
 170         binder_size_t                   length;
 171         binder_size_t                   parent;
 172         binder_size_t                   parent_offset;
 173 };
 174
 175 enum {
 176         BINDER_BUFFER_FLAG_HAS_PARENT = 0x01,
 177 };
 178
 179 /* struct binder_fd_array_object - object describing an array of fds in a buffer
 180  * @hdr:                common header structure
 181  * @num_fds:            number of file descriptors in the buffer
 182  * @parent:             index in offset array to buffer holding the fd array
 183  * @parent_offset:      start offset of fd array in the buffer
 184  *
 185  * A binder_fd_array object represents an array of file
 186  * descriptors embedded in a binder_buffer_object. It is
 187  * different from a regular binder_buffer_object because it
 188  * describes a list of file descriptors to fix up, not an opaque
 189  * blob of memory, and hence the kernel needs to treat it differently.
 190  *
 191  * An example of how this would be used is with Android's
 192  * native_handle_t object, which is a struct with a list of integers
 193  * and a list of file descriptors. The native_handle_t struct itself
 194  * will be represented by a struct binder_buffer_objct, whereas the
 195  * embedded list of file descriptors is represented by a
 196  * struct binder_fd_array_object with that binder_buffer_object as
 197  * a parent.
 198  */
 199 struct binder_fd_array_object {
 200         struct binder_object_header     hdr;
 201         binder_size_t                   num_fds;
 202         binder_size_t                   parent;
 203         binder_size_t                   parent_offset;
 204 };
 205
 206 /*
 207  * On 64-bit platforms where user code may run in 32-bits the driver must
 208  * translate the buffer (and local binder) addresses appropriately.
 209  */
 210
 211 struct binder_write_read {
 212         binder_size_t           write_size;     /* bytes to write */
 213         binder_size_t           write_consumed; /* bytes consumed by driver */
 214         binder_uintptr_t        write_buffer;
 215         binder_size_t           read_size;      /* bytes to read */
 216         binder_size_t           read_consumed;  /* bytes consumed by driver */
 217         binder_uintptr_t        read_buffer;
 218 };
 219
 220 /* Use with BINDER_VERSION, driver fills in fields. */
 221 struct binder_version {
 222         /* driver protocol version -- increment with incompatible change */
 223         __s32   protocol_version;
 224 };
 225
 226 /* This is the current protocol version. */
 227 #ifdef BINDER_IPC_32BIT
 228 #define BINDER_CURRENT_PROTOCOL_VERSION 7
 229 #else
 230 #define BINDER_CURRENT_PROTOCOL_VERSION 8
 231 #endif
 232
 233 /*
 234  * Use with BINDER_GET_NODE_DEBUG_INFO, driver reads ptr, writes to all fields.
 235  * Set ptr to NULL for the first call to get the info for the first node, and
 236  * then repeat the call passing the previously returned value to get the next
 237  * nodes.  ptr will be 0 when there are no more nodes.
 238  */
 239 struct binder_node_debug_info {
 240         binder_uintptr_t ptr;
 241         binder_uintptr_t cookie;
 242         __u32            has_strong_ref;
 243         __u32            has_weak_ref;
 244 };
 245
 246 #define BINDER_WRITE_READ               _IOWR('b', 1, struct binder_write_read)
 247 #define BINDER_SET_IDLE_TIMEOUT         _IOW('b', 3, __s64)
 248 #define BINDER_SET_MAX_THREADS          _IOW('b', 5, __u32)
 249 #define BINDER_SET_IDLE_PRIORITY        _IOW('b', 6, __s32)
 250 #define BINDER_SET_CONTEXT_MGR          _IOW('b', 7, __s32)
 251 #define BINDER_THREAD_EXIT              _IOW('b', 8, __s32)
 252 #define BINDER_VERSION                  _IOWR('b', 9, struct binder_version)
 253 #define BINDER_GET_NODE_DEBUG_INFO      _IOWR('b', 11, struct binder_node_debug_info)
 254
 255 /*
 256  * NOTE: Two special error codes you should check for when calling
 257  * in to the driver are:
 258  *
 259  * EINTR -- The operation has been interupted.  This should be
 260  * handled by retrying the ioctl() until a different error code
 261  * is returned.
 262  *
 263  * ECONNREFUSED -- The driver is no longer accepting operations
 264  * from your process.  That is, the process is being destroyed.
 265  * You should handle this by exiting from your process.  Note
 266  * that once this error code is returned, all further calls to
 267  * the driver from any thread will return this same code.
 268  */
 269
 270 enum transaction_flags {
 271         TF_ONE_WAY      = 0x01, /* this is a one-way call: async, no return */
 272         TF_ROOT_OBJECT  = 0x04, /* contents are the component's root object */
 273         TF_STATUS_CODE  = 0x08, /* contents are a 32-bit status code */
 274         TF_ACCEPT_FDS   = 0x10, /* allow replies with file descriptors */
 275 };
 276
 277 struct binder_transaction_data {
 278         /* The first two are only used for bcTRANSACTION and brTRANSACTION,
 279          * identifying the target and contents of the transaction.
 280          */
 281         union {
 282                 /* target descriptor of command transaction */
 283                 __u32   handle;
 284                 /* target descriptor of return transaction */
 285                 binder_uintptr_t ptr;
 286         } target;
 287         binder_uintptr_t        cookie; /* target object cookie */
 288         __u32           code;           /* transaction command */
 289
 290         /* General information about the transaction. */
 291         __u32           flags;
 292         pid_t           sender_pid;
 293         uid_t           sender_euid;
 294         binder_size_t   data_size;      /* number of bytes of data */
 295         binder_size_t   offsets_size;   /* number of bytes of offsets */
 296
 297         /* If this transaction is inline, the data immediately
 298          * follows here; otherwise, it ends with a pointer to
 299          * the data buffer.
 300          */
 301         union {
 302                 struct {
 303                         /* transaction data */
 304                         binder_uintptr_t        buffer;
 305                         /* offsets from buffer to flat_binder_object structs */
 306                         binder_uintptr_t        offsets;
 307                 } ptr;
 308                 __u8    buf[8];
 309         } data;
 310 };
 311
 312 struct binder_transaction_data_sg {
 313         struct binder_transaction_data transaction_data;
 314         binder_size_t buffers_size;
 315 };
 316
 317 struct binder_ptr_cookie {
 318         binder_uintptr_t ptr;
 319         binder_uintptr_t cookie;
 320 };
 321
 322 struct binder_handle_cookie {
 323         __u32 handle;
 324         binder_uintptr_t cookie;
 325 } __attribute__((packed));
 326
 327 struct binder_pri_desc {
 328         __s32 priority;
 329         __u32 desc;
 330 };
 331
 332 struct binder_pri_ptr_cookie {
 333         __s32 priority;
 334         binder_uintptr_t ptr;
 335         binder_uintptr_t cookie;
 336 };
 337
 338 enum binder_driver_return_protocol {
 339         BR_ERROR = _IOR('r', 0, __s32),
 340         /*
 341          * int: error code
 342          */
 343
 344         BR_OK = _IO('r', 1),
 345         /* No parameters! */
 346
 347         BR_TRANSACTION = _IOR('r', 2, struct binder_transaction_data),
 348         BR_REPLY = _IOR('r', 3, struct binder_transaction_data),
 349         /*
 350          * binder_transaction_data: the received command.
 351          */
 352
 353         BR_ACQUIRE_RESULT = _IOR('r', 4, __s32),
 354         /*
 355          * not currently supported
 356          * int: 0 if the last bcATTEMPT_ACQUIRE was not successful.
 357          * Else the remote object has acquired a primary reference.
 358          */
 359
 360         BR_DEAD_REPLY = _IO('r', 5),
 361         /*
 362          * The target of the last transaction (either a bcTRANSACTION or
 363          * a bcATTEMPT_ACQUIRE) is no longer with us.  No parameters.
 364          */
 365
 366         BR_TRANSACTION_COMPLETE = _IO('r', 6),
 367         /*
 368          * No parameters... always refers to the last transaction requested
 369          * (including replies).  Note that this will be sent even for
 370          * asynchronous transactions.
 371          */
 372
 373         BR_INCREFS = _IOR('r', 7, struct binder_ptr_cookie),
 374         BR_ACQUIRE = _IOR('r', 8, struct binder_ptr_cookie),
 375         BR_RELEASE = _IOR('r', 9, struct binder_ptr_cookie),
 376         BR_DECREFS = _IOR('r', 10, struct binder_ptr_cookie),
 377         /*
 378          * void *:      ptr to binder
 379          * void *: cookie for binder
 380          */
 381
 382         BR_ATTEMPT_ACQUIRE = _IOR('r', 11, struct binder_pri_ptr_cookie),
 383         /*
 384          * not currently supported
 385          * int: priority
 386          * void *: ptr to binder
 387          * void *: cookie for binder
 388          */
 389
 390         BR_NOOP = _IO('r', 12),
 391         /*
 392          * No parameters.  Do nothing and examine the next command.  It exists
 393          * primarily so that we can replace it with a BR_SPAWN_LOOPER command.
 394          */
 395
 396         BR_SPAWN_LOOPER = _IO('r', 13),
 397         /*
 398          * No parameters.  The driver has determined that a process has no
 399          * threads waiting to service incoming transactions.  When a process
 400          * receives this command, it must spawn a new service thread and
 401          * register it via bcENTER_LOOPER.
 402          */
 403
 404         BR_FINISHED = _IO('r', 14),
 405         /*
 406          * not currently supported
 407          * stop threadpool thread
 408          */
 409
 410         BR_DEAD_BINDER = _IOR('r', 15, binder_uintptr_t),
 411         /*
 412          * void *: cookie
 413          */
 414         BR_CLEAR_DEATH_NOTIFICATION_DONE = _IOR('r', 16, binder_uintptr_t),
 415         /*
 416          * void *: cookie
 417          */
 418
 419         BR_FAILED_REPLY = _IO('r', 17),
 420         /*
 421          * The the last transaction (either a bcTRANSACTION or
 422          * a bcATTEMPT_ACQUIRE) failed (e.g. out of memory).  No parameters.
 423          */
 424 };
 425
 426 enum binder_driver_command_protocol {
 427         BC_TRANSACTION = _IOW('c', 0, struct binder_transaction_data),
 428         BC_REPLY = _IOW('c', 1, struct binder_transaction_data),
 429         /*
 430          * binder_transaction_data: the sent command.
 431          */
 432
 433         BC_ACQUIRE_RESULT = _IOW('c', 2, __s32),
 434         /*
 435          * not currently supported
 436          * int:  0 if the last BR_ATTEMPT_ACQUIRE was not successful.
 437          * Else you have acquired a primary reference on the object.
 438          */
 439
 440         BC_FREE_BUFFER = _IOW('c', 3, binder_uintptr_t),
 441         /*
 442          * void *: ptr to transaction data received on a read
 443          */
 444
 445         BC_INCREFS = _IOW('c', 4, __u32),
 446         BC_ACQUIRE = _IOW('c', 5, __u32),
 447         BC_RELEASE = _IOW('c', 6, __u32),
 448         BC_DECREFS = _IOW('c', 7, __u32),
 449         /*
 450          * int: descriptor
 451          */
 452
 453         BC_INCREFS_DONE = _IOW('c', 8, struct binder_ptr_cookie),
 454         BC_ACQUIRE_DONE = _IOW('c', 9, struct binder_ptr_cookie),
 455         /*
 456          * void *: ptr to binder
 457          * void *: cookie for binder
 458          */
 459
 460         BC_ATTEMPT_ACQUIRE = _IOW('c', 10, struct binder_pri_desc),
 461         /*
 462          * not currently supported
 463          * int: priority
 464          * int: descriptor
 465          */
 466
 467         BC_REGISTER_LOOPER = _IO('c', 11),
 468         /*
 469          * No parameters.
 470          * Register a spawned looper thread with the device.
 471          */
 472
 473         BC_ENTER_LOOPER = _IO('c', 12),
 474         BC_EXIT_LOOPER = _IO('c', 13),
 475         /*
 476          * No parameters.
 477          * These two commands are sent as an application-level thread
 478          * enters and exits the binder loop, respectively.  They are
 479          * used so the binder can have an accurate count of the number
 480          * of looping threads it has available.
 481          */
 482
 483         BC_REQUEST_DEATH_NOTIFICATION = _IOW('c', 14, struct binder_handle_cookie),
 484         /*
 485          * int: handle
 486          * void *: cookie
 487          */
 488
 489         BC_CLEAR_DEATH_NOTIFICATION = _IOW('c', 15, struct binder_handle_cookie),
 490         /*
 491          * int: handle
 492          * void *: cookie
 493          */
 494
 495         BC_DEAD_BINDER_DONE = _IOW('c', 16, binder_uintptr_t),
 496         /*
 497          * void *: cookie
 498          */
 499
 500         BC_TRANSACTION_SG = _IOW('c', 17, struct binder_transaction_data_sg),
 501         BC_REPLY_SG = _IOW('c', 18, struct binder_transaction_data_sg),
 502         /*
 503          * binder_transaction_data_sg: the sent command.
 504          */
 505 };
 506
 507 #endif /* _UAPI_LINUX_BINDER_H */
 508