2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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 #define MAX_DUMP_HEX_LEN 16
39 static void dump_hex( const unsigned char* ptr, size_t len )
42 // Build a string instead of logging each character.
43 // MAX chars in 2 digit hex, one space, MAX chars, one '\0'.
44 char buffer[MAX_DUMP_HEX_LEN *2 + 1 + MAX_DUMP_HEX_LEN + 1 ], *pb = buffer;
46 if (len2 > MAX_DUMP_HEX_LEN) len2 = MAX_DUMP_HEX_LEN;
48 for (nn = 0; nn < len2; nn++) {
49 sprintf(pb, "%02x", ptr[nn]);
54 for (nn = 0; nn < len2; nn++) {
56 if (c < 32 || c > 127)
66 kick_transport(atransport* t)
72 sdb_mutex_lock(&transport_lock);
76 sdb_mutex_unlock(&transport_lock);
84 run_transport_disconnects(atransport* t)
86 adisconnect* dis = t->disconnects.next;
88 D("%s: run_transport_disconnects\n", t->serial);
89 while (dis != &t->disconnects) {
90 adisconnect* next = dis->next;
91 dis->func( dis->opaque, t );
98 dump_packet(const char* name, const char* func, apacket* p)
100 unsigned command = p->msg.command;
101 int len = p->msg.data_length;
103 char arg0[12], arg1[12];
106 for (n = 0; n < 4; n++) {
107 int b = (command >> (n*8)) & 255;
108 if (b < 32 || b >= 127)
115 /* There is some non-ASCII name in the command, so dump
116 * the hexadecimal value instead */
117 snprintf(cmd, sizeof cmd, "%08x", command);
120 if (p->msg.arg0 < 256U)
121 snprintf(arg0, sizeof arg0, "%d", p->msg.arg0);
123 snprintf(arg0, sizeof arg0, "0x%x", p->msg.arg0);
125 if (p->msg.arg1 < 256U)
126 snprintf(arg1, sizeof arg1, "%d", p->msg.arg1);
128 snprintf(arg1, sizeof arg1, "0x%x", p->msg.arg1);
130 D("%s: %s: [%s] arg0=%s arg1=%s (len=%d) ",
131 name, func, cmd, arg0, arg1, len);
132 dump_hex(p->data, len);
134 #endif /* SDB_TRACE */
137 read_packet(int fd, const char* name, apacket** ppacket)
139 char *p = (char*)ppacket; /* really read a packet address */
141 int len = sizeof(*ppacket);
144 snprintf(buff, sizeof buff, "fd=%d", fd);
148 r = sdb_read(fd, p, len);
153 D("%s: read_packet (fd=%d), error ret=%d errno=%d: %s\n", name, fd, r, errno, strerror(errno));
154 if((r < 0) && (errno == EINTR)) continue;
161 dump_packet(name, "from remote", *ppacket);
168 write_packet(int fd, const char* name, apacket** ppacket)
170 char *p = (char*) ppacket; /* we really write the packet address */
171 int r, len = sizeof(ppacket);
174 snprintf(buff, sizeof buff, "fd=%d", fd);
180 dump_packet(name, "to remote", *ppacket);
183 len = sizeof(ppacket);
185 r = sdb_write(fd, p, len);
190 D("%s: write_packet (fd=%d) error ret=%d errno=%d: %s\n", name, fd, r, errno, strerror(errno));
191 if((r < 0) && (errno == EINTR)) continue;
198 static void transport_socket_events(int fd, unsigned events, void *_t)
201 D("transport_socket_events(fd=%d, events=%04x,...)\n", fd, events);
202 if(events & FDE_READ){
204 if(read_packet(fd, t->serial, &p)){
205 D("%s: failed to read packet from transport socket on fd %d\n", t->serial, fd);
207 handle_packet(p, (atransport *) _t);
212 void send_packet(apacket *p, atransport *t)
218 p->msg.magic = p->msg.command ^ 0xffffffff;
220 count = p->msg.data_length;
221 x = (unsigned char *) p->data;
226 p->msg.data_check = sum;
228 print_packet("send", p);
231 D("Transport is null \n");
232 // Zap errno because print_packet() and other stuff have errno effect.
234 fatal_errno("Transport is null");
237 if(write_packet(t->transport_socket, t->serial, &p)){
238 fatal_errno("cannot enqueue packet on transport socket");
242 /* The transport is opened by transport_register_func before
243 ** the input and output threads are started.
245 ** The output thread issues a SYNC(1, token) message to let
246 ** the input thread know to start things up. In the event
247 ** of transport IO failure, the output thread will post a
248 ** SYNC(0,0) message to ensure shutdown.
250 ** The transport will not actually be closed until both
251 ** threads exit, but the input thread will kick the transport
252 ** on its way out to disconnect the underlying device.
255 static void *output_thread(void *_t)
260 D("%s: starting transport output thread on fd %d, SYNC online (%d)\n",
261 t->serial, t->fd, t->sync_token + 1);
263 p->msg.command = A_SYNC;
265 p->msg.arg1 = ++(t->sync_token);
266 p->msg.magic = A_SYNC ^ 0xffffffff;
267 if(write_packet(t->fd, t->serial, &p)) {
269 D("%s: failed to write SYNC packet\n", t->serial);
273 D("%s: data pump started\n", t->serial);
277 if(t->read_from_remote(p, t) == 0){
278 D("%s: received remote packet, sending to transport\n",
280 if(write_packet(t->fd, t->serial, &p)){
282 D("%s: failed to write apacket to transport\n", t->serial);
286 D("%s: remote read failed for transport\n", t->serial);
292 D("%s: SYNC offline for transport\n", t->serial);
294 p->msg.command = A_SYNC;
297 p->msg.magic = A_SYNC ^ 0xffffffff;
298 if(write_packet(t->fd, t->serial, &p)) {
300 D("%s: failed to write SYNC apacket to transport", t->serial);
304 D("%s: transport output thread is exiting\n", t->serial);
310 static void *input_thread(void *_t)
316 D("%s: starting transport input thread, reading from fd %d\n",
320 if(read_packet(t->fd, t->serial, &p)) {
321 D("%s: failed to read apacket from transport on fd %d\n",
325 if(p->msg.command == A_SYNC){
326 if(p->msg.arg0 == 0) {
327 D("%s: transport SYNC offline\n", t->serial);
331 if(p->msg.arg1 == t->sync_token) {
332 D("%s: transport SYNC online\n", t->serial);
335 D("%s: transport ignoring SYNC %d != %d\n",
336 t->serial, p->msg.arg1, t->sync_token);
341 D("%s: transport got packet, sending to remote\n", t->serial);
342 t->write_to_remote(p, t);
344 D("%s: transport ignoring packet while offline\n", t->serial);
351 // this is necessary to avoid a race condition that occured when a transport closes
352 // while a client socket is still active.
353 close_all_sockets(t);
355 D("%s: transport input thread is exiting, fd %d\n", t->serial, t->fd);
362 static int transport_registration_send = -1;
363 static int transport_registration_recv = -1;
364 static fdevent transport_registration_fde;
368 static int list_transports_msg(char* buffer, size_t bufferlen)
373 len = list_transports(buffer+4, bufferlen-4);
374 snprintf(head, sizeof(head), "%04x", len);
375 memcpy(buffer, head, 4);
380 /* this adds support required by the 'track-devices' service.
381 * this is used to send the content of "list_transport" to any
382 * number of client connections that want it through a single
383 * live TCP connection
385 typedef struct device_tracker device_tracker;
386 struct device_tracker {
389 device_tracker* next;
392 /* linked list of all device trackers */
393 static device_tracker* device_tracker_list;
396 device_tracker_remove( device_tracker* tracker )
398 device_tracker** pnode = &device_tracker_list;
399 device_tracker* node = *pnode;
401 sdb_mutex_lock( &transport_lock );
403 if (node == tracker) {
410 sdb_mutex_unlock( &transport_lock );
414 device_tracker_close( asocket* socket )
416 device_tracker* tracker = (device_tracker*) socket;
417 asocket* peer = socket->peer;
419 D( "device tracker %p removed\n", tracker);
424 device_tracker_remove(tracker);
429 device_tracker_enqueue( asocket* socket, apacket* p )
431 /* you can't read from a device tracker, close immediately */
433 device_tracker_close(socket);
438 device_tracker_send( device_tracker* tracker,
442 apacket* p = get_apacket();
443 asocket* peer = tracker->socket.peer;
445 memcpy(p->data, buffer, len);
447 return peer->enqueue( peer, p );
452 device_tracker_ready( asocket* socket )
454 device_tracker* tracker = (device_tracker*) socket;
456 /* we want to send the device list when the tracker connects
457 * for the first time, even if no update occured */
458 if (tracker->update_needed > 0) {
462 tracker->update_needed = 0;
464 len = list_transports_msg(buffer, sizeof(buffer));
465 device_tracker_send(tracker, buffer, len);
471 create_device_tracker(void)
473 device_tracker* tracker = calloc(1,sizeof(*tracker));
475 if(tracker == 0) fatal("cannot allocate device tracker");
477 D( "device tracker %p created\n", tracker);
479 tracker->socket.enqueue = device_tracker_enqueue;
480 tracker->socket.ready = device_tracker_ready;
481 tracker->socket.close = device_tracker_close;
482 tracker->update_needed = 1;
484 tracker->next = device_tracker_list;
485 device_tracker_list = tracker;
487 return &tracker->socket;
491 /* call this function each time the transport list has changed */
492 void update_transports(void)
496 device_tracker* tracker;
498 len = list_transports_msg(buffer, sizeof(buffer));
500 tracker = device_tracker_list;
501 while (tracker != NULL) {
502 device_tracker* next = tracker->next;
503 /* note: this may destroy the tracker if the connection is closed */
504 device_tracker_send(tracker, buffer, len);
509 void update_transports(void)
511 // nothing to do on the device side
515 typedef struct tmsg tmsg;
518 atransport *transport;
523 transport_read_action(int fd, struct tmsg* m)
526 int len = sizeof(*m);
530 r = sdb_read(fd, p, len);
535 if((r < 0) && (errno == EINTR)) continue;
536 D("transport_read_action: on fd %d, error %d: %s\n",
537 fd, errno, strerror(errno));
545 transport_write_action(int fd, struct tmsg* m)
548 int len = sizeof(*m);
552 r = sdb_write(fd, p, len);
557 if((r < 0) && (errno == EINTR)) continue;
558 D("transport_write_action: on fd %d, error %d: %s\n",
559 fd, errno, strerror(errno));
566 static void transport_registration_func(int _fd, unsigned ev, void *data)
569 sdb_thread_t output_thread_ptr;
570 sdb_thread_t input_thread_ptr;
574 if(!(ev & FDE_READ)) {
578 if(transport_read_action(_fd, &m)) {
579 fatal_errno("cannot read transport registration socket");
585 D("transport: %s removing and free'ing %d\n", t->serial, t->transport_socket);
587 /* IMPORTANT: the remove closes one half of the
588 ** socket pair. The close closes the other half.
590 fdevent_remove(&(t->transport_fde));
593 sdb_mutex_lock(&transport_lock);
594 t->next->prev = t->prev;
595 t->prev->next = t->next;
596 sdb_mutex_unlock(&transport_lock);
598 run_transport_disconnects(t);
605 free(t->device_name);
607 memset(t,0xee,sizeof(atransport));
614 /* don't create transport threads for inaccessible devices */
615 if (t->connection_state != CS_NOPERM) {
616 /* initial references are the two threads */
619 if(sdb_socketpair(s)) {
620 fatal_errno("cannot open transport socketpair");
623 D("transport: %s (%d,%d) starting\n", t->serial, s[0], s[1]);
625 t->transport_socket = s[0];
628 fdevent_install(&(t->transport_fde),
630 transport_socket_events,
633 fdevent_set(&(t->transport_fde), FDE_READ);
635 if(sdb_thread_create(&input_thread_ptr, input_thread, t)){
636 fatal_errno("cannot create input thread");
639 if(sdb_thread_create(&output_thread_ptr, output_thread, t)){
640 fatal_errno("cannot create output thread");
644 /* put us on the master device list */
645 sdb_mutex_lock(&transport_lock);
646 t->next = &transport_list;
647 t->prev = transport_list.prev;
650 sdb_mutex_unlock(&transport_lock);
652 t->disconnects.next = t->disconnects.prev = &t->disconnects;
657 void init_transport_registration(void)
661 if(sdb_socketpair(s)){
662 fatal_errno("cannot open transport registration socketpair");
665 transport_registration_send = s[0];
666 transport_registration_recv = s[1];
668 fdevent_install(&transport_registration_fde,
669 transport_registration_recv,
670 transport_registration_func,
673 fdevent_set(&transport_registration_fde, FDE_READ);
676 /* the fdevent select pump is single threaded */
677 static void register_transport(atransport *transport)
680 m.transport = transport;
682 D("transport: %s registered\n", transport->serial);
683 if(transport_write_action(transport_registration_send, &m)) {
684 fatal_errno("cannot write transport registration socket\n");
688 static void remove_transport(atransport *transport)
691 m.transport = transport;
693 D("transport: %s removed\n", transport->serial);
694 if(transport_write_action(transport_registration_send, &m)) {
695 fatal_errno("cannot write transport registration socket\n");
700 static void transport_unref_locked(atransport *t)
703 if (t->ref_count == 0) {
704 D("transport: %s unref (kicking and closing)\n", t->serial);
712 D("transport: %s unref (count=%d)\n", t->serial, t->ref_count);
716 static void transport_unref(atransport *t)
719 sdb_mutex_lock(&transport_lock);
720 transport_unref_locked(t);
721 sdb_mutex_unlock(&transport_lock);
725 void add_transport_disconnect(atransport* t, adisconnect* dis)
727 sdb_mutex_lock(&transport_lock);
728 dis->next = &t->disconnects;
729 dis->prev = dis->next->prev;
730 dis->prev->next = dis;
731 dis->next->prev = dis;
732 sdb_mutex_unlock(&transport_lock);
735 void remove_transport_disconnect(atransport* t, adisconnect* dis)
737 dis->prev->next = dis->next;
738 dis->next->prev = dis->prev;
739 dis->next = dis->prev = dis;
743 atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char** error_out)
746 atransport *result = NULL;
751 *error_out = "device not found";
753 sdb_mutex_lock(&transport_lock);
754 for (t = transport_list.next; t != &transport_list; t = t->next) {
755 if (t->connection_state == CS_NOPERM) {
757 *error_out = "insufficient permissions for device";
761 /* check for matching serial number */
763 if (t->serial && !strcmp(serial, t->serial)) {
768 if (ttype == kTransportUsb && t->type == kTransportUsb) {
771 *error_out = "more than one device";
777 } else if (ttype == kTransportLocal && t->type == kTransportLocal) {
780 *error_out = "more than one emulator";
786 } else if (ttype == kTransportAny) {
789 *error_out = "more than one device and emulator";
798 sdb_mutex_unlock(&transport_lock);
801 /* offline devices are ignored -- they are either being born or dying */
802 if (result && result->connection_state == CS_OFFLINE) {
804 *error_out = "device offline";
807 /* check for required connection state */
808 if (result && state != CS_ANY && result->connection_state != state) {
810 *error_out = "invalid device state";
816 /* found one that we can take */
819 } else if (state != CS_ANY && (serial || !ambiguous)) {
828 static const char *statename(atransport *t)
830 switch(t->connection_state){
831 case CS_OFFLINE: return "offline";
832 case CS_BOOTLOADER: return "bootloader";
833 case CS_DEVICE: return "device";
834 case CS_HOST: return "host";
835 case CS_RECOVERY: return "recovery";
836 case CS_SIDELOAD: return "sideload";
837 case CS_NOPERM: return "no permissions";
838 default: return "unknown";
842 int list_transports(char *buf, size_t bufsize)
845 char* end = buf + bufsize;
849 /* XXX OVERRUN PROBLEMS XXX */
850 sdb_mutex_lock(&transport_lock);
851 for(t = transport_list.next; t != &transport_list; t = t->next) {
852 const char* serial = t->serial;
853 const char* devicename = (t->device_name == NULL) ? DEFAULT_DEVICENAME : t->device_name; /* tizen specific */
854 if (!serial || !serial[0])
855 serial = "????????????";
856 len = snprintf(p, end - p, "%s\t%s\t%s\n", serial, statename(t), devicename);
858 if (p + len >= end) {
859 /* discard last line if buffer is too short */
865 sdb_mutex_unlock(&transport_lock);
871 void close_usb_devices()
875 sdb_mutex_lock(&transport_lock);
876 for(t = transport_list.next; t != &transport_list; t = t->next) {
882 sdb_mutex_unlock(&transport_lock);
886 void register_socket_transport(int s, const char *serial, int port, int local, const char *device_name)
888 atransport *t = calloc(1, sizeof(atransport));
892 snprintf(buff, sizeof buff, "T-%p", t);
895 D("transport: %s init'ing for socket %d, on port %d (%s)\n", serial, s, port, device_name);
896 if ( init_socket_transport(t, s, port, local) < 0 ) {
899 #if SDB_HOST /* tizen specific */
900 atransport *old_t = find_transport(serial);
902 unregister_transport(old_t);
904 D("No such device %s", serial);
910 t->serial = strdup(serial);
912 #if SDB_HOST /* tizen specific */
913 if (device_name) {/* tizen specific */
914 t->device_name = strdup(device_name);
915 } else { // device_name could be null when sdb server was forked before qemu has sent the connect message.
916 char device_name[DEVICENAME_MAX];
917 if (get_devicename_from_shdmem(port, device_name) == 0) {
918 t->device_name = strdup(device_name);
922 register_transport(t);
926 atransport *find_transport(const char *serial)
930 sdb_mutex_lock(&transport_lock);
931 for(t = transport_list.next; t != &transport_list; t = t->next) {
932 if (t->serial && !strcmp(serial, t->serial)) {
936 sdb_mutex_unlock(&transport_lock);
938 if (t != &transport_list)
944 void unregister_transport(atransport *t)
946 sdb_mutex_lock(&transport_lock);
947 t->next->prev = t->prev;
948 t->prev->next = t->next;
949 sdb_mutex_unlock(&transport_lock);
955 // unregisters all non-emulator TCP transports
956 void unregister_all_tcp_transports()
958 atransport *t, *next;
959 sdb_mutex_lock(&transport_lock);
960 for (t = transport_list.next; t != &transport_list; t = next) {
962 if (t->type == kTransportLocal && t->sdb_port == 0) {
963 t->next->prev = t->prev;
964 t->prev->next = next;
965 // we cannot call kick_transport when holding transport_lock
971 transport_unref_locked(t);
975 sdb_mutex_unlock(&transport_lock);
980 int get_connected_device_count(transport_type type) /* tizen specific */
984 sdb_mutex_lock(&transport_lock);
985 for(t = transport_list.next; t != &transport_list; t = t->next) {
986 if (type == kTransportUsb && t->type == kTransportUsb)
989 sdb_mutex_unlock(&transport_lock);
990 D("connected device count:%d\n",cnt);
994 void register_usb_transport(usb_handle *usb, const char *serial, unsigned writeable)
996 atransport *t = calloc(1, sizeof(atransport));
997 char device_name[256];
999 D("transport: %p init'ing for usb_handle %p (sn='%s')\n", t, usb,
1000 serial ? serial : "");
1001 init_usb_transport(t, usb, (writeable ? CS_OFFLINE : CS_NOPERM));
1003 t->serial = strdup(serial);
1006 /* tizen specific */
1007 sprintf(device_name, "device-%d",get_connected_device_count(kTransportUsb)+1);
1008 t->device_name = strdup(device_name);
1009 register_transport(t);
1012 /* this should only be used for transports with connection_state == CS_NOPERM */
1013 void unregister_usb_transport(usb_handle *usb)
1016 sdb_mutex_lock(&transport_lock);
1017 for(t = transport_list.next; t != &transport_list; t = t->next) {
1018 if (t->usb == usb && t->connection_state == CS_NOPERM) {
1019 t->next->prev = t->prev;
1020 t->prev->next = t->next;
1024 sdb_mutex_unlock(&transport_lock);
1028 #define TRACE_TAG TRACE_RWX
1030 int readx(int fd, void *ptr, size_t len)
1037 D("readx: fd=%d wanted=%d\n", fd, (int)len);
1039 r = sdb_read(fd, p, len);
1045 D("readx: fd=%d error %d: %s\n", fd, errno, strerror(errno));
1049 D("readx: fd=%d disconnected\n", fd);
1056 D("readx: fd=%d wanted=%d got=%d\n", fd, len0, len0 - len);
1057 dump_hex( ptr, len0 );
1062 int writex(int fd, const void *ptr, size_t len)
1064 char *p = (char*) ptr;
1068 D("writex: fd=%d len=%d: ", fd, (int)len);
1069 dump_hex( ptr, len );
1072 r = sdb_write(fd, p, len);
1078 D("writex: fd=%d error %d: %s\n", fd, errno, strerror(errno));
1082 D("writex: fd=%d disconnected\n", fd);
1090 int check_header(apacket *p)
1092 if(p->msg.magic != (p->msg.command ^ 0xffffffff)) {
1093 D("check_header(): invalid magic\n");
1097 if(p->msg.data_length > MAX_PAYLOAD) {
1098 D("check_header(): %d > MAX_PAYLOAD\n", p->msg.data_length);
1105 int check_data(apacket *p)
1107 unsigned count, sum;
1110 count = p->msg.data_length;
1113 while(count-- > 0) {
1117 if(sum != p->msg.data_check) {