1815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell/* 2815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * Copyright (C) 2015 The Android Open Source Project 3815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * All rights reserved. 4815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * 5815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * Redistribution and use in source and binary forms, with or without 6815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * modification, are permitted provided that the following conditions 7815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * are met: 8815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * * Redistributions of source code must retain the above copyright 9815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * notice, this list of conditions and the following disclaimer. 10815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * * Redistributions in binary form must reproduce the above copyright 11815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * notice, this list of conditions and the following disclaimer in 12815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * the documentation and/or other materials provided with the 13815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * distribution. 14815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * 15815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 18815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 19815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 20815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 22815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 25815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell * SUCH DAMAGE. 27815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell */ 28815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 29572bce29088521caf7f90c9fa66a8237a7674435David Pursell// This file provides a class interface for cross-platform socket functionality. The main fastboot 30815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell// engine should not be using this interface directly, but instead should use a higher-level 31572bce29088521caf7f90c9fa66a8237a7674435David Pursell// interface that enforces the fastboot protocol. 32815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 33815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell#ifndef SOCKET_H_ 34815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell#define SOCKET_H_ 35815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 36b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell#include <functional> 37815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell#include <memory> 38815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell#include <string> 39b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell#include <utility> 40b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell#include <vector> 41815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 42572bce29088521caf7f90c9fa66a8237a7674435David Pursell#include <android-base/macros.h> 43572bce29088521caf7f90c9fa66a8237a7674435David Pursell#include <cutils/sockets.h> 44b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell#include <gtest/gtest_prod.h> 45572bce29088521caf7f90c9fa66a8237a7674435David Pursell 46572bce29088521caf7f90c9fa66a8237a7674435David Pursell// Socket interface to be implemented for each platform. 47572bce29088521caf7f90c9fa66a8237a7674435David Pursellclass Socket { 48815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell public: 49572bce29088521caf7f90c9fa66a8237a7674435David Pursell enum class Protocol { kTcp, kUdp }; 50572bce29088521caf7f90c9fa66a8237a7674435David Pursell 51c3a466960ff19bbf9b28b4d069dd0b872d4165d8David Pursell // Returns the socket error message. This must be called immediately after a socket failure 52c3a466960ff19bbf9b28b4d069dd0b872d4165d8David Pursell // before any other system calls are made. 53c3a466960ff19bbf9b28b4d069dd0b872d4165d8David Pursell static std::string GetErrorMessage(); 54c3a466960ff19bbf9b28b4d069dd0b872d4165d8David Pursell 55815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell // Creates a new client connection. Clients are connected to a specific hostname/port and can 56815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell // only send to that destination. 57815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell // On failure, |error| is filled (if non-null) and nullptr is returned. 58572bce29088521caf7f90c9fa66a8237a7674435David Pursell static std::unique_ptr<Socket> NewClient(Protocol protocol, const std::string& hostname, 59572bce29088521caf7f90c9fa66a8237a7674435David Pursell int port, std::string* error); 60815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 61815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell // Creates a new server bound to local |port|. This is only meant for testing, during normal 62815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell // fastboot operation the device acts as the server. 63572bce29088521caf7f90c9fa66a8237a7674435David Pursell // A UDP server saves sender addresses in Receive(), and uses the most recent address during 64815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell // calls to Send(). 65572bce29088521caf7f90c9fa66a8237a7674435David Pursell static std::unique_ptr<Socket> NewServer(Protocol protocol, int port); 66815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 67572bce29088521caf7f90c9fa66a8237a7674435David Pursell // Destructor closes the socket if it's open. 68572bce29088521caf7f90c9fa66a8237a7674435David Pursell virtual ~Socket(); 69815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 70572bce29088521caf7f90c9fa66a8237a7674435David Pursell // Sends |length| bytes of |data|. For TCP sockets this will continue trying to send until all 71b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell // bytes are transmitted. Returns true on success. 72b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell virtual bool Send(const void* data, size_t length) = 0; 73b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell 74b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell // Sends |buffers| using multi-buffer write, which can be significantly faster than making 75b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell // multiple calls. For UDP sockets |buffers| are all combined into a single datagram; for 76b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell // TCP sockets this will continue sending until all buffers are fully transmitted. Returns true 77b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell // on success. 78b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell // 79b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell // Note: This is non-functional for UDP server Sockets because it's not currently needed and 80b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell // would require an additional sendto() variation of multi-buffer write. 81b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell virtual bool Send(std::vector<cutils_socket_buffer_t> buffers) = 0; 82815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 83815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell // Waits up to |timeout_ms| to receive up to |length| bytes of data. |timout_ms| of 0 will 848bcce68f10c6bea50867430f876813d3a2f36968David Pursell // block forever. Returns the number of bytes received or -1 on error/timeout; see 858bcce68f10c6bea50867430f876813d3a2f36968David Pursell // ReceiveTimedOut() to distinguish between the two. 86815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell virtual ssize_t Receive(void* data, size_t length, int timeout_ms) = 0; 87815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 88572bce29088521caf7f90c9fa66a8237a7674435David Pursell // Calls Receive() until exactly |length| bytes have been received or an error occurs. 89572bce29088521caf7f90c9fa66a8237a7674435David Pursell virtual ssize_t ReceiveAll(void* data, size_t length, int timeout_ms); 90572bce29088521caf7f90c9fa66a8237a7674435David Pursell 918bcce68f10c6bea50867430f876813d3a2f36968David Pursell // Returns true if the last Receive() call timed out normally and can be retried; fatal errors 928bcce68f10c6bea50867430f876813d3a2f36968David Pursell // or successful reads will return false. 938bcce68f10c6bea50867430f876813d3a2f36968David Pursell bool ReceiveTimedOut() { return receive_timed_out_; } 948bcce68f10c6bea50867430f876813d3a2f36968David Pursell 95815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell // Closes the socket. Returns 0 on success, -1 on error. 96572bce29088521caf7f90c9fa66a8237a7674435David Pursell virtual int Close(); 97572bce29088521caf7f90c9fa66a8237a7674435David Pursell 98572bce29088521caf7f90c9fa66a8237a7674435David Pursell // Accepts an incoming TCP connection. No effect for UDP sockets. Returns a new Socket 99572bce29088521caf7f90c9fa66a8237a7674435David Pursell // connected to the client on success, nullptr on failure. 100572bce29088521caf7f90c9fa66a8237a7674435David Pursell virtual std::unique_ptr<Socket> Accept() { return nullptr; } 101815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 102c3a466960ff19bbf9b28b4d069dd0b872d4165d8David Pursell // Returns the local port the Socket is bound to or -1 on error. 103c3a466960ff19bbf9b28b4d069dd0b872d4165d8David Pursell int GetLocalPort(); 104c3a466960ff19bbf9b28b4d069dd0b872d4165d8David Pursell 105815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell protected: 106815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell // Protected constructor to force factory function use. 107572bce29088521caf7f90c9fa66a8237a7674435David Pursell Socket(cutils_socket_t sock); 108572bce29088521caf7f90c9fa66a8237a7674435David Pursell 1098bcce68f10c6bea50867430f876813d3a2f36968David Pursell // Blocks up to |timeout_ms| until a read is possible on |sock_|, and sets |receive_timed_out_| 1108bcce68f10c6bea50867430f876813d3a2f36968David Pursell // as appropriate to help distinguish between normal timeouts and fatal errors. Returns true if 1118bcce68f10c6bea50867430f876813d3a2f36968David Pursell // a subsequent recv() on |sock_| will complete without blocking or if |timeout_ms| <= 0. 1128bcce68f10c6bea50867430f876813d3a2f36968David Pursell bool WaitForRecv(int timeout_ms); 113572bce29088521caf7f90c9fa66a8237a7674435David Pursell 114572bce29088521caf7f90c9fa66a8237a7674435David Pursell cutils_socket_t sock_ = INVALID_SOCKET; 1158bcce68f10c6bea50867430f876813d3a2f36968David Pursell bool receive_timed_out_ = false; 116572bce29088521caf7f90c9fa66a8237a7674435David Pursell 117b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell // Non-class functions we want to override during tests to verify functionality. Implementation 118b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell // should call this rather than using socket_send_buffers() directly. 119b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell std::function<ssize_t(cutils_socket_t, cutils_socket_buffer_t*, size_t)> 120b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell socket_send_buffers_function_ = &socket_send_buffers; 121b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell 122572bce29088521caf7f90c9fa66a8237a7674435David Pursell private: 123b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell FRIEND_TEST(SocketTest, TestTcpSendBuffers); 124b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell FRIEND_TEST(SocketTest, TestUdpSendBuffers); 125b34e4a06eeaaeaa42e0de6fdb44fb4202839b996David Pursell 126572bce29088521caf7f90c9fa66a8237a7674435David Pursell DISALLOW_COPY_AND_ASSIGN(Socket); 127815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell}; 128815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell 129815c7beae73bc0d13f14a94972175756aec1d4deDavid Pursell#endif // SOCKET_H_ 130