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 40 typedef struct amessage amessage; 41 typedef struct apacket apacket; 42 typedef struct asocket asocket; 43 typedef struct alistener alistener; 44 typedef struct aservice aservice; 45 typedef struct atransport atransport; 46 typedef struct adisconnect adisconnect; 47 typedef struct usb_handle usb_handle; 48 49 struct 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 58 struct 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 */ 73 struct 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 /* the asocket we are connected to 90 */ 91 92 asocket *peer; 93 94 /* For local asockets, the fde is used to bind 95 ** us to our fd event system. For remote asockets 96 ** these fields are not used. 97 */ 98 fdevent fde; 99 int fd; 100 101 /* queue of apackets waiting to be written 102 */ 103 apacket *pkt_first; 104 apacket *pkt_last; 105 106 /* enqueue is called by our peer when it has data 107 ** for us. It should return 0 if we can accept more 108 ** data or 1 if not. If we return 1, we must call 109 ** peer->ready() when we once again are ready to 110 ** receive data. 111 */ 112 int (*enqueue)(asocket *s, apacket *pkt); 113 114 /* ready is called by the peer when it is ready for 115 ** us to send data via enqueue again 116 */ 117 void (*ready)(asocket *s); 118 119 /* close is called by the peer when it has gone away. 120 ** we are not allowed to make any further calls on the 121 ** peer once our close method is called. 122 */ 123 void (*close)(asocket *s); 124 125 /* socket-type-specific extradata */ 126 void *extra; 127 128 /* A socket is bound to atransport */ 129 atransport *transport; 130 }; 131 132 133 /* the adisconnect structure is used to record a callback that 134 ** will be called whenever a transport is disconnected (e.g. by the user) 135 ** this should be used to cleanup objects that depend on the 136 ** transport (e.g. remote sockets, listeners, etc...) 137 */ 138 struct adisconnect 139 { 140 void (*func)(void* opaque, atransport* t); 141 void* opaque; 142 adisconnect* next; 143 adisconnect* prev; 144 }; 145 146 147 /* a transport object models the connection to a remote device or emulator 148 ** there is one transport per connected device/emulator. a "local transport" 149 ** connects through TCP (for the emulator), while a "usb transport" through 150 ** USB (for real devices) 151 ** 152 ** note that kTransportHost doesn't really correspond to a real transport 153 ** object, it's a special value used to indicate that a client wants to 154 ** connect to a service implemented within the ADB server itself. 155 */ 156 typedef enum transport_type { 157 kTransportUsb, 158 kTransportLocal, 159 kTransportAny, 160 kTransportHost, 161 } transport_type; 162 163 struct atransport 164 { 165 atransport *next; 166 atransport *prev; 167 168 int (*read_from_remote)(apacket *p, atransport *t); 169 int (*write_to_remote)(apacket *p, atransport *t); 170 void (*close)(atransport *t); 171 void (*kick)(atransport *t); 172 173 int fd; 174 int transport_socket; 175 fdevent transport_fde; 176 int ref_count; 177 unsigned sync_token; 178 int connection_state; 179 transport_type type; 180 181 /* usb handle or socket fd as needed */ 182 usb_handle *usb; 183 int sfd; 184 185 /* used to identify transports for clients */ 186 char *serial; 187 char *product; 188 int adb_port; // Use for emulators (local transport) 189 190 /* a list of adisconnect callbacks called when the transport is kicked */ 191 int kicked; 192 adisconnect disconnects; 193 }; 194 195 196 /* A listener is an entity which binds to a local port 197 ** and, upon receiving a connection on that port, creates 198 ** an asocket to connect the new local connection to a 199 ** specific remote service. 200 ** 201 ** TODO: some listeners read from the new connection to 202 ** determine what exact service to connect to on the far 203 ** side. 204 */ 205 struct alistener 206 { 207 alistener *next; 208 alistener *prev; 209 210 fdevent fde; 211 int fd; 212 213 const char *local_name; 214 const char *connect_to; 215 atransport *transport; 216 adisconnect disconnect; 217 }; 218 219 220 void print_packet(const char *label, apacket *p); 221 222 asocket *find_local_socket(unsigned id); 223 void install_local_socket(asocket *s); 224 void remove_socket(asocket *s); 225 void close_all_sockets(atransport *t); 226 227 #define LOCAL_CLIENT_PREFIX "emulator-" 228 229 asocket *create_local_socket(int fd); 230 asocket *create_local_service_socket(const char *destination); 231 232 asocket *create_remote_socket(unsigned id, atransport *t); 233 void connect_to_remote(asocket *s, const char *destination); 234 void connect_to_smartsocket(asocket *s); 235 236 void fatal(const char *fmt, ...); 237 void fatal_errno(const char *fmt, ...); 238 239 void handle_packet(apacket *p, atransport *t); 240 void send_packet(apacket *p, atransport *t); 241 242 void get_my_path(char *s, size_t maxLen); 243 int launch_server(int server_port); 244 int adb_main(int is_daemon, int server_port); 245 246 247 /* transports are ref-counted 248 ** get_device_transport does an acquire on your behalf before returning 249 */ 250 void init_transport_registration(void); 251 int list_transports(char *buf, size_t bufsize); 252 void update_transports(void); 253 254 asocket* create_device_tracker(void); 255 256 /* Obtain a transport from the available transports. 257 ** If state is != CS_ANY, only transports in that state are considered. 258 ** If serial is non-NULL then only the device with that serial will be chosen. 259 ** If no suitable transport is found, error is set. 260 */ 261 atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char **error_out); 262 void add_transport_disconnect( atransport* t, adisconnect* dis ); 263 void remove_transport_disconnect( atransport* t, adisconnect* dis ); 264 void run_transport_disconnects( atransport* t ); 265 void kick_transport( atransport* t ); 266 267 /* initialize a transport object's func pointers and state */ 268 #if ADB_HOST 269 int get_available_local_transport_index(); 270 #endif 271 int init_socket_transport(atransport *t, int s, int port, int local); 272 void init_usb_transport(atransport *t, usb_handle *usb, int state); 273 274 /* for MacOS X cleanup */ 275 void close_usb_devices(); 276 277 /* cause new transports to be init'd and added to the list */ 278 void register_socket_transport(int s, const char *serial, int port, int local); 279 280 /* these should only be used for the "adb disconnect" command */ 281 void unregister_transport(atransport *t); 282 void unregister_all_tcp_transports(); 283 284 void register_usb_transport(usb_handle *h, const char *serial, unsigned writeable); 285 286 /* this should only be used for transports with connection_state == CS_NOPERM */ 287 void unregister_usb_transport(usb_handle *usb); 288 289 atransport *find_transport(const char *serial); 290 #if ADB_HOST 291 atransport* find_emulator_transport_by_adb_port(int adb_port); 292 #endif 293 294 int service_to_fd(const char *name); 295 #if ADB_HOST 296 asocket *host_service_to_socket(const char* name, const char *serial); 297 #endif 298 299 #if !ADB_HOST 300 int init_jdwp(void); 301 asocket* create_jdwp_service_socket(); 302 asocket* create_jdwp_tracker_service_socket(); 303 int create_jdwp_connection_fd(int jdwp_pid); 304 #endif 305 306 #if !ADB_HOST 307 typedef enum { 308 BACKUP, 309 RESTORE 310 } BackupOperation; 311 int backup_service(BackupOperation operation, char* args); 312 void framebuffer_service(int fd, void *cookie); 313 void log_service(int fd, void *cookie); 314 void remount_service(int fd, void *cookie); 315 char * get_log_file_path(const char * log_name); 316 #endif 317 318 /* packet allocator */ 319 apacket *get_apacket(void); 320 void put_apacket(apacket *p); 321 322 int check_header(apacket *p); 323 int check_data(apacket *p); 324 325 /* define ADB_TRACE to 1 to enable tracing support, or 0 to disable it */ 326 327 #define ADB_TRACE 1 328 329 /* IMPORTANT: if you change the following list, don't 330 * forget to update the corresponding 'tags' table in 331 * the adb_trace_init() function implemented in adb.c 332 */ 333 typedef enum { 334 TRACE_ADB = 0, /* 0x001 */ 335 TRACE_SOCKETS, 336 TRACE_PACKETS, 337 TRACE_TRANSPORT, 338 TRACE_RWX, /* 0x010 */ 339 TRACE_USB, 340 TRACE_SYNC, 341 TRACE_SYSDEPS, 342 TRACE_JDWP, /* 0x100 */ 343 TRACE_SERVICES, 344 } AdbTrace; 345 346 #if ADB_TRACE 347 348 extern int adb_trace_mask; 349 extern unsigned char adb_trace_output_count; 350 void adb_trace_init(void); 351 352 # define ADB_TRACING ((adb_trace_mask & (1 << TRACE_TAG)) != 0) 353 354 /* you must define TRACE_TAG before using this macro */ 355 # define D(...) \ 356 do { \ 357 if (ADB_TRACING) { \ 358 int save_errno = errno; \ 359 adb_mutex_lock(&D_lock); \ 360 fprintf(stderr, "%s::%s():", \ 361 __FILE__, __FUNCTION__); \ 362 errno = save_errno; \ 363 fprintf(stderr, __VA_ARGS__ ); \ 364 fflush(stderr); \ 365 adb_mutex_unlock(&D_lock); \ 366 errno = save_errno; \ 367 } \ 368 } while (0) 369 # define DR(...) \ 370 do { \ 371 if (ADB_TRACING) { \ 372 int save_errno = errno; \ 373 adb_mutex_lock(&D_lock); \ 374 errno = save_errno; \ 375 fprintf(stderr, __VA_ARGS__ ); \ 376 fflush(stderr); \ 377 adb_mutex_unlock(&D_lock); \ 378 errno = save_errno; \ 379 } \ 380 } while (0) 381 #else 382 # define D(...) ((void)0) 383 # define DR(...) ((void)0) 384 # define ADB_TRACING 0 385 #endif 386 387 388 #if !TRACE_PACKETS 389 #define print_packet(tag,p) do {} while (0) 390 #endif 391 392 #if ADB_HOST_ON_TARGET 393 /* adb and adbd are coexisting on the target, so use 5038 for adb 394 * to avoid conflicting with adbd's usage of 5037 395 */ 396 # define DEFAULT_ADB_PORT 5038 397 #else 398 # define DEFAULT_ADB_PORT 5037 399 #endif 400 401 #define DEFAULT_ADB_LOCAL_TRANSPORT_PORT 5555 402 403 #define ADB_CLASS 0xff 404 #define ADB_SUBCLASS 0x42 405 #define ADB_PROTOCOL 0x1 406 407 408 void local_init(int port); 409 int local_connect(int port); 410 int local_connect_arbitrary_ports(int console_port, int adb_port); 411 412 /* usb host/client interface */ 413 void usb_init(); 414 void usb_cleanup(); 415 int usb_write(usb_handle *h, const void *data, int len); 416 int usb_read(usb_handle *h, void *data, int len); 417 int usb_close(usb_handle *h); 418 void usb_kick(usb_handle *h); 419 420 /* used for USB device detection */ 421 #if ADB_HOST 422 int is_adb_interface(int vid, int pid, int usb_class, int usb_subclass, int usb_protocol); 423 #endif 424 425 unsigned host_to_le32(unsigned n); 426 int adb_commandline(int argc, char **argv); 427 428 int connection_state(atransport *t); 429 430 #define CS_ANY -1 431 #define CS_OFFLINE 0 432 #define CS_BOOTLOADER 1 433 #define CS_DEVICE 2 434 #define CS_HOST 3 435 #define CS_RECOVERY 4 436 #define CS_NOPERM 5 /* Insufficient permissions to communicate with the device */ 437 438 extern int HOST; 439 extern int SHELL_EXIT_NOTIFY_FD; 440 441 #define CHUNK_SIZE (64*1024) 442 443 int sendfailmsg(int fd, const char *reason); 444 int handle_host_request(char *service, transport_type ttype, char* serial, int reply_fd, asocket *s); 445 446 #endif 447