2 * Copyright (C) 2007 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #define TRACE_TAG TRACE_TRANSPORT
28 static void transport_unref(atransport *t);
30 static atransport transport_list = {
31 .next = &transport_list,
32 .prev = &transport_list,
35 SDB_MUTEX_DEFINE( transport_lock );
38 static void dump_hex( const unsigned char* ptr, size_t len )
42 if (len2 > 16) len2 = 16;
44 for (nn = 0; nn < len2; nn++)
48 for (nn = 0; nn < len2; nn++) {
50 if (c < 32 || c > 127)
60 kick_transport(atransport* t)
66 sdb_mutex_lock(&transport_lock);
70 sdb_mutex_unlock(&transport_lock);
78 run_transport_disconnects(atransport* t)
80 adisconnect* dis = t->disconnects.next;
82 D("run_transport_disconnects: %p (%s)\n", t, t->serial ? t->serial : "unknown" );
83 while (dis != &t->disconnects) {
84 adisconnect* next = dis->next;
85 dis->func( dis->opaque, t );
91 read_packet(int fd, apacket** ppacket)
93 char *p = (char*)ppacket; /* really read a packet address */
95 int len = sizeof(*ppacket);
97 r = sdb_read(fd, p, len);
102 D("read_packet: %d error %d %d\n", fd, r, errno);
103 if((r < 0) && (errno == EINTR)) continue;
111 unsigned command = (*ppacket)->msg.command;
112 int len = (*ppacket)->msg.data_length;
116 for (n = 0; n < 4; n++) {
117 int b = (command >> (n*8)) & 255;
118 if (b >= 32 && b < 127)
125 D("read_packet: %d ok: [%08x %s] %08x %08x (%d) ",
126 fd, command, cmd, (*ppacket)->msg.arg0, (*ppacket)->msg.arg1, len);
127 dump_hex((*ppacket)->data, len);
134 write_packet(int fd, apacket** ppacket)
136 char *p = (char*) ppacket; /* we really write the packet address */
137 int r, len = sizeof(ppacket);
142 unsigned command = (*ppacket)->msg.command;
143 int len = (*ppacket)->msg.data_length;
147 for (n = 0; n < 4; n++) {
148 int b = (command >> (n*8)) & 255;
149 if (b >= 32 && b < 127)
156 D("write_packet: %d [%08x %s] %08x %08x (%d) ",
157 fd, command, cmd, (*ppacket)->msg.arg0, (*ppacket)->msg.arg1, len);
158 dump_hex((*ppacket)->data, len);
161 len = sizeof(ppacket);
163 r = sdb_write(fd, p, len);
168 D("write_packet: %d error %d %d\n", fd, r, errno);
169 if((r < 0) && (errno == EINTR)) continue;
176 static void transport_socket_events(int fd, unsigned events, void *_t)
178 if(events & FDE_READ){
180 if(read_packet(fd, &p)){
181 D("failed to read packet from transport socket on fd %d\n", fd);
183 handle_packet(p, (atransport *) _t);
188 void send_packet(apacket *p, atransport *t)
194 p->msg.magic = p->msg.command ^ 0xffffffff;
196 count = p->msg.data_length;
197 x = (unsigned char *) p->data;
202 p->msg.data_check = sum;
204 print_packet("send", p);
207 fatal_errno("Transport is null");
208 D("Transport is null \n");
211 if(write_packet(t->transport_socket, &p)){
212 fatal_errno("cannot enqueue packet on transport socket");
216 /* The transport is opened by transport_register_func before
217 ** the input and output threads are started.
219 ** The output thread issues a SYNC(1, token) message to let
220 ** the input thread know to start things up. In the event
221 ** of transport IO failure, the output thread will post a
222 ** SYNC(0,0) message to ensure shutdown.
224 ** The transport will not actually be closed until both
225 ** threads exit, but the input thread will kick the transport
226 ** on its way out to disconnect the underlying device.
229 static void *output_thread(void *_t)
234 D("from_remote: starting thread for transport %p, on fd %d\n", t, t->fd );
236 D("from_remote: transport %p SYNC online (%d)\n", t, t->sync_token + 1);
238 p->msg.command = A_SYNC;
240 p->msg.arg1 = ++(t->sync_token);
241 p->msg.magic = A_SYNC ^ 0xffffffff;
242 if(write_packet(t->fd, &p)) {
244 D("from_remote: failed to write SYNC apacket to transport %p", t);
248 D("from_remote: data pump for transport %p\n", t);
252 if(t->read_from_remote(p, t) == 0){
253 D("from_remote: received remote packet, sending to transport %p\n",
255 if(write_packet(t->fd, &p)){
257 D("from_remote: failed to write apacket to transport %p", t);
261 D("from_remote: remote read failed for transport %p\n", p);
267 D("from_remote: SYNC offline for transport %p\n", t);
269 p->msg.command = A_SYNC;
272 p->msg.magic = A_SYNC ^ 0xffffffff;
273 if(write_packet(t->fd, &p)) {
275 D("from_remote: failed to write SYNC apacket to transport %p", t);
279 D("from_remote: thread is exiting for transport %p\n", t);
285 static void *input_thread(void *_t)
291 D("to_remote: starting input_thread for %p, reading from fd %d\n",
295 if(read_packet(t->fd, &p)) {
296 D("to_remote: failed to read apacket from transport %p on fd %d\n",
300 if(p->msg.command == A_SYNC){
301 if(p->msg.arg0 == 0) {
302 D("to_remote: transport %p SYNC offline\n", t);
306 if(p->msg.arg1 == t->sync_token) {
307 D("to_remote: transport %p SYNC online\n", t);
310 D("to_remote: trandport %p ignoring SYNC %d != %d\n",
311 t, p->msg.arg1, t->sync_token);
316 D("to_remote: transport %p got packet, sending to remote\n", t);
317 t->write_to_remote(p, t);
319 D("to_remote: transport %p ignoring packet while offline\n", t);
326 // this is necessary to avoid a race condition that occured when a transport closes
327 // while a client socket is still active.
328 close_all_sockets(t);
330 D("to_remote: thread is exiting for transport %p, fd %d\n", t, t->fd);
337 static int transport_registration_send = -1;
338 static int transport_registration_recv = -1;
339 static fdevent transport_registration_fde;
343 static int list_transports_msg(char* buffer, size_t bufferlen)
348 len = list_transports(buffer+4, bufferlen-4);
349 snprintf(head, sizeof(head), "%04x", len);
350 memcpy(buffer, head, 4);
355 /* this adds support required by the 'track-devices' service.
356 * this is used to send the content of "list_transport" to any
357 * number of client connections that want it through a single
358 * live TCP connection
360 typedef struct device_tracker device_tracker;
361 struct device_tracker {
364 device_tracker* next;
367 /* linked list of all device trackers */
368 static device_tracker* device_tracker_list;
371 device_tracker_remove( device_tracker* tracker )
373 device_tracker** pnode = &device_tracker_list;
374 device_tracker* node = *pnode;
376 sdb_mutex_lock( &transport_lock );
378 if (node == tracker) {
385 sdb_mutex_unlock( &transport_lock );
389 device_tracker_close( asocket* socket )
391 device_tracker* tracker = (device_tracker*) socket;
392 asocket* peer = socket->peer;
394 D( "device tracker %p removed\n", tracker);
399 device_tracker_remove(tracker);
404 device_tracker_enqueue( asocket* socket, apacket* p )
406 /* you can't read from a device tracker, close immediately */
408 device_tracker_close(socket);
413 device_tracker_send( device_tracker* tracker,
417 apacket* p = get_apacket();
418 asocket* peer = tracker->socket.peer;
420 memcpy(p->data, buffer, len);
422 return peer->enqueue( peer, p );
427 device_tracker_ready( asocket* socket )
429 device_tracker* tracker = (device_tracker*) socket;
431 /* we want to send the device list when the tracker connects
432 * for the first time, even if no update occured */
433 if (tracker->update_needed > 0) {
437 tracker->update_needed = 0;
439 len = list_transports_msg(buffer, sizeof(buffer));
440 device_tracker_send(tracker, buffer, len);
446 create_device_tracker(void)
448 device_tracker* tracker = calloc(1,sizeof(*tracker));
450 if(tracker == 0) fatal("cannot allocate device tracker");
452 D( "device tracker %p created\n", tracker);
454 tracker->socket.enqueue = device_tracker_enqueue;
455 tracker->socket.ready = device_tracker_ready;
456 tracker->socket.close = device_tracker_close;
457 tracker->update_needed = 1;
459 tracker->next = device_tracker_list;
460 device_tracker_list = tracker;
462 return &tracker->socket;
466 /* call this function each time the transport list has changed */
467 void update_transports(void)
471 device_tracker* tracker;
473 len = list_transports_msg(buffer, sizeof(buffer));
475 tracker = device_tracker_list;
476 while (tracker != NULL) {
477 device_tracker* next = tracker->next;
478 /* note: this may destroy the tracker if the connection is closed */
479 device_tracker_send(tracker, buffer, len);
484 void update_transports(void)
486 // nothing to do on the device side
490 typedef struct tmsg tmsg;
493 atransport *transport;
498 transport_read_action(int fd, struct tmsg* m)
501 int len = sizeof(*m);
505 r = sdb_read(fd, p, len);
510 if((r < 0) && (errno == EINTR)) continue;
511 D("transport_read_action: on fd %d, error %d: %s\n",
512 fd, errno, strerror(errno));
520 transport_write_action(int fd, struct tmsg* m)
523 int len = sizeof(*m);
527 r = sdb_write(fd, p, len);
532 if((r < 0) && (errno == EINTR)) continue;
533 D("transport_write_action: on fd %d, error %d: %s\n",
534 fd, errno, strerror(errno));
541 static void transport_registration_func(int _fd, unsigned ev, void *data)
544 sdb_thread_t output_thread_ptr;
545 sdb_thread_t input_thread_ptr;
549 if(!(ev & FDE_READ)) {
553 if(transport_read_action(_fd, &m)) {
554 fatal_errno("cannot read transport registration socket");
560 D("transport: %p removing and free'ing %d\n", t, t->transport_socket);
562 /* IMPORTANT: the remove closes one half of the
563 ** socket pair. The close closes the other half.
565 fdevent_remove(&(t->transport_fde));
568 sdb_mutex_lock(&transport_lock);
569 t->next->prev = t->prev;
570 t->prev->next = t->next;
571 sdb_mutex_unlock(&transport_lock);
573 run_transport_disconnects(t);
580 memset(t,0xee,sizeof(atransport));
587 /* don't create transport threads for inaccessible devices */
588 if (t->connection_state != CS_NOPERM) {
589 /* initial references are the two threads */
592 if(sdb_socketpair(s)) {
593 fatal_errno("cannot open transport socketpair");
596 D("transport: %p (%d,%d) starting\n", t, s[0], s[1]);
598 t->transport_socket = s[0];
601 D("transport: %p install %d\n", t, t->transport_socket );
602 fdevent_install(&(t->transport_fde),
604 transport_socket_events,
607 fdevent_set(&(t->transport_fde), FDE_READ);
609 if(sdb_thread_create(&input_thread_ptr, input_thread, t)){
610 fatal_errno("cannot create input thread");
613 if(sdb_thread_create(&output_thread_ptr, output_thread, t)){
614 fatal_errno("cannot create output thread");
618 /* put us on the master device list */
619 sdb_mutex_lock(&transport_lock);
620 t->next = &transport_list;
621 t->prev = transport_list.prev;
624 sdb_mutex_unlock(&transport_lock);
626 t->disconnects.next = t->disconnects.prev = &t->disconnects;
631 void init_transport_registration(void)
635 if(sdb_socketpair(s)){
636 fatal_errno("cannot open transport registration socketpair");
639 transport_registration_send = s[0];
640 transport_registration_recv = s[1];
642 fdevent_install(&transport_registration_fde,
643 transport_registration_recv,
644 transport_registration_func,
647 fdevent_set(&transport_registration_fde, FDE_READ);
650 /* the fdevent select pump is single threaded */
651 static void register_transport(atransport *transport)
654 m.transport = transport;
656 D("transport: %p registered\n", transport);
657 if(transport_write_action(transport_registration_send, &m)) {
658 fatal_errno("cannot write transport registration socket\n");
662 static void remove_transport(atransport *transport)
665 m.transport = transport;
667 D("transport: %p removed\n", transport);
668 if(transport_write_action(transport_registration_send, &m)) {
669 fatal_errno("cannot write transport registration socket\n");
674 static void transport_unref_locked(atransport *t)
677 D("transport: %p R- (ref=%d)\n", t, t->ref_count);
678 if (t->ref_count == 0) {
679 D("transport: %p kicking and closing\n", t);
689 static void transport_unref(atransport *t)
692 sdb_mutex_lock(&transport_lock);
693 transport_unref_locked(t);
694 sdb_mutex_unlock(&transport_lock);
698 void add_transport_disconnect(atransport* t, adisconnect* dis)
700 sdb_mutex_lock(&transport_lock);
701 dis->next = &t->disconnects;
702 dis->prev = dis->next->prev;
703 dis->prev->next = dis;
704 dis->next->prev = dis;
705 sdb_mutex_unlock(&transport_lock);
708 void remove_transport_disconnect(atransport* t, adisconnect* dis)
710 dis->prev->next = dis->next;
711 dis->next->prev = dis->prev;
712 dis->next = dis->prev = dis;
716 atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char** error_out)
719 atransport *result = NULL;
724 *error_out = "device not found";
726 sdb_mutex_lock(&transport_lock);
727 for (t = transport_list.next; t != &transport_list; t = t->next) {
728 if (t->connection_state == CS_NOPERM) {
730 *error_out = "insufficient permissions for device";
734 /* check for matching serial number */
736 if (t->serial && !strcmp(serial, t->serial)) {
741 if (ttype == kTransportUsb && t->type == kTransportUsb) {
744 *error_out = "more than one device";
750 } else if (ttype == kTransportLocal && t->type == kTransportLocal) {
753 *error_out = "more than one emulator";
759 } else if (ttype == kTransportAny) {
762 *error_out = "more than one device and emulator";
771 sdb_mutex_unlock(&transport_lock);
774 /* offline devices are ignored -- they are either being born or dying */
775 if (result && result->connection_state == CS_OFFLINE) {
777 *error_out = "device offline";
780 /* check for required connection state */
781 if (result && state != CS_ANY && result->connection_state != state) {
783 *error_out = "invalid device state";
789 /* found one that we can take */
792 } else if (state != CS_ANY && (serial || !ambiguous)) {
801 static const char *statename(atransport *t)
803 switch(t->connection_state){
804 case CS_OFFLINE: return "offline";
805 case CS_BOOTLOADER: return "bootloader";
806 case CS_DEVICE: return "device";
807 case CS_HOST: return "host";
808 case CS_RECOVERY: return "recovery";
809 case CS_NOPERM: return "no permissions";
810 default: return "unknown";
814 int list_transports(char *buf, size_t bufsize)
817 char* end = buf + bufsize;
821 /* XXX OVERRUN PROBLEMS XXX */
822 sdb_mutex_lock(&transport_lock);
823 for(t = transport_list.next; t != &transport_list; t = t->next) {
824 const char* serial = t->serial;
825 if (!serial || !serial[0])
826 serial = "????????????";
827 len = snprintf(p, end - p, "%s\t%s\n", serial, statename(t));
829 if (p + len >= end) {
830 /* discard last line if buffer is too short */
836 sdb_mutex_unlock(&transport_lock);
842 void close_usb_devices()
846 sdb_mutex_lock(&transport_lock);
847 for(t = transport_list.next; t != &transport_list; t = t->next) {
853 sdb_mutex_unlock(&transport_lock);
857 void register_socket_transport(int s, const char *serial, int port, int local)
859 atransport *t = calloc(1, sizeof(atransport));
860 D("transport: %p init'ing for socket %d, on port %d\n", t, s, port);
861 if ( init_socket_transport(t, s, port, local) < 0 ) {
867 t->serial = strdup(serial);
869 register_transport(t);
873 atransport *find_transport(const char *serial)
877 sdb_mutex_lock(&transport_lock);
878 for(t = transport_list.next; t != &transport_list; t = t->next) {
879 if (t->serial && !strcmp(serial, t->serial)) {
883 sdb_mutex_unlock(&transport_lock);
885 if (t != &transport_list)
891 void unregister_transport(atransport *t)
893 sdb_mutex_lock(&transport_lock);
894 t->next->prev = t->prev;
895 t->prev->next = t->next;
896 sdb_mutex_unlock(&transport_lock);
902 // unregisters all non-emulator TCP transports
903 void unregister_all_tcp_transports()
905 atransport *t, *next;
906 sdb_mutex_lock(&transport_lock);
907 for (t = transport_list.next; t != &transport_list; t = next) {
909 if (t->type == kTransportLocal && t->sdb_port == 0) {
910 t->next->prev = t->prev;
911 t->prev->next = next;
912 // we cannot call kick_transport when holding transport_lock
918 transport_unref_locked(t);
922 sdb_mutex_unlock(&transport_lock);
927 void register_usb_transport(usb_handle *usb, const char *serial, unsigned writeable)
929 atransport *t = calloc(1, sizeof(atransport));
930 D("transport: %p init'ing for usb_handle %p (sn='%s')\n", t, usb,
931 serial ? serial : "");
932 init_usb_transport(t, usb, (writeable ? CS_OFFLINE : CS_NOPERM));
934 t->serial = strdup(serial);
936 register_transport(t);
939 /* this should only be used for transports with connection_state == CS_NOPERM */
940 void unregister_usb_transport(usb_handle *usb)
943 sdb_mutex_lock(&transport_lock);
944 for(t = transport_list.next; t != &transport_list; t = t->next) {
945 if (t->usb == usb && t->connection_state == CS_NOPERM) {
946 t->next->prev = t->prev;
947 t->prev->next = t->next;
951 sdb_mutex_unlock(&transport_lock);
955 #define TRACE_TAG TRACE_RWX
957 int readx(int fd, void *ptr, size_t len)
964 D("readx: %d %p %d\n", fd, ptr, (int)len);
966 r = sdb_read(fd, p, len);
971 D("readx: %d %d %s\n", fd, r, strerror(errno));
972 if((r < 0) && (errno == EINTR)) continue;
978 D("readx: %d ok: ", fd);
979 dump_hex( ptr, len0 );
984 int writex(int fd, const void *ptr, size_t len)
986 char *p = (char*) ptr;
990 D("writex: %d %p %d: ", fd, ptr, (int)len);
991 dump_hex( ptr, len );
994 r = sdb_write(fd, p, len);
999 D("writex: %d %d %s\n", fd, r, strerror(errno));
1000 if((r < 0) && (errno == EINTR)) continue;
1005 D("writex: %d ok\n", fd);
1009 int check_header(apacket *p)
1011 if(p->msg.magic != (p->msg.command ^ 0xffffffff)) {
1012 D("check_header(): invalid magic\n");
1016 if(p->msg.data_length > MAX_PAYLOAD) {
1017 D("check_header(): %d > MAX_PAYLOAD\n", p->msg.data_length);
1024 int check_data(apacket *p)
1026 unsigned count, sum;
1029 count = p->msg.data_length;
1032 while(count-- > 0) {
1036 if(sum != p->msg.data_check) {