| OLD | NEW |
| 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef BASE_POSIX_UNIX_DOMAIN_SOCKET_LINUX_H_ | 5 #ifndef BASE_POSIX_UNIX_DOMAIN_SOCKET_LINUX_H_ |
| 6 #define BASE_POSIX_UNIX_DOMAIN_SOCKET_LINUX_H_ | 6 #define BASE_POSIX_UNIX_DOMAIN_SOCKET_LINUX_H_ |
| 7 | 7 |
| 8 #include <stdint.h> | 8 #include <stdint.h> |
| 9 #include <sys/types.h> | 9 #include <sys/types.h> |
| 10 #include <vector> | 10 #include <vector> |
| 11 | 11 |
| 12 #include "base/base_export.h" | 12 #include "base/base_export.h" |
| 13 #include "base/files/scoped_file.h" | 13 #include "base/files/scoped_file.h" |
| 14 #include "base/memory/scoped_vector.h" | 14 #include "base/memory/scoped_vector.h" |
| 15 #include "base/process/process_handle.h" | 15 #include "base/process/process_handle.h" |
| 16 | 16 |
| 17 namespace base { | 17 namespace base { |
| 18 |
| 18 class Pickle; | 19 class Pickle; |
| 19 } | |
| 20 | 20 |
| 21 class BASE_EXPORT UnixDomainSocket { | 21 class BASE_EXPORT UnixDomainSocket { |
| 22 public: | 22 public: |
| 23 // Maximum number of file descriptors that can be read by RecvMsg(). | 23 // Maximum number of file descriptors that can be read by RecvMsg(). |
| 24 static const size_t kMaxFileDescriptors; | 24 static const size_t kMaxFileDescriptors; |
| 25 | 25 |
| 26 #if !defined(OS_NACL_NONSFI) | 26 #if !defined(OS_NACL_NONSFI) |
| 27 // Use to enable receiving process IDs in RecvMsgWithPid. Should be called on | 27 // Use to enable receiving process IDs in RecvMsgWithPid. Should be called on |
| 28 // the receiving socket (i.e., the socket passed to RecvMsgWithPid). Returns | 28 // the receiving socket (i.e., the socket passed to RecvMsgWithPid). Returns |
| 29 // true if successful. | 29 // true if successful. |
| 30 static bool EnableReceiveProcessId(int fd); | 30 static bool EnableReceiveProcessId(int fd); |
| 31 #endif // !defined(OS_NACL_NONSFI) | 31 #endif // !defined(OS_NACL_NONSFI) |
| 32 | 32 |
| 33 // Use sendmsg to write the given msg and include a vector of file | 33 // Use sendmsg to write the given msg and include a vector of file |
| 34 // descriptors. Returns true if successful. | 34 // descriptors. Returns true if successful. |
| 35 static bool SendMsg(int fd, | 35 static bool SendMsg(int fd, |
| 36 const void* msg, | 36 const void* msg, |
| 37 size_t length, | 37 size_t length, |
| 38 const std::vector<int>& fds); | 38 const std::vector<int>& fds); |
| 39 | 39 |
| 40 // Use recvmsg to read a message and an array of file descriptors. Returns | 40 // Use recvmsg to read a message and an array of file descriptors. Returns |
| 41 // -1 on failure. Note: will read, at most, |kMaxFileDescriptors| descriptors. | 41 // -1 on failure. Note: will read, at most, |kMaxFileDescriptors| descriptors. |
| 42 static ssize_t RecvMsg(int fd, | 42 static ssize_t RecvMsg(int fd, |
| 43 void* msg, | 43 void* msg, |
| 44 size_t length, | 44 size_t length, |
| 45 ScopedVector<base::ScopedFD>* fds); | 45 ScopedVector<ScopedFD>* fds); |
| 46 | 46 |
| 47 // Same as RecvMsg above, but also returns the sender's process ID (as seen | 47 // Same as RecvMsg above, but also returns the sender's process ID (as seen |
| 48 // from the caller's namespace). However, before using this function to | 48 // from the caller's namespace). However, before using this function to |
| 49 // receive process IDs, EnableReceiveProcessId() should be called on the | 49 // receive process IDs, EnableReceiveProcessId() should be called on the |
| 50 // receiving socket. | 50 // receiving socket. |
| 51 static ssize_t RecvMsgWithPid(int fd, | 51 static ssize_t RecvMsgWithPid(int fd, |
| 52 void* msg, | 52 void* msg, |
| 53 size_t length, | 53 size_t length, |
| 54 ScopedVector<base::ScopedFD>* fds, | 54 ScopedVector<ScopedFD>* fds, |
| 55 base::ProcessId* pid); | 55 ProcessId* pid); |
| 56 | 56 |
| 57 #if !defined(OS_NACL_NONSFI) | 57 #if !defined(OS_NACL_NONSFI) |
| 58 // Perform a sendmsg/recvmsg pair. | 58 // Perform a sendmsg/recvmsg pair. |
| 59 // 1. This process creates a UNIX SEQPACKET socketpair. Using | 59 // 1. This process creates a UNIX SEQPACKET socketpair. Using |
| 60 // connection-oriented sockets (SEQPACKET or STREAM) is critical here, | 60 // connection-oriented sockets (SEQPACKET or STREAM) is critical here, |
| 61 // because if one of the ends closes the other one must be notified. | 61 // because if one of the ends closes the other one must be notified. |
| 62 // 2. This process writes a request to |fd| with an SCM_RIGHTS control | 62 // 2. This process writes a request to |fd| with an SCM_RIGHTS control |
| 63 // message containing on end of the fresh socket pair. | 63 // message containing on end of the fresh socket pair. |
| 64 // 3. This process blocks reading from the other end of the fresh | 64 // 3. This process blocks reading from the other end of the fresh |
| 65 // socketpair. | 65 // socketpair. |
| 66 // 4. The target process receives the request, processes it and writes the | 66 // 4. The target process receives the request, processes it and writes the |
| 67 // reply to the end of the socketpair contained in the request. | 67 // reply to the end of the socketpair contained in the request. |
| 68 // 5. This process wakes up and continues. | 68 // 5. This process wakes up and continues. |
| 69 // | 69 // |
| 70 // fd: descriptor to send the request on | 70 // fd: descriptor to send the request on |
| 71 // reply: buffer for the reply | 71 // reply: buffer for the reply |
| 72 // reply_len: size of |reply| | 72 // reply_len: size of |reply| |
| 73 // result_fd: (may be NULL) the file descriptor returned in the reply | 73 // result_fd: (may be NULL) the file descriptor returned in the reply |
| 74 // (if any) | 74 // (if any) |
| 75 // request: the bytes to send in the request | 75 // request: the bytes to send in the request |
| 76 static ssize_t SendRecvMsg(int fd, | 76 static ssize_t SendRecvMsg(int fd, |
| 77 uint8_t* reply, | 77 uint8_t* reply, |
| 78 unsigned reply_len, | 78 unsigned reply_len, |
| 79 int* result_fd, | 79 int* result_fd, |
| 80 const base::Pickle& request); | 80 const Pickle& request); |
| 81 | 81 |
| 82 // Similar to SendRecvMsg(), but |recvmsg_flags| allows to control the flags | 82 // Similar to SendRecvMsg(), but |recvmsg_flags| allows to control the flags |
| 83 // of the recvmsg(2) call. | 83 // of the recvmsg(2) call. |
| 84 static ssize_t SendRecvMsgWithFlags(int fd, | 84 static ssize_t SendRecvMsgWithFlags(int fd, |
| 85 uint8_t* reply, | 85 uint8_t* reply, |
| 86 unsigned reply_len, | 86 unsigned reply_len, |
| 87 int recvmsg_flags, | 87 int recvmsg_flags, |
| 88 int* result_fd, | 88 int* result_fd, |
| 89 const base::Pickle& request); | 89 const Pickle& request); |
| 90 #endif // !defined(OS_NACL_NONSFI) | 90 #endif // !defined(OS_NACL_NONSFI) |
| 91 private: | 91 private: |
| 92 // Similar to RecvMsg, but allows to specify |flags| for recvmsg(2). | 92 // Similar to RecvMsg, but allows to specify |flags| for recvmsg(2). |
| 93 static ssize_t RecvMsgWithFlags(int fd, | 93 static ssize_t RecvMsgWithFlags(int fd, |
| 94 void* msg, | 94 void* msg, |
| 95 size_t length, | 95 size_t length, |
| 96 int flags, | 96 int flags, |
| 97 ScopedVector<base::ScopedFD>* fds, | 97 ScopedVector<ScopedFD>* fds, |
| 98 base::ProcessId* pid); | 98 ProcessId* pid); |
| 99 }; | 99 }; |
| 100 | 100 |
| 101 } // namespace base |
| 102 |
| 101 #endif // BASE_POSIX_UNIX_DOMAIN_SOCKET_LINUX_H_ | 103 #endif // BASE_POSIX_UNIX_DOMAIN_SOCKET_LINUX_H_ |
| OLD | NEW |