adb.h revision f366b3698b409405e1ee88476d1186f29fe14b06 
1/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef __ADB_H
18#define __ADB_H
19
20#include <limits.h>
21
22#include "transport.h"  /* readx(), writex() */
23
24#define MAX_PAYLOAD 4096
25
26#define A_SYNC 0x434e5953
27#define A_CNXN 0x4e584e43
28#define A_OPEN 0x4e45504f
29#define A_OKAY 0x59414b4f
30#define A_CLSE 0x45534c43
31#define A_WRTE 0x45545257
32
33#define A_VERSION 0x01000000        // ADB protocol version
34
35#define ADB_VERSION_MAJOR 1         // Used for help/version information
36#define ADB_VERSION_MINOR 0         // Used for help/version information
37
38#define ADB_SERVER_VERSION    29    // Increment this when we want to force users to start a new adb server
39
40typedef struct amessage amessage;
41typedef struct apacket apacket;
42typedef struct asocket asocket;
43typedef struct alistener alistener;
44typedef struct aservice aservice;
45typedef struct atransport atransport;
46typedef struct adisconnect  adisconnect;
47typedef struct usb_handle usb_handle;
48
49struct amessage {
50    unsigned command;       /* command identifier constant      */
51    unsigned arg0;          /* first argument                   */
52    unsigned arg1;          /* second argument                  */
53    unsigned data_length;   /* length of payload (0 is allowed) */
54    unsigned data_check;    /* checksum of data payload         */
55    unsigned magic;         /* command ^ 0xffffffff             */
56};
57
58struct apacket
59{
60    apacket *next;
61
62    unsigned len;
63    unsigned char *ptr;
64
65    amessage msg;
66    unsigned char data[MAX_PAYLOAD];
67};
68
69/* An asocket represents one half of a connection between a local and
70** remote entity.  A local asocket is bound to a file descriptor.  A
71** remote asocket is bound to the protocol engine.
72*/
73struct asocket {
74        /* chain pointers for the local/remote list of
75        ** asockets that this asocket lives in
76        */
77    asocket *next;
78    asocket *prev;
79
80        /* the unique identifier for this asocket
81        */
82    unsigned id;
83
84        /* flag: set when the socket's peer has closed
85        ** but packets are still queued for delivery
86        */
87    int    closing;
88
89        /* flag: quit adbd when both ends close the
90        ** local service socket
91        */
92    int    exit_on_close;
93
94        /* the asocket we are connected to
95        */
96
97    asocket *peer;
98
99        /* For local asockets, the fde is used to bind
100        ** us to our fd event system.  For remote asockets
101        ** these fields are not used.
102        */
103    fdevent fde;
104    int fd;
105
106        /* queue of apackets waiting to be written
107        */
108    apacket *pkt_first;
109    apacket *pkt_last;
110
111        /* enqueue is called by our peer when it has data
112        ** for us.  It should return 0 if we can accept more
113        ** data or 1 if not.  If we return 1, we must call
114        ** peer->ready() when we once again are ready to
115        ** receive data.
116        */
117    int (*enqueue)(asocket *s, apacket *pkt);
118
119        /* ready is called by the peer when it is ready for
120        ** us to send data via enqueue again
121        */
122    void (*ready)(asocket *s);
123
124        /* close is called by the peer when it has gone away.
125        ** we are not allowed to make any further calls on the
126        ** peer once our close method is called.
127        */
128    void (*close)(asocket *s);
129
130        /* socket-type-specific extradata */
131    void *extra;
132
133    	/* A socket is bound to atransport */
134    atransport *transport;
135};
136
137
138/* the adisconnect structure is used to record a callback that
139** will be called whenever a transport is disconnected (e.g. by the user)
140** this should be used to cleanup objects that depend on the
141** transport (e.g. remote sockets, listeners, etc...)
142*/
143struct  adisconnect
144{
145    void        (*func)(void*  opaque, atransport*  t);
146    void*         opaque;
147    adisconnect*  next;
148    adisconnect*  prev;
149};
150
151
152/* a transport object models the connection to a remote device or emulator
153** there is one transport per connected device/emulator. a "local transport"
154** connects through TCP (for the emulator), while a "usb transport" through
155** USB (for real devices)
156**
157** note that kTransportHost doesn't really correspond to a real transport
158** object, it's a special value used to indicate that a client wants to
159** connect to a service implemented within the ADB server itself.
160*/
161typedef enum transport_type {
162        kTransportUsb,
163        kTransportLocal,
164        kTransportAny,
165        kTransportHost,
166} transport_type;
167
168struct atransport
169{
170    atransport *next;
171    atransport *prev;
172
173    int (*read_from_remote)(apacket *p, atransport *t);
174    int (*write_to_remote)(apacket *p, atransport *t);
175    void (*close)(atransport *t);
176    void (*kick)(atransport *t);
177
178    int fd;
179    int transport_socket;
180    fdevent transport_fde;
181    int ref_count;
182    unsigned sync_token;
183    int connection_state;
184    transport_type type;
185
186        /* usb handle or socket fd as needed */
187    usb_handle *usb;
188    int sfd;
189
190        /* used to identify transports for clients */
191    char *serial;
192    char *product;
193    int adb_port; // Use for emulators (local transport)
194
195        /* a list of adisconnect callbacks called when the transport is kicked */
196    int          kicked;
197    adisconnect  disconnects;
198};
199
200
201/* A listener is an entity which binds to a local port
202** and, upon receiving a connection on that port, creates
203** an asocket to connect the new local connection to a
204** specific remote service.
205**
206** TODO: some listeners read from the new connection to
207** determine what exact service to connect to on the far
208** side.
209*/
210struct alistener
211{
212    alistener *next;
213    alistener *prev;
214
215    fdevent fde;
216    int fd;
217
218    const char *local_name;
219    const char *connect_to;
220    atransport *transport;
221    adisconnect  disconnect;
222};
223
224
225void print_packet(const char *label, apacket *p);
226
227asocket *find_local_socket(unsigned id);
228void install_local_socket(asocket *s);
229void remove_socket(asocket *s);
230void close_all_sockets(atransport *t);
231
232#define  LOCAL_CLIENT_PREFIX  "emulator-"
233
234asocket *create_local_socket(int fd);
235asocket *create_local_service_socket(const char *destination);
236
237asocket *create_remote_socket(unsigned id, atransport *t);
238void connect_to_remote(asocket *s, const char *destination);
239void connect_to_smartsocket(asocket *s);
240
241void fatal(const char *fmt, ...);
242void fatal_errno(const char *fmt, ...);
243
244void handle_packet(apacket *p, atransport *t);
245void send_packet(apacket *p, atransport *t);
246
247void get_my_path(char *s, size_t maxLen);
248int launch_server(int server_port);
249int adb_main(int is_daemon, int server_port);
250
251
252/* transports are ref-counted
253** get_device_transport does an acquire on your behalf before returning
254*/
255void init_transport_registration(void);
256int  list_transports(char *buf, size_t  bufsize);
257void update_transports(void);
258
259asocket*  create_device_tracker(void);
260
261/* Obtain a transport from the available transports.
262** If state is != CS_ANY, only transports in that state are considered.
263** If serial is non-NULL then only the device with that serial will be chosen.
264** If no suitable transport is found, error is set.
265*/
266atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char **error_out);
267void   add_transport_disconnect( atransport*  t, adisconnect*  dis );
268void   remove_transport_disconnect( atransport*  t, adisconnect*  dis );
269void   run_transport_disconnects( atransport*  t );
270void   kick_transport( atransport*  t );
271
272/* initialize a transport object's func pointers and state */
273#if ADB_HOST
274int get_available_local_transport_index();
275#endif
276int  init_socket_transport(atransport *t, int s, int port, int local);
277void init_usb_transport(atransport *t, usb_handle *usb, int state);
278
279/* for MacOS X cleanup */
280void close_usb_devices();
281
282/* cause new transports to be init'd and added to the list */
283void register_socket_transport(int s, const char *serial, int port, int local);
284
285/* these should only be used for the "adb disconnect" command */
286void unregister_transport(atransport *t);
287void unregister_all_tcp_transports();
288
289void register_usb_transport(usb_handle *h, const char *serial, unsigned writeable);
290
291/* this should only be used for transports with connection_state == CS_NOPERM */
292void unregister_usb_transport(usb_handle *usb);
293
294atransport *find_transport(const char *serial);
295#if ADB_HOST
296atransport* find_emulator_transport_by_adb_port(int adb_port);
297#endif
298
299int service_to_fd(const char *name);
300#if ADB_HOST
301asocket *host_service_to_socket(const char*  name, const char *serial);
302#endif
303
304#if !ADB_HOST
305int       init_jdwp(void);
306asocket*  create_jdwp_service_socket();
307asocket*  create_jdwp_tracker_service_socket();
308int       create_jdwp_connection_fd(int  jdwp_pid);
309#endif
310
311#if !ADB_HOST
312typedef enum {
313    BACKUP,
314    RESTORE
315} BackupOperation;
316int backup_service(BackupOperation operation, char* args);
317void framebuffer_service(int fd, void *cookie);
318void log_service(int fd, void *cookie);
319void remount_service(int fd, void *cookie);
320char * get_log_file_path(const char * log_name);
321#endif
322
323/* packet allocator */
324apacket *get_apacket(void);
325void put_apacket(apacket *p);
326
327int check_header(apacket *p);
328int check_data(apacket *p);
329
330/* define ADB_TRACE to 1 to enable tracing support, or 0 to disable it */
331
332#define  ADB_TRACE    1
333
334/* IMPORTANT: if you change the following list, don't
335 * forget to update the corresponding 'tags' table in
336 * the adb_trace_init() function implemented in adb.c
337 */
338typedef enum {
339    TRACE_ADB = 0,   /* 0x001 */
340    TRACE_SOCKETS,
341    TRACE_PACKETS,
342    TRACE_TRANSPORT,
343    TRACE_RWX,       /* 0x010 */
344    TRACE_USB,
345    TRACE_SYNC,
346    TRACE_SYSDEPS,
347    TRACE_JDWP,      /* 0x100 */
348    TRACE_SERVICES,
349} AdbTrace;
350
351#if ADB_TRACE
352
353#if !ADB_HOST
354/*
355 * When running inside the emulator, guest's adbd can connect to 'adb-debug'
356 * qemud service that can display adb trace messages (on condition that emulator
357 * has been started with '-debug adb' option).
358 */
359
360/* Delivers a trace message to the emulator via QEMU pipe. */
361void adb_qemu_trace(const char* fmt, ...);
362/* Macro to use to send ADB trace messages to the emulator. */
363#define DQ(...)    adb_qemu_trace(__VA_ARGS__)
364#else
365#define DQ(...) ((void)0)
366#endif  /* !ADB_HOST */
367
368  extern int     adb_trace_mask;
369  extern unsigned char    adb_trace_output_count;
370  void    adb_trace_init(void);
371
372#  define ADB_TRACING  ((adb_trace_mask & (1 << TRACE_TAG)) != 0)
373
374  /* you must define TRACE_TAG before using this macro */
375#  define  D(...)                                      \
376        do {                                           \
377            if (ADB_TRACING) {                         \
378                int save_errno = errno;                \
379                adb_mutex_lock(&D_lock);               \
380                fprintf(stderr, "%s::%s():",           \
381                        __FILE__, __FUNCTION__);       \
382                errno = save_errno;                    \
383                fprintf(stderr, __VA_ARGS__ );         \
384                fflush(stderr);                        \
385                adb_mutex_unlock(&D_lock);             \
386                errno = save_errno;                    \
387           }                                           \
388        } while (0)
389#  define  DR(...)                                     \
390        do {                                           \
391            if (ADB_TRACING) {                         \
392                int save_errno = errno;                \
393                adb_mutex_lock(&D_lock);               \
394                errno = save_errno;                    \
395                fprintf(stderr, __VA_ARGS__ );         \
396                fflush(stderr);                        \
397                adb_mutex_unlock(&D_lock);             \
398                errno = save_errno;                    \
399           }                                           \
400        } while (0)
401#else
402#  define  D(...)          ((void)0)
403#  define  DR(...)         ((void)0)
404#  define  ADB_TRACING     0
405#endif
406
407
408#if !TRACE_PACKETS
409#define print_packet(tag,p) do {} while (0)
410#endif
411
412#if ADB_HOST_ON_TARGET
413/* adb and adbd are coexisting on the target, so use 5038 for adb
414 * to avoid conflicting with adbd's usage of 5037
415 */
416#  define DEFAULT_ADB_PORT 5038
417#else
418#  define DEFAULT_ADB_PORT 5037
419#endif
420
421#define DEFAULT_ADB_LOCAL_TRANSPORT_PORT 5555
422
423#define ADB_CLASS              0xff
424#define ADB_SUBCLASS           0x42
425#define ADB_PROTOCOL           0x1
426
427
428void local_init(int port);
429int  local_connect(int  port);
430int  local_connect_arbitrary_ports(int console_port, int adb_port);
431
432/* usb host/client interface */
433void usb_init();
434void usb_cleanup();
435int usb_write(usb_handle *h, const void *data, int len);
436int usb_read(usb_handle *h, void *data, int len);
437int usb_close(usb_handle *h);
438void usb_kick(usb_handle *h);
439
440/* used for USB device detection */
441#if ADB_HOST
442int is_adb_interface(int vid, int pid, int usb_class, int usb_subclass, int usb_protocol);
443#endif
444
445unsigned host_to_le32(unsigned n);
446int adb_commandline(int argc, char **argv);
447
448int connection_state(atransport *t);
449
450#define CS_ANY       -1
451#define CS_OFFLINE    0
452#define CS_BOOTLOADER 1
453#define CS_DEVICE     2
454#define CS_HOST       3
455#define CS_RECOVERY   4
456#define CS_NOPERM     5 /* Insufficient permissions to communicate with the device */
457#define CS_SIDELOAD   6
458
459extern int HOST;
460extern int SHELL_EXIT_NOTIFY_FD;
461
462#define CHUNK_SIZE (64*1024)
463
464int sendfailmsg(int fd, const char *reason);
465int handle_host_request(char *service, transport_type ttype, char* serial, int reply_fd, asocket *s);
466
467#endif
468