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 int pbSize = sizeof(buffer);
49 for (nn = 0; nn < len2; nn++) {
50 snprintf(pb, pbSize, "%02x", ptr[nn]);
56 for (nn = 0; nn < len2; nn++) {
58 if (c < 32 || c > 127)
68 kick_transport(atransport* t)
74 sdb_mutex_lock(&transport_lock);
78 sdb_mutex_unlock(&transport_lock);
86 run_transport_disconnects(atransport* t)
88 adisconnect* dis = t->disconnects.next;
90 D("%s: run_transport_disconnects\n", t->serial);
91 while (dis != &t->disconnects) {
92 adisconnect* next = dis->next;
93 dis->func( dis->opaque, t );
100 dump_packet(const char* name, const char* func, apacket* p)
102 unsigned command = p->msg.command;
103 int len = p->msg.data_length;
105 char arg0[12], arg1[12];
108 for (n = 0; n < 4; n++) {
109 int b = (command >> (n*8)) & 255;
110 if (b < 32 || b >= 127)
117 /* There is some non-ASCII name in the command, so dump
118 * the hexadecimal value instead */
119 snprintf(cmd, sizeof cmd, "%08x", command);
122 if (p->msg.arg0 < 256U)
123 snprintf(arg0, sizeof arg0, "%d", p->msg.arg0);
125 snprintf(arg0, sizeof arg0, "0x%x", p->msg.arg0);
127 if (p->msg.arg1 < 256U)
128 snprintf(arg1, sizeof arg1, "%d", p->msg.arg1);
130 snprintf(arg1, sizeof arg1, "0x%x", p->msg.arg1);
132 D("%s: %s: [%s] arg0=%s arg1=%s (len=%d) ",
133 name, func, cmd, arg0, arg1, len);
134 dump_hex(p->data, len);
136 #endif /* SDB_TRACE */
139 read_packet(int fd, const char* name, apacket** ppacket)
141 char *p = (char*)ppacket; /* really read a packet address */
143 int len = sizeof(*ppacket);
146 snprintf(buff, sizeof buff, "fd=%d", fd);
150 r = sdb_read(fd, p, len);
155 D("%s: read_packet (fd=%d), error ret=%d errno=%d\n", name, fd, r, errno);
156 if((r < 0) && (errno == EINTR)) continue;
163 dump_packet(name, "from remote", *ppacket);
170 write_packet(int fd, const char* name, apacket** ppacket)
172 char *p = (char*) ppacket; /* we really write the packet address */
173 int r, len = sizeof(ppacket);
176 snprintf(buff, sizeof buff, "fd=%d", fd);
182 dump_packet(name, "to remote", *ppacket);
185 len = sizeof(ppacket);
187 r = sdb_write(fd, p, len);
192 D("%s: write_packet (fd=%d) error ret=%d errno=%d\n", name, fd, r, errno);
193 if((r < 0) && (errno == EINTR)) continue;
200 static void transport_socket_events(int fd, unsigned events, void *_t)
203 D("transport_socket_events(fd=%d, events=%04x,...)\n", fd, events);
204 if(events & FDE_READ){
206 if(read_packet(fd, t->serial, &p)){
207 D("%s: failed to read packet from transport socket on fd %d\n", t->serial, fd);
209 handle_packet(p, (atransport *) _t);
214 void send_packet(apacket *p, atransport *t)
220 p->msg.magic = p->msg.command ^ 0xffffffff;
222 count = p->msg.data_length;
223 x = (unsigned char *) p->data;
228 p->msg.data_check = sum;
230 print_packet("send", p);
233 D("Transport is null \n");
234 // Zap errno because print_packet() and other stuff have errno effect.
236 fatal_errno("Transport is null");
239 if(write_packet(t->transport_socket, t->serial, &p)){
240 fatal_errno("cannot enqueue packet on transport socket");
244 /* The transport is opened by transport_register_func before
245 ** the input and output threads are started.
247 ** The output thread issues a SYNC(1, token) message to let
248 ** the input thread know to start things up. In the event
249 ** of transport IO failure, the output thread will post a
250 ** SYNC(0,0) message to ensure shutdown.
252 ** The transport will not actually be closed until both
253 ** threads exit, but the input thread will kick the transport
254 ** on its way out to disconnect the underlying device.
257 static void *output_thread(void *_t)
262 D("%s: starting transport output thread on fd %d, SYNC online (%d)\n",
263 t->serial, t->fd, t->sync_token + 1);
265 p->msg.command = A_SYNC;
267 p->msg.arg1 = ++(t->sync_token);
268 p->msg.magic = A_SYNC ^ 0xffffffff;
269 if(write_packet(t->fd, t->serial, &p)) {
271 D("%s: failed to write SYNC packet\n", t->serial);
275 D("%s: data pump started\n", t->serial);
279 if(t->read_from_remote(p, t) == 0){
280 D("%s: received remote packet, sending to transport\n",
282 if(write_packet(t->fd, t->serial, &p)){
284 D("%s: failed to write apacket to transport\n", t->serial);
288 D("%s: remote read failed for transport\n", t->serial);
294 D("%s: SYNC offline for transport\n", t->serial);
296 p->msg.command = A_SYNC;
299 p->msg.magic = A_SYNC ^ 0xffffffff;
300 if(write_packet(t->fd, t->serial, &p)) {
302 D("%s: failed to write SYNC apacket to transport", t->serial);
306 D("%s: transport output thread is exiting\n", t->serial);
312 static void *input_thread(void *_t)
318 D("%s: starting transport input thread, reading from fd %d\n",
322 if(read_packet(t->fd, t->serial, &p)) {
323 D("%s: failed to read apacket from transport on fd %d\n",
327 if(p->msg.command == A_SYNC){
328 if(p->msg.arg0 == 0) {
329 D("%s: transport SYNC offline\n", t->serial);
333 if(p->msg.arg1 == t->sync_token) {
334 D("%s: transport SYNC online\n", t->serial);
337 D("%s: transport ignoring SYNC %d != %d\n",
338 t->serial, p->msg.arg1, t->sync_token);
343 D("%s: transport got packet, sending to remote\n", t->serial);
344 t->write_to_remote(p, t);
346 D("%s: transport ignoring packet while offline\n", t->serial);
353 // this is necessary to avoid a race condition that occured when a transport closes
354 // while a client socket is still active.
355 close_all_sockets(t);
357 D("%s: transport input thread is exiting, fd %d\n", t->serial, t->fd);
364 static int transport_registration_send = -1;
365 static int transport_registration_recv = -1;
366 static fdevent transport_registration_fde;
370 static int list_transports_msg(char* buffer, size_t bufferlen)
375 len = list_transports(buffer+4, bufferlen-4);
376 snprintf(head, sizeof(head), "%04x", len);
377 memcpy(buffer, head, 4);
382 /* this adds support required by the 'track-devices' service.
383 * this is used to send the content of "list_transport" to any
384 * number of client connections that want it through a single
385 * live TCP connection
387 typedef struct device_tracker device_tracker;
388 struct device_tracker {
391 device_tracker* next;
394 /* linked list of all device trackers */
395 static device_tracker* device_tracker_list;
398 device_tracker_remove( device_tracker* tracker )
400 device_tracker** pnode = &device_tracker_list;
401 device_tracker* node = *pnode;
403 sdb_mutex_lock( &transport_lock );
405 if (node == tracker) {
412 sdb_mutex_unlock( &transport_lock );
416 device_tracker_close( asocket* socket )
418 device_tracker* tracker = (device_tracker*) socket;
419 asocket* peer = socket->peer;
421 D( "device tracker %p removed\n", tracker);
426 device_tracker_remove(tracker);
431 device_tracker_enqueue( asocket* socket, apacket* p )
433 /* you can't read from a device tracker, close immediately */
435 device_tracker_close(socket);
440 device_tracker_send( device_tracker* tracker,
444 apacket* p = get_apacket();
445 asocket* peer = tracker->socket.peer;
447 memcpy(p->data, buffer, len);
449 return peer->enqueue( peer, p );
454 device_tracker_ready( asocket* socket )
456 device_tracker* tracker = (device_tracker*) socket;
458 /* we want to send the device list when the tracker connects
459 * for the first time, even if no update occured */
460 if (tracker->update_needed > 0) {
464 tracker->update_needed = 0;
466 len = list_transports_msg(buffer, sizeof(buffer));
467 device_tracker_send(tracker, buffer, len);
473 create_device_tracker(void)
475 device_tracker* tracker = calloc(1,sizeof(*tracker));
477 if(tracker == 0) fatal("cannot allocate device tracker");
479 D( "device tracker %p created\n", tracker);
481 tracker->socket.enqueue = device_tracker_enqueue;
482 tracker->socket.ready = device_tracker_ready;
483 tracker->socket.close = device_tracker_close;
484 tracker->update_needed = 1;
486 tracker->next = device_tracker_list;
487 device_tracker_list = tracker;
489 return &tracker->socket;
493 /* call this function each time the transport list has changed */
494 void update_transports(void)
498 device_tracker* tracker;
500 len = list_transports_msg(buffer, sizeof(buffer));
502 tracker = device_tracker_list;
503 while (tracker != NULL) {
504 device_tracker* next = tracker->next;
505 /* note: this may destroy the tracker if the connection is closed */
506 device_tracker_send(tracker, buffer, len);
511 void update_transports(void)
513 // nothing to do on the device side
517 typedef struct tmsg tmsg;
520 atransport *transport;
525 transport_read_action(int fd, struct tmsg* m)
528 int len = sizeof(*m);
532 r = sdb_read(fd, p, len);
537 if((r < 0) && (errno == EINTR)) continue;
538 D("transport_read_action: on fd %d, error %d\n",
547 transport_write_action(int fd, struct tmsg* m)
550 int len = sizeof(*m);
554 r = sdb_write(fd, p, len);
559 if((r < 0) && (errno == EINTR)) continue;
560 D("transport_write_action: on fd %d, error %d\n",
568 static void transport_registration_func(int _fd, unsigned ev, void *data)
571 sdb_thread_t output_thread_ptr;
572 sdb_thread_t input_thread_ptr;
576 if(!(ev & FDE_READ)) {
580 if(transport_read_action(_fd, &m)) {
581 fatal_errno("cannot read transport registration socket");
587 D("transport: %s removing and free'ing %d\n", t->serial, t->transport_socket);
589 /* IMPORTANT: the remove closes one half of the
590 ** socket pair. The close closes the other half.
592 fdevent_remove(&(t->transport_fde));
595 sdb_mutex_lock(&transport_lock);
596 t->next->prev = t->prev;
597 t->prev->next = t->next;
598 sdb_mutex_unlock(&transport_lock);
600 run_transport_disconnects(t);
607 free(t->device_name);
609 memset(t,0xee,sizeof(atransport));
616 /* don't create transport threads for inaccessible devices */
617 if (t->connection_state != CS_NOPERM) {
618 /* initial references are the two threads */
621 if(sdb_socketpair(s)) {
622 fatal_errno("cannot open transport socketpair");
625 D("transport: %s (%d,%d) starting\n", t->serial, s[0], s[1]);
627 t->transport_socket = s[0];
630 fdevent_install(&(t->transport_fde),
632 transport_socket_events,
635 fdevent_set(&(t->transport_fde), FDE_READ);
637 if(sdb_thread_create(&input_thread_ptr, input_thread, t)){
638 fatal_errno("cannot create input thread");
641 if(sdb_thread_create(&output_thread_ptr, output_thread, t)){
642 fatal_errno("cannot create output thread");
646 /* put us on the master device list */
647 sdb_mutex_lock(&transport_lock);
648 t->next = &transport_list;
649 t->prev = transport_list.prev;
652 sdb_mutex_unlock(&transport_lock);
654 t->disconnects.next = t->disconnects.prev = &t->disconnects;
659 void init_transport_registration(void)
663 if(sdb_socketpair(s)){
664 fatal_errno("cannot open transport registration socketpair");
667 transport_registration_send = s[0];
668 transport_registration_recv = s[1];
670 fdevent_install(&transport_registration_fde,
671 transport_registration_recv,
672 transport_registration_func,
675 fdevent_set(&transport_registration_fde, FDE_READ);
678 /* the fdevent select pump is single threaded */
679 static void register_transport(atransport *transport)
682 m.transport = transport;
684 D("transport: %s registered\n", transport->serial);
685 if(transport_write_action(transport_registration_send, &m)) {
686 fatal_errno("cannot write transport registration socket\n");
690 static void remove_transport(atransport *transport)
693 m.transport = transport;
695 D("transport: %s removed\n", transport->serial);
696 if(transport_write_action(transport_registration_send, &m)) {
697 fatal_errno("cannot write transport registration socket\n");
702 static void transport_unref_locked(atransport *t)
705 if (t->ref_count == 0) {
706 D("transport: %s unref (kicking and closing)\n", t->serial);
714 D("transport: %s unref (count=%d)\n", t->serial, t->ref_count);
718 static void transport_unref(atransport *t)
721 sdb_mutex_lock(&transport_lock);
722 transport_unref_locked(t);
723 sdb_mutex_unlock(&transport_lock);
727 void add_transport_disconnect(atransport* t, adisconnect* dis)
729 sdb_mutex_lock(&transport_lock);
730 dis->next = &t->disconnects;
731 dis->prev = dis->next->prev;
732 dis->prev->next = dis;
733 dis->next->prev = dis;
734 sdb_mutex_unlock(&transport_lock);
737 void remove_transport_disconnect(atransport* t, adisconnect* dis)
739 dis->prev->next = dis->next;
740 dis->next->prev = dis->prev;
741 dis->next = dis->prev = dis;
745 atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char** error_out)
748 atransport *result = NULL;
753 *error_out = "device not found";
755 sdb_mutex_lock(&transport_lock);
756 for (t = transport_list.next; t != &transport_list; t = t->next) {
757 if (t->connection_state == CS_NOPERM) {
759 *error_out = "insufficient permissions for device";
763 /* check for matching serial number */
765 if (t->serial && !strcmp(serial, t->serial)) {
770 if (ttype == kTransportUsb && t->type == kTransportUsb) {
773 *error_out = "more than one device";
779 } else if (ttype == kTransportLocal && t->type == kTransportLocal) {
782 *error_out = "more than one emulator";
788 } else if (ttype == kTransportAny) {
791 *error_out = "more than one device and emulator";
800 sdb_mutex_unlock(&transport_lock);
803 /* offline devices are ignored -- they are either being born or dying */
804 if (result && result->connection_state == CS_OFFLINE) {
806 *error_out = "device offline";
809 /* check for required connection state */
810 if (result && state != CS_ANY && result->connection_state != state) {
812 *error_out = "invalid device state";
818 /* found one that we can take */
821 } else if (state != CS_ANY && (serial || !ambiguous)) {
830 static const char *statename(atransport *t)
832 switch(t->connection_state){
833 case CS_OFFLINE: return "offline";
834 case CS_BOOTLOADER: return "bootloader";
835 case CS_DEVICE: return "device";
836 case CS_HOST: return "host";
837 case CS_RECOVERY: return "recovery";
838 case CS_SIDELOAD: return "sideload";
839 case CS_NOPERM: return "no permissions";
840 default: return "unknown";
844 int list_transports(char *buf, size_t bufsize)
847 char* end = buf + bufsize;
851 /* XXX OVERRUN PROBLEMS XXX */
852 sdb_mutex_lock(&transport_lock);
853 for(t = transport_list.next; t != &transport_list; t = t->next) {
854 const char* serial = t->serial;
855 const char* devicename = (t->device_name == NULL) ? DEFAULT_DEVICENAME : t->device_name; /* tizen specific */
856 if (!serial || !serial[0])
857 serial = "????????????";
858 len = snprintf(p, end - p, "%s\t%s\t%s\n", serial, statename(t), devicename);
860 if (p + len >= end) {
861 /* discard last line if buffer is too short */
867 sdb_mutex_unlock(&transport_lock);
873 void close_usb_devices()
877 sdb_mutex_lock(&transport_lock);
878 for(t = transport_list.next; t != &transport_list; t = t->next) {
884 sdb_mutex_unlock(&transport_lock);
888 void register_socket_transport(int s, const char *serial, int port, int local, const char *device_name)
890 atransport *t = calloc(1, sizeof(atransport));
892 D("could not allocate atransport'\n");
898 snprintf(buff, sizeof buff, "T-%p", t);
901 D("transport: %s init'ing for socket %d, on port %d (%s)\n", serial, s, port, device_name);
902 if ( init_socket_transport(t, s, port, local) < 0 ) {
905 #if SDB_HOST /* tizen specific */
906 atransport *old_t = find_transport(serial);
908 unregister_transport(old_t);
910 D("No such device %s", serial);
916 t->serial = strdup(serial);
918 #if SDB_HOST /* tizen specific */
919 if (device_name) {/* tizen specific */
920 t->device_name = strdup(device_name);
921 } else { // device_name could be null when sdb server was forked before qemu has sent the connect message.
922 char device_name[DEVICENAME_MAX];
923 if (get_devicename_from_shdmem(port, device_name) == 0) {
924 t->device_name = strdup(device_name);
928 register_transport(t);
932 atransport *find_transport(const char *serial)
936 sdb_mutex_lock(&transport_lock);
937 for(t = transport_list.next; t != &transport_list; t = t->next) {
938 if (t->serial && !strcmp(serial, t->serial)) {
942 sdb_mutex_unlock(&transport_lock);
944 if (t != &transport_list)
950 void unregister_transport(atransport *t)
952 sdb_mutex_lock(&transport_lock);
953 t->next->prev = t->prev;
954 t->prev->next = t->next;
955 sdb_mutex_unlock(&transport_lock);
961 // unregisters all non-emulator TCP transports
962 void unregister_all_tcp_transports()
964 atransport *t, *next;
965 sdb_mutex_lock(&transport_lock);
966 for (t = transport_list.next; t != &transport_list; t = next) {
968 if (t->type == kTransportLocal && t->sdb_port == 0) {
969 t->next->prev = t->prev;
970 t->prev->next = next;
971 // we cannot call kick_transport when holding transport_lock
977 transport_unref_locked(t);
981 sdb_mutex_unlock(&transport_lock);
986 int get_connected_count(transport_type type) /* tizen specific */
990 sdb_mutex_lock(&transport_lock);
991 for(t = transport_list.next; t != &transport_list; t = t->next) {
992 if (type == kTransportAny || type == t->type)
995 sdb_mutex_unlock(&transport_lock);
996 if (type == kTransportUsb) {
997 D("connected device count:%d\n",cnt);
1002 void broadcast_transport(apacket *p)
1005 sdb_mutex_lock(&transport_lock);
1006 for(t = transport_list.next; t != &transport_list; t = t->next) {
1007 D("broadcast device transport:%d\n", t->connection_state);
1008 apacket* ap = get_apacket();
1012 if (is_pwlocked()) {
1013 t->connection_state = CS_PWLOCK;
1015 t->connection_state = CS_DEVICE;
1018 sdb_mutex_unlock(&transport_lock);
1021 void register_usb_transport(usb_handle *usb, const char *serial, unsigned writeable)
1023 atransport *t = calloc(1, sizeof(atransport));
1025 D("cannot allocate atransport");
1028 char device_name[256];
1030 D("transport: %p init'ing for usb_handle %p (sn='%s')\n", t, usb,
1031 serial ? serial : "");
1032 init_usb_transport(t, usb, (writeable ? CS_OFFLINE : CS_NOPERM));
1034 t->serial = strdup(serial);
1037 /* tizen specific */
1038 snprintf(device_name, sizeof(device_name), "device-%d",get_connected_count(kTransportUsb)+1);
1039 t->device_name = strdup(device_name);
1040 register_transport(t);
1043 /* this should only be used for transports with connection_state == CS_NOPERM */
1044 void unregister_usb_transport(usb_handle *usb)
1047 sdb_mutex_lock(&transport_lock);
1048 for(t = transport_list.next; t != &transport_list; t = t->next) {
1049 if (t->usb == usb && t->connection_state == CS_NOPERM) {
1050 t->next->prev = t->prev;
1051 t->prev->next = t->next;
1055 sdb_mutex_unlock(&transport_lock);
1059 #define TRACE_TAG TRACE_RWX
1061 int readx(int fd, void *ptr, size_t len)
1068 D("readx: fd=%d wanted=%d\n", fd, (int)len);
1070 r = sdb_read(fd, p, len);
1076 D("readx: fd=%d (errno:%d)\n", fd, errno);
1080 D("readx: fd=%d disconnected\n", fd);
1087 D("readx: fd=%d wanted=%d got=%d\n", fd, len0, len0 - len);
1088 dump_hex( ptr, len0 );
1093 int writex(int fd, const void *ptr, size_t len)
1095 char *p = (char*) ptr;
1099 D("writex: fd=%d len=%d: ", fd, (int)len);
1100 dump_hex( ptr, len );
1103 r = sdb_write(fd, p, len);
1109 D("writex: fd=%d error %d\n", fd, errno);
1113 D("writex: fd=%d disconnected\n", fd);
1121 int check_header(apacket *p)
1123 if(p->msg.magic != (p->msg.command ^ 0xffffffff)) {
1124 D("check_header(): invalid magic\n");
1128 if(p->msg.data_length > MAX_PAYLOAD) {
1129 D("check_header(): %d > MAX_PAYLOAD\n", p->msg.data_length);
1136 int check_data(apacket *p)
1138 unsigned count, sum;
1141 count = p->msg.data_length;
1144 while(count-- > 0) {
1148 if(sum != p->msg.data_check) {