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.
26 #define TRACE_TAG TRACE_SOCKETS
29 SDB_MUTEX_DEFINE( socket_list_lock );
31 static void local_socket_close_locked(asocket *s);
33 int sendfailmsg(int fd, const char *reason)
38 if(len > 0xffff) len = 0xffff;
39 snprintf(buf, sizeof buf, "FAIL%04x", len);
40 if(writex(fd, buf, 8)) return -1;
41 return writex(fd, reason, len);
46 static unsigned local_socket_next_id = 1;
48 static asocket local_socket_list = {
49 .next = &local_socket_list,
50 .prev = &local_socket_list,
53 /* the the list of currently closing local sockets.
54 ** these have no peer anymore, but still packets to
57 static asocket local_socket_closing_list = {
58 .next = &local_socket_closing_list,
59 .prev = &local_socket_closing_list,
62 asocket *find_local_socket(unsigned id)
65 asocket *result = NULL;
67 sdb_mutex_lock(&socket_list_lock);
68 for (s = local_socket_list.next; s != &local_socket_list; s = s->next) {
74 sdb_mutex_unlock(&socket_list_lock);
80 insert_local_socket(asocket* s, asocket* list)
83 s->prev = s->next->prev;
89 void install_local_socket(asocket *s)
91 sdb_mutex_lock(&socket_list_lock);
93 s->id = local_socket_next_id++;
94 insert_local_socket(s, &local_socket_list);
96 sdb_mutex_unlock(&socket_list_lock);
99 void remove_socket(asocket *s)
101 // socket_list_lock should already be held
102 if (s->prev && s->next)
104 s->prev->next = s->next;
105 s->next->prev = s->prev;
112 void close_all_sockets(atransport *t)
116 /* this is a little gross, but since s->close() *will* modify
117 ** the list out from under you, your options are limited.
119 sdb_mutex_lock(&socket_list_lock);
121 for(s = local_socket_list.next; s != &local_socket_list; s = s->next){
122 if(s->transport == t || (s->peer && s->peer->transport == t)) {
123 local_socket_close_locked(s);
127 sdb_mutex_unlock(&socket_list_lock);
130 static int local_socket_enqueue(asocket *s, apacket *p)
132 D("LS(%d): enqueue %d\n", s->id, p->len);
136 /* if there is already data queue'd, we will receive
137 ** events when it's time to write. just add this to
144 /* write as much as we can, until we
145 ** would block or there is an error/eof
148 int r = sdb_write(s->fd, p->ptr, p->len);
154 if((r == 0) || (errno != EAGAIN)) {
155 D( "LS(%d): not ready, errno=%d: %s\n", s->id, errno, strerror(errno) );
157 return 1; /* not ready (error) */
165 return 0; /* ready for more data */
171 s->pkt_last->next = p;
177 /* make sure we are notified when we can drain the queue */
178 fdevent_add(&s->fde, FDE_WRITE);
180 return 1; /* not ready (backlog) */
183 static void local_socket_ready(asocket *s)
185 /* far side is ready for data, pay attention to
187 fdevent_add(&s->fde, FDE_READ);
188 // D("LS(%d): ready()\n", s->id);
191 static void local_socket_close(asocket *s)
193 sdb_mutex_lock(&socket_list_lock);
194 local_socket_close_locked(s);
195 sdb_mutex_unlock(&socket_list_lock);
198 // be sure to hold the socket list lock when calling this
199 static void local_socket_destroy(asocket *s)
202 int exit_on_close = s->exit_on_close;
204 D("LS(%d): destroying fde.fd=%d\n", s->id, s->fde.fd);
206 /* IMPORTANT: the remove closes the fd
207 ** that belongs to this socket
209 fdevent_remove(&s->fde);
211 /* dispose of any unwritten data */
212 for(p = s->pkt_first; p; p = n) {
213 D("LS(%d): discarding %d bytes\n", s->id, p->len);
221 D("local_socket_destroy: exiting\n");
227 static void local_socket_close_locked(asocket *s)
229 D("entered. LS(%d) fd=%d\n", s->id, s->fd);
231 D("LS(%d): closing peer. peer->id=%d peer->fd=%d\n",
232 s->id, s->peer->id, s->peer->fd);
234 // tweak to avoid deadlock
235 if (s->peer->close == local_socket_close) {
236 local_socket_close_locked(s->peer);
238 s->peer->close(s->peer);
243 /* If we are already closing, or if there are no
244 ** pending packets, destroy immediately
246 if (s->closing || s->pkt_first == NULL) {
248 local_socket_destroy(s);
249 D("LS(%d): closed\n", id);
253 /* otherwise, put on the closing list
255 D("LS(%d): closing\n", s->id);
257 fdevent_del(&s->fde, FDE_READ);
259 D("LS(%d): put on socket_closing_list fd=%d\n", s->id, s->fd);
260 insert_local_socket(s, &local_socket_closing_list);
263 static void local_socket_event_func(int fd, unsigned ev, void *_s)
267 D("LS(%d): event_func(fd=%d(==%d), ev=%04x)\n", s->id, s->fd, fd, ev);
269 /* put the FDE_WRITE processing before the FDE_READ
270 ** in order to simplify the code.
275 while((p = s->pkt_first) != 0) {
277 int r = sdb_write(fd, p->ptr, p->len);
284 /* returning here is ok because FDE_READ will
285 ** be processed in the next iteration loop
287 if(errno == EAGAIN) return;
288 if(errno == EINTR) continue;
290 D(" closing after write because r=%d and errno is %d\n", r, errno);
296 s->pkt_first = p->next;
297 if(s->pkt_first == 0) s->pkt_last = 0;
302 /* if we sent the last packet of a closing socket,
303 ** we can now destroy it.
306 D(" closing because 'closing' is set after write\n");
311 /* no more packets queued, so we can ignore
312 ** writable events again and tell our peer
315 fdevent_del(&s->fde, FDE_WRITE);
316 s->peer->ready(s->peer);
321 apacket *p = get_apacket();
322 unsigned char *x = p->data;
323 size_t avail = MAX_PAYLOAD;
328 r = sdb_read(fd, x, avail);
329 D("LS(%d): post sdb_read(fd=%d,...) r=%d (errno=%d) avail=%d\n", s->id, s->fd, r, r<0?errno:0, avail);
336 if(errno == EAGAIN) break;
337 if(errno == EINTR) continue;
340 /* r = 0 or unhandled error */
344 D("LS(%d): fd=%d post avail loop. r=%d is_eof=%d forced_eof=%d\n",
345 s->id, s->fd, r, is_eof, s->fde.force_eof);
346 if((avail == MAX_PAYLOAD) || (s->peer == 0)) {
349 p->len = MAX_PAYLOAD - avail;
351 r = s->peer->enqueue(s->peer, p);
352 D("LS(%d): fd=%d post peer->enqueue(). r=%d\n", s->id, s->fd, r);
355 /* error return means they closed us as a side-effect
356 ** and we must return immediately.
358 ** note that if we still have buffered packets, the
359 ** socket will be placed on the closing socket list.
360 ** this handler function will be called again
361 ** to process FDE_WRITE events.
367 /* if the remote cannot accept further events,
368 ** we disable notification of READs. They'll
369 ** be enabled again when we get a call to ready()
371 fdevent_del(&s->fde, FDE_READ);
374 /* Don't allow a forced eof if data is still there */
375 if((s->fde.force_eof && !r) || is_eof) {
376 D(" closing because is_eof=%d r=%d s->fde.force_eof=%d\n", is_eof, r, s->fde.force_eof);
382 /* this should be caught be the next read or write
383 ** catching it here means we may skip the last few
384 ** bytes of readable data.
387 D("LS(%d): FDE_ERROR (fd=%d)\n", s->id, s->fd);
393 asocket *create_local_socket(int fd)
395 asocket *s = calloc(1, sizeof(asocket));
396 if (s == NULL) fatal("cannot allocate socket");
398 s->enqueue = local_socket_enqueue;
399 s->ready = local_socket_ready;
400 s->close = local_socket_close;
401 install_local_socket(s);
403 fdevent_install(&s->fde, fd, local_socket_event_func, s);
404 /* fdevent_add(&s->fde, FDE_ERROR); */
405 //fprintf(stderr, "Created local socket in create_local_socket \n");
406 D("LS(%d): created (fd=%d)\n", s->id, s->fd);
410 asocket *create_local_service_socket(const char *name)
415 #if 0 /* not support in tizen */
417 if (!strcmp(name,"jdwp")) {
418 return create_jdwp_service_socket();
420 if (!strcmp(name,"track-jdwp")) {
421 return create_jdwp_tracker_service_socket();
425 fd = service_to_fd(name);
428 s = create_local_socket(fd);
429 D("LS(%d): bound to '%s' via %d\n", s->id, name, fd);
432 if ((!strncmp(name, "root:", 5) && getuid() != 0)
433 || !strncmp(name, "usb:", 4)
434 || !strncmp(name, "tcpip:", 6)) {
435 D("LS(%d): enabling exit_on_close\n", s->id);
436 s->exit_on_close = 1;
444 static asocket *create_host_service_socket(const char *name, const char* serial)
448 s = host_service_to_socket(name, serial);
451 D("LS(%d) bound to '%s'\n", s->id, name);
457 #endif /* SDB_HOST */
459 /* a Remote socket is used to send/receive data to/from a given transport object
460 ** it needs to be closed when the transport is forcibly destroyed by the user
462 typedef struct aremotesocket {
464 adisconnect disconnect;
467 static int remote_socket_enqueue(asocket *s, apacket *p)
469 D("entered remote_socket_enqueue RS(%d) WRITE fd=%d peer.fd=%d\n",
470 s->id, s->fd, s->peer->fd);
471 p->msg.command = A_WRTE;
472 p->msg.arg0 = s->peer->id;
474 p->msg.data_length = p->len;
475 send_packet(p, s->transport);
479 static void remote_socket_ready(asocket *s)
481 D("entered remote_socket_ready RS(%d) OKAY fd=%d peer.fd=%d\n",
482 s->id, s->fd, s->peer->fd);
483 apacket *p = get_apacket();
484 p->msg.command = A_OKAY;
485 p->msg.arg0 = s->peer->id;
487 send_packet(p, s->transport);
490 static void remote_socket_close(asocket *s)
492 D("entered remote_socket_close RS(%d) CLOSE fd=%d peer->fd=%d\n",
493 s->id, s->fd, s->peer?s->peer->fd:-1);
494 apacket *p = get_apacket();
495 p->msg.command = A_CLSE;
497 p->msg.arg0 = s->peer->id;
499 D("RS(%d) peer->close()ing peer->id=%d peer->fd=%d\n",
500 s->id, s->peer->id, s->peer->fd);
501 s->peer->close(s->peer);
504 send_packet(p, s->transport);
505 D("RS(%d): closed\n", s->id);
506 remove_transport_disconnect( s->transport, &((aremotesocket*)s)->disconnect );
510 static void remote_socket_disconnect(void* _s, atransport* t)
513 asocket* peer = s->peer;
515 D("remote_socket_disconnect RS(%d)\n", s->id);
520 remove_transport_disconnect( s->transport, &((aremotesocket*)s)->disconnect );
524 asocket *create_remote_socket(unsigned id, atransport *t)
526 asocket *s = calloc(1, sizeof(aremotesocket));
527 adisconnect* dis = &((aremotesocket*)s)->disconnect;
529 if (s == NULL) fatal("cannot allocate socket");
531 s->enqueue = remote_socket_enqueue;
532 s->ready = remote_socket_ready;
533 s->close = remote_socket_close;
536 dis->func = remote_socket_disconnect;
538 add_transport_disconnect( t, dis );
539 D("RS(%d): created\n", s->id);
543 void connect_to_remote(asocket *s, const char *destination)
545 D("Connect_to_remote call RS(%d) fd=%d\n", s->id, s->fd);
546 apacket *p = get_apacket();
547 int len = strlen(destination) + 1;
549 if(len > (MAX_PAYLOAD-1)) {
550 fatal("destination oversized");
553 D("LS(%d): connect('%s')\n", s->id, destination);
554 p->msg.command = A_OPEN;
556 p->msg.data_length = len;
557 strcpy((char*) p->data, destination);
558 send_packet(p, s->transport);
562 /* this is used by magic sockets to rig local sockets to
563 send the go-ahead message when they connect */
564 static void local_socket_ready_notify(asocket *s)
566 s->ready = local_socket_ready;
567 s->close = local_socket_close;
568 sdb_write(s->fd, "OKAY", 4);
572 /* this is used by magic sockets to rig local sockets to
573 send the failure message if they are closed before
574 connected (to avoid closing them without a status message) */
575 static void local_socket_close_notify(asocket *s)
577 s->ready = local_socket_ready;
578 s->close = local_socket_close;
579 sendfailmsg(s->fd, "closed");
583 unsigned unhex(unsigned char *s, int len)
589 case '0': case '1': case '2':
590 case '3': case '4': case '5':
591 case '6': case '7': case '8':
595 case 'a': case 'b': case 'c':
596 case 'd': case 'e': case 'f':
599 case 'A': case 'B': case 'C':
600 case 'D': case 'E': case 'F':
613 /* skip_host_serial return the position in a string
614 skipping over the 'serial' parameter in the SDB protocol,
615 where parameter string may be a host:port string containing
616 the protocol delimiter (colon). */
617 char *skip_host_serial(char *service) {
618 char *first_colon, *serial_end;
620 first_colon = strchr(service, ':');
622 /* No colon in service string. */
625 serial_end = first_colon;
626 if (isdigit(serial_end[1])) {
628 while ((*serial_end) && isdigit(*serial_end)) {
631 if ((*serial_end) != ':') {
632 // Something other than numbers was found, reset the end.
633 serial_end = first_colon;
639 static int smart_socket_enqueue(asocket *s, apacket *p)
643 char *service = NULL;
645 transport_type ttype = kTransportAny;
648 D("SS(%d): enqueue %d\n", s->id, p->len);
650 if(s->pkt_first == 0) {
654 if((s->pkt_first->len + p->len) > MAX_PAYLOAD) {
655 D("SS(%d): overflow\n", s->id);
660 memcpy(s->pkt_first->data + s->pkt_first->len,
662 s->pkt_first->len += p->len;
668 /* don't bother if we can't decode the length */
669 if(p->len < 4) return 0;
671 len = unhex(p->data, 4);
672 if((len < 1) || (len > 1024)) {
673 D("SS(%d): bad size (%d)\n", s->id, len);
677 D("SS(%d): len is %d\n", s->id, len );
678 /* can't do anything until we have the full header */
679 if((len + 4) > p->len) {
680 D("SS(%d): waiting for %d more bytes\n", s->id, len+4 - p->len);
684 p->data[len + 4] = 0;
686 D("SS(%d): '%s'\n", s->id, (char*) (p->data + 4));
689 service = (char *)p->data + 4;
690 if(!strncmp(service, "host-serial:", strlen("host-serial:"))) {
692 service += strlen("host-serial:");
694 // serial number should follow "host:" and could be a host:port string.
695 serial_end = skip_host_serial(service);
697 *serial_end = 0; // terminate string
699 service = serial_end + 1;
701 } else if (!strncmp(service, "host-usb:", strlen("host-usb:"))) {
702 ttype = kTransportUsb;
703 service += strlen("host-usb:");
704 } else if (!strncmp(service, "host-local:", strlen("host-local:"))) {
705 ttype = kTransportLocal;
706 service += strlen("host-local:");
707 } else if (!strncmp(service, "host:", strlen("host:"))) {
708 ttype = kTransportAny;
709 service += strlen("host:");
717 /* some requests are handled immediately -- in that
718 ** case the handle_host_request() routine has sent
719 ** the OKAY or FAIL message and all we have to do
722 if(handle_host_request(service, ttype, serial, s->peer->fd, s) == 0) {
723 /* XXX fail message? */
724 D( "SS(%d): handled host service '%s'\n", s->id, service );
727 if (!strncmp(service, "transport", strlen("transport"))) {
728 D( "SS(%d): okay transport\n", s->id );
733 /* try to find a local service with this name.
734 ** if no such service exists, we'll fail out
735 ** and tear down here.
737 s2 = create_host_service_socket(service, serial);
739 D( "SS(%d): couldn't create host service '%s'\n", s->id, service );
740 sendfailmsg(s->peer->fd, "unknown host service");
744 /* we've connected to a local host service,
745 ** so we make our peer back into a regular
746 ** local socket and bind it to the new local
747 ** service socket, acknowledge the successful
748 ** connection, and close this smart socket now
749 ** that its work is done.
751 sdb_write(s->peer->fd, "OKAY", 4);
753 s->peer->ready = local_socket_ready;
754 s->peer->close = local_socket_close;
758 D( "SS(%d): okay\n", s->id );
761 /* initial state is "ready" */
765 #else /* !SDB_HOST */
766 if (s->transport == NULL) {
767 char* error_string = "unknown failure";
768 s->transport = acquire_one_transport (CS_ANY,
769 kTransportAny, NULL, &error_string);
771 if (s->transport == NULL) {
772 sendfailmsg(s->peer->fd, error_string);
778 if(!(s->transport) || (s->transport->connection_state == CS_OFFLINE)) {
779 /* if there's no remote we fail the connection
780 ** right here and terminate it
782 sendfailmsg(s->peer->fd, "device offline (x)");
787 /* instrument our peer to pass the success or fail
788 ** message back once it connects or closes, then
789 ** detach from it, request the connection, and
792 s->peer->ready = local_socket_ready_notify;
793 s->peer->close = local_socket_close_notify;
795 /* give him our transport and upref it */
796 s->peer->transport = s->transport;
798 connect_to_remote(s->peer, (char*) (p->data + 4));
804 /* we're going to close our peer as a side-effect, so
805 ** return -1 to signal that state to the local socket
806 ** who is enqueueing against us
812 static void smart_socket_ready(asocket *s)
814 D("SS(%d): ready\n", s->id);
817 static void smart_socket_close(asocket *s)
819 D("SS(%d): closed\n", s->id);
821 put_apacket(s->pkt_first);
825 s->peer->close(s->peer);
831 asocket *create_smart_socket(void (*action_cb)(asocket *s, const char *act))
833 D("Creating smart socket \n");
834 asocket *s = calloc(1, sizeof(asocket));
835 if (s == NULL) fatal("cannot allocate socket");
836 s->enqueue = smart_socket_enqueue;
837 s->ready = smart_socket_ready;
838 s->close = smart_socket_close;
839 s->extra = action_cb;
841 D("SS(%d): created %p\n", s->id, action_cb);
845 void smart_socket_action(asocket *s, const char *act)
850 void connect_to_smartsocket(asocket *s)
852 D("Connecting to smart socket \n");
853 asocket *ss = create_smart_socket(smart_socket_action);