1c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui/* 2c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * Copyright (C) 2015 The Android Open Source Project 3c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * 4c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * Licensed under the Apache License, Version 2.0 (the "License"); 5c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * you may not use this file except in compliance with the License. 6c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * You may obtain a copy of the License at 7c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * 8c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * http://www.apache.org/licenses/LICENSE-2.0 9c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * 10c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * Unless required by applicable law or agreed to in writing, software 11c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * distributed under the License is distributed on an "AS IS" BASIS, 12c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * See the License for the specific language governing permissions and 14c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui * limitations under the License. 15c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 16c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 17c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui#ifndef __ADB_SOCKET_H 18c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui#define __ADB_SOCKET_H 19c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 20c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui#include <stddef.h> 21c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 22c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui#include "fdevent.h" 23c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 24c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuistruct apacket; 25c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuiclass atransport; 26c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 27c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui/* An asocket represents one half of a connection between a local and 28c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui** remote entity. A local asocket is bound to a file descriptor. A 29c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui** remote asocket is bound to the protocol engine. 30c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui*/ 31c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuistruct asocket { 32c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* chain pointers for the local/remote list of 33c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** asockets that this asocket lives in 34c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 35c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui asocket *next; 36c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui asocket *prev; 37c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 38c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* the unique identifier for this asocket 39c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 40c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui unsigned id; 41c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 42c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* flag: set when the socket's peer has closed 43c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** but packets are still queued for delivery 44c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 45c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui int closing; 46c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 47c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui // flag: set when the socket failed to write, so the socket will not wait to 48c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui // write packets and close directly. 49c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui bool has_write_error; 50c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 51c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* flag: quit adbd when both ends close the 52c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** local service socket 53c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 54c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui int exit_on_close; 55c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 56c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* the asocket we are connected to 57c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 58c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 59c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui asocket *peer; 60c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 61c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* For local asockets, the fde is used to bind 62c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** us to our fd event system. For remote asockets 63c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** these fields are not used. 64c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 65c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui fdevent fde; 66c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui int fd; 67c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 68c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* queue of apackets waiting to be written 69c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 70c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui apacket *pkt_first; 71c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui apacket *pkt_last; 72c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 73c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* enqueue is called by our peer when it has data 74c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** for us. It should return 0 if we can accept more 75c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** data or 1 if not. If we return 1, we must call 76c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** peer->ready() when we once again are ready to 77c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** receive data. 78c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 79c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui int (*enqueue)(asocket *s, apacket *pkt); 80c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 81c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* ready is called by the peer when it is ready for 82c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** us to send data via enqueue again 83c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 84c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui void (*ready)(asocket *s); 85c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 86c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* shutdown is called by the peer before it goes away. 87c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** the socket should not do any further calls on its peer. 88c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** Always followed by a call to close. Optional, i.e. can be NULL. 89c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 90c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui void (*shutdown)(asocket *s); 91c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 92c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* close is called by the peer when it has gone away. 93c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** we are not allowed to make any further calls on the 94c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui ** peer once our close method is called. 95c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui */ 96c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui void (*close)(asocket *s); 97c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 98c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui /* A socket is bound to atransport */ 99c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui atransport *transport; 100c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 101c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui size_t get_max_payload() const; 102c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui}; 103c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 104c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuiasocket *find_local_socket(unsigned local_id, unsigned remote_id); 105c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuivoid install_local_socket(asocket *s); 106c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuivoid remove_socket(asocket *s); 107c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuivoid close_all_sockets(atransport *t); 108c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 109c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuiasocket *create_local_socket(int fd); 110c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuiasocket *create_local_service_socket(const char* destination, 111c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui const atransport* transport); 112c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 113c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuiasocket *create_remote_socket(unsigned id, atransport *t); 114c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuivoid connect_to_remote(asocket *s, const char *destination); 115c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cuivoid connect_to_smartsocket(asocket *s); 116c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui 117802c54ebb79453256a8c7fd3c3cab88acc8a84e8David Pursell// Internal functions that are only made available here for testing purposes. 118802c54ebb79453256a8c7fd3c3cab88acc8a84e8David Pursellnamespace internal { 119802c54ebb79453256a8c7fd3c3cab88acc8a84e8David Pursell 120802c54ebb79453256a8c7fd3c3cab88acc8a84e8David Pursell#if ADB_HOST 121802c54ebb79453256a8c7fd3c3cab88acc8a84e8David Pursellchar* skip_host_serial(const char* service); 122802c54ebb79453256a8c7fd3c3cab88acc8a84e8David Pursell#endif 123802c54ebb79453256a8c7fd3c3cab88acc8a84e8David Pursell 124802c54ebb79453256a8c7fd3c3cab88acc8a84e8David Pursell} // namespace internal 125802c54ebb79453256a8c7fd3c3cab88acc8a84e8David Pursell 126c1b1f6ff5de82b457923eea3f0bbad1ac2e459d7Yabin Cui#endif // __ADB_SOCKET_H 127