• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
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
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16 #include "common/libs/fs/shared_fd.h"
17 
18 #include <arpa/inet.h>
19 #include <errno.h>
20 #include <fcntl.h>
21 #include <net/if.h>
22 #include <netinet/in.h>
23 #include <poll.h>
24 #include <sys/file.h>
25 #include <sys/mman.h>
26 #include <sys/stat.h>
27 #include <sys/syscall.h>
28 #include <sys/types.h>
29 #include <unistd.h>
30 #include <cstddef>
31 
32 #include <algorithm>
33 #include <sstream>
34 #include <vector>
35 
36 #include <android-base/file.h>
37 #include <android-base/logging.h>
38 
39 #include "common/libs/fs/shared_buf.h"
40 #include "common/libs/fs/shared_select.h"
41 #include "common/libs/utils/result.h"
42 
43 // #define ENABLE_GCE_SHARED_FD_LOGGING 1
44 
45 namespace cuttlefish {
46 
47 namespace {
48 
MarkAll(const SharedFDSet & input,fd_set * dest,int * max_index)49 void MarkAll(const SharedFDSet& input, fd_set* dest, int* max_index) {
50   for (SharedFDSet::const_iterator it = input.begin(); it != input.end();
51        ++it) {
52     (*it)->Set(dest, max_index);
53   }
54 }
55 
CheckMarked(fd_set * in_out_mask,SharedFDSet * in_out_set)56 void CheckMarked(fd_set* in_out_mask, SharedFDSet* in_out_set) {
57   if (!in_out_set) {
58     return;
59   }
60   SharedFDSet save;
61   save.swap(in_out_set);
62   for (SharedFDSet::iterator it = save.begin(); it != save.end(); ++it) {
63     if ((*it)->IsSet(in_out_mask)) {
64       in_out_set->Set(*it);
65     }
66   }
67 }
68 
69 /*
70  * Android currently has host prebuilts of glibc 2.15 and 2.17, but
71  * memfd_create was only added in glibc 2.27. It was defined in Linux 3.17,
72  * so we consider it safe to use the low-level arbitrary syscall wrapper.
73  */
74 #ifndef __NR_memfd_create
75 # if defined(__x86_64__)
76 #  define __NR_memfd_create 319
77 # elif defined(__i386__)
78 #  define __NR_memfd_create 356
79 # elif defined(__aarch64__)
80 #  define __NR_memfd_create 279
81 # else
82 /* No interest in other architectures. */
83 #  error "Unknown architecture."
84 # endif
85 #endif
86 
memfd_create_wrapper(const char * name,unsigned int flags)87 int memfd_create_wrapper(const char* name, unsigned int flags) {
88 #ifdef CUTTLEFISH_HOST
89   // TODO(schuffelen): Use memfd_create with a newer host libc.
90   return syscall(__NR_memfd_create, name, flags);
91 #else
92   return memfd_create(name, flags);
93 #endif
94 }
95 
IsRegularFile(const int fd)96 bool IsRegularFile(const int fd) {
97   struct stat info;
98   if (fstat(fd, &info) < 0) {
99     return false;
100   }
101   return S_ISREG(info.st_mode);
102 }
103 
104 constexpr size_t kPreferredBufferSize = 8192;
105 
106 }  // namespace
107 
CopyFrom(FileInstance & in,size_t length)108 bool FileInstance::CopyFrom(FileInstance& in, size_t length) {
109   std::vector<char> buffer(kPreferredBufferSize);
110   while (length > 0) {
111     // Wait until either in becomes readable or our fd closes.
112     constexpr ssize_t IN = 0;
113     constexpr ssize_t OUT = 1;
114     struct pollfd pollfds[2];
115     pollfds[IN].fd = in.fd_;
116     pollfds[IN].events = POLLIN;
117     pollfds[IN].revents = 0;
118     pollfds[OUT].fd = fd_;
119     pollfds[OUT].events = 0;
120     pollfds[OUT].revents = 0;
121     int res = poll(pollfds, 2, -1 /* indefinitely */);
122     if (res < 0) {
123       errno_ = errno;
124       return false;
125     }
126     if (pollfds[OUT].revents != 0) {
127       // destination was either closed, invalid or errored, either way there is no
128       // point in continuing.
129       return false;
130     }
131 
132     ssize_t num_read = in.Read(buffer.data(), std::min(buffer.size(), length));
133     if (num_read <= 0) {
134       return false;
135     }
136     length -= num_read;
137 
138     ssize_t written = 0;
139     do {
140       // No need to use poll for writes: even if the source closes, the data
141       // needs to be delivered to the other side.
142       auto res = Write(buffer.data(), num_read);
143       if (res <= 0) {
144         // The caller will have to log an appropriate message.
145         return false;
146       }
147       written += res;
148     } while(written < num_read);
149   }
150   return true;
151 }
152 
CopyAllFrom(FileInstance & in)153 bool FileInstance::CopyAllFrom(FileInstance& in) {
154   // FileInstance may have been constructed with a non-zero errno_ value because
155   // the errno variable is not zeroed out before.
156   errno_ = 0;
157   in.errno_ = 0;
158   while (CopyFrom(in, kPreferredBufferSize)) {
159   }
160   // Only return false if there was an actual error.
161   return !GetErrno() && !in.GetErrno();
162 }
163 
Close()164 void FileInstance::Close() {
165   std::stringstream message;
166   if (fd_ == -1) {
167     errno_ = EBADF;
168   } else if (close(fd_) == -1) {
169     errno_ = errno;
170     if (identity_.size()) {
171       message << __FUNCTION__ << ": " << identity_ << " failed (" << StrError() << ")";
172       std::string message_str = message.str();
173       Log(message_str.c_str());
174     }
175   } else {
176     if (identity_.size()) {
177       message << __FUNCTION__ << ": " << identity_ << "succeeded";
178       std::string message_str = message.str();
179       Log(message_str.c_str());
180     }
181   }
182   fd_ = -1;
183 }
184 
Chmod(mode_t mode)185 bool FileInstance::Chmod(mode_t mode) {
186   int original_error = errno;
187   int ret = fchmod(fd_, mode);
188   if (ret != 0) {
189     errno_ = errno;
190   }
191   errno = original_error;
192   return ret == 0;
193 }
194 
ConnectWithTimeout(const struct sockaddr * addr,socklen_t addrlen,struct timeval * timeout)195 int FileInstance::ConnectWithTimeout(const struct sockaddr* addr,
196                                      socklen_t addrlen,
197                                      struct timeval* timeout) {
198   int original_flags = Fcntl(F_GETFL, 0);
199   if (original_flags == -1) {
200     LOG(ERROR) << "Could not get current file descriptor flags: " << StrError();
201     return -1;
202   }
203   if (Fcntl(F_SETFL, original_flags | O_NONBLOCK) == -1) {
204     LOG(ERROR) << "Failed to set O_NONBLOCK: " << StrError();
205     return -1;
206   }
207 
208   auto connect_res = Connect(
209       addr, addrlen);  // This will return immediately because of O_NONBLOCK
210 
211   if (connect_res == 0) {  // Immediate success
212     if (Fcntl(F_SETFL, original_flags) == -1) {
213       LOG(ERROR) << "Failed to restore original flags: " << StrError();
214       return -1;
215     }
216     return 0;
217   }
218 
219   if (GetErrno() != EAGAIN && GetErrno() != EINPROGRESS) {
220     LOG(DEBUG) << "Immediate connection failure: " << StrError();
221     if (Fcntl(F_SETFL, original_flags) == -1) {
222       LOG(ERROR) << "Failed to restore original flags: " << StrError();
223     }
224     return -1;
225   }
226 
227   fd_set fdset;
228   FD_ZERO(&fdset);
229   FD_SET(fd_, &fdset);
230 
231   int select_res = select(fd_ + 1, nullptr, &fdset, nullptr, timeout);
232 
233   if (Fcntl(F_SETFL, original_flags) == -1) {
234     LOG(ERROR) << "Failed to restore original flags: " << StrError();
235     return -1;
236   }
237 
238   if (select_res != 1) {
239     LOG(ERROR) << "Did not connect within the timeout";
240     return -1;
241   }
242 
243   int so_error;
244   socklen_t len = sizeof(so_error);
245   if (GetSockOpt(SOL_SOCKET, SO_ERROR, &so_error, &len) == -1) {
246     LOG(ERROR) << "Failed to get socket options: " << StrError();
247     return -1;
248   }
249 
250   if (so_error != 0) {
251     LOG(ERROR) << "Failure in opening socket: " << so_error;
252     errno_ = so_error;
253     return -1;
254   }
255   errno_ = 0;
256   return 0;
257 }
258 
IsSet(fd_set * in) const259 bool FileInstance::IsSet(fd_set* in) const {
260   if (IsOpen() && FD_ISSET(fd_, in)) {
261     return true;
262   }
263   return false;
264 }
265 
266 #if ENABLE_GCE_SHARED_FD_LOGGING
Log(const char * message)267 void FileInstance::Log(const char* message) {
268   LOG(INFO) << message;
269 }
270 #else
Log(const char *)271 void FileInstance::Log(const char*) {}
272 #endif
273 
Set(fd_set * dest,int * max_index) const274 void FileInstance::Set(fd_set* dest, int* max_index) const {
275   if (!IsOpen()) {
276     return;
277   }
278   if (fd_ >= *max_index) {
279     *max_index = fd_ + 1;
280   }
281   FD_SET(fd_, dest);
282 }
283 
Select(SharedFDSet * read_set,SharedFDSet * write_set,SharedFDSet * error_set,struct timeval * timeout)284 int Select(SharedFDSet* read_set, SharedFDSet* write_set,
285            SharedFDSet* error_set, struct timeval* timeout) {
286   int max_index = 0;
287   fd_set readfds;
288   FD_ZERO(&readfds);
289   if (read_set) {
290     MarkAll(*read_set, &readfds, &max_index);
291   }
292   fd_set writefds;
293   FD_ZERO(&writefds);
294   if (write_set) {
295     MarkAll(*write_set, &writefds, &max_index);
296   }
297   fd_set errorfds;
298   FD_ZERO(&errorfds);
299   if (error_set) {
300     MarkAll(*error_set, &errorfds, &max_index);
301   }
302 
303   int rval = TEMP_FAILURE_RETRY(
304       select(max_index, &readfds, &writefds, &errorfds, timeout));
305   FileInstance::Log("select\n");
306   CheckMarked(&readfds, read_set);
307   CheckMarked(&writefds, write_set);
308   CheckMarked(&errorfds, error_set);
309   return rval;
310 }
311 
Poll(std::vector<PollSharedFd> & fds,int timeout)312 int SharedFD::Poll(std::vector<PollSharedFd>& fds, int timeout) {
313   return Poll(fds.data(), fds.size(), timeout);
314 }
315 
Poll(PollSharedFd * fds,size_t num_fds,int timeout)316 int SharedFD::Poll(PollSharedFd* fds, size_t num_fds, int timeout) {
317   std::vector<pollfd> native_pollfds(num_fds);
318   for (size_t i = 0; i < num_fds; i++) {
319     native_pollfds[i].fd = fds[i].fd->fd_;
320     native_pollfds[i].events = fds[i].events;
321     native_pollfds[i].revents = 0;
322   }
323   int ret = poll(native_pollfds.data(), native_pollfds.size(), timeout);
324   for (size_t i = 0; i < num_fds; i++) {
325     fds[i].revents = native_pollfds[i].revents;
326   }
327   return ret;
328 }
329 
MakeAddress(const char * name,bool abstract,struct sockaddr_un * dest,socklen_t * len)330 static void MakeAddress(const char* name, bool abstract,
331                         struct sockaddr_un* dest, socklen_t* len) {
332   memset(dest, 0, sizeof(*dest));
333   dest->sun_family = AF_UNIX;
334   // sun_path is NOT expected to be nul-terminated.
335   // See man 7 unix.
336   size_t namelen;
337   if (abstract) {
338     // ANDROID_SOCKET_NAMESPACE_ABSTRACT
339     namelen = strlen(name);
340     CHECK_LE(namelen, sizeof(dest->sun_path) - 1)
341         << "MakeAddress failed. Name=" << name << " is longer than allowed.";
342     dest->sun_path[0] = 0;
343     memcpy(dest->sun_path + 1, name, namelen);
344   } else {
345     // ANDROID_SOCKET_NAMESPACE_RESERVED
346     // ANDROID_SOCKET_NAMESPACE_FILESYSTEM
347     // TODO(pinghao): Distinguish between them?
348     namelen = strlen(name);
349     CHECK_LE(namelen, sizeof(dest->sun_path))
350         << "MakeAddress failed. Name=" << name << " is longer than allowed.";
351     strncpy(dest->sun_path, name, strlen(name));
352   }
353   *len = namelen + offsetof(struct sockaddr_un, sun_path) + 1;
354 }
355 
Accept(const FileInstance & listener,struct sockaddr * addr,socklen_t * addrlen)356 SharedFD SharedFD::Accept(const FileInstance& listener, struct sockaddr* addr,
357                           socklen_t* addrlen) {
358   return SharedFD(
359       std::shared_ptr<FileInstance>(listener.Accept(addr, addrlen)));
360 }
361 
Accept(const FileInstance & listener)362 SharedFD SharedFD::Accept(const FileInstance& listener) {
363   return SharedFD::Accept(listener, NULL, NULL);
364 }
365 
Dup(int unmanaged_fd)366 SharedFD SharedFD::Dup(int unmanaged_fd) {
367   int fd = fcntl(unmanaged_fd, F_DUPFD_CLOEXEC, 3);
368   int error_num = errno;
369   return SharedFD(std::shared_ptr<FileInstance>(new FileInstance(fd, error_num)));
370 }
371 
Pipe(SharedFD * fd0,SharedFD * fd1)372 bool SharedFD::Pipe(SharedFD* fd0, SharedFD* fd1) {
373   int fds[2];
374   int rval = pipe(fds);
375   if (rval != -1) {
376     (*fd0) = std::shared_ptr<FileInstance>(new FileInstance(fds[0], errno));
377     (*fd1) = std::shared_ptr<FileInstance>(new FileInstance(fds[1], errno));
378     return true;
379   }
380   return false;
381 }
382 
Event(int initval,int flags)383 SharedFD SharedFD::Event(int initval, int flags) {
384   int fd = eventfd(initval, flags);
385   return std::shared_ptr<FileInstance>(new FileInstance(fd, errno));
386 }
387 
MemfdCreate(const std::string & name,unsigned int flags)388 SharedFD SharedFD::MemfdCreate(const std::string& name, unsigned int flags) {
389   int fd = memfd_create_wrapper(name.c_str(), flags);
390   int error_num = errno;
391   return std::shared_ptr<FileInstance>(new FileInstance(fd, error_num));
392 }
393 
MemfdCreateWithData(const std::string & name,const std::string & data,unsigned int flags)394 SharedFD SharedFD::MemfdCreateWithData(const std::string& name, const std::string& data, unsigned int flags) {
395   auto memfd = MemfdCreate(name, flags);
396   if (WriteAll(memfd, data) != data.size()) {
397     return ErrorFD(errno);
398   }
399   if (memfd->LSeek(0, SEEK_SET) != 0) {
400     return ErrorFD(memfd->GetErrno());
401   }
402   if (!memfd->Chmod(0700)) {
403     return ErrorFD(memfd->GetErrno());
404   }
405   return memfd;
406 }
407 
SocketPair(int domain,int type,int protocol,SharedFD * fd0,SharedFD * fd1)408 bool SharedFD::SocketPair(int domain, int type, int protocol,
409                           SharedFD* fd0, SharedFD* fd1) {
410   int fds[2];
411   int rval = socketpair(domain, type, protocol, fds);
412   if (rval != -1) {
413     (*fd0) = std::shared_ptr<FileInstance>(new FileInstance(fds[0], errno));
414     (*fd1) = std::shared_ptr<FileInstance>(new FileInstance(fds[1], errno));
415     return true;
416   }
417   return false;
418 }
419 
Open(const std::string & path,int flags,mode_t mode)420 SharedFD SharedFD::Open(const std::string& path, int flags, mode_t mode) {
421   int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
422   if (fd == -1) {
423     return SharedFD(std::shared_ptr<FileInstance>(new FileInstance(fd, errno)));
424   } else {
425     return SharedFD(std::shared_ptr<FileInstance>(new FileInstance(fd, 0)));
426   }
427 }
428 
Creat(const std::string & path,mode_t mode)429 SharedFD SharedFD::Creat(const std::string& path, mode_t mode) {
430   return SharedFD::Open(path, O_CREAT|O_WRONLY|O_TRUNC, mode);
431 }
432 
Fchdir(SharedFD shared_fd)433 int SharedFD::Fchdir(SharedFD shared_fd) {
434   if (!shared_fd.value_) {
435     return -1;
436   }
437   errno = 0;
438   int rval = TEMP_FAILURE_RETRY(fchdir(shared_fd->fd_));
439   shared_fd->errno_ = errno;
440   return rval;
441 }
442 
Fifo(const std::string & path,mode_t mode)443 SharedFD SharedFD::Fifo(const std::string& path, mode_t mode) {
444   struct stat st;
445   if (TEMP_FAILURE_RETRY(stat(path.c_str(), &st)) == 0) {
446     if (TEMP_FAILURE_RETRY(remove(path.c_str())) != 0) {
447       return ErrorFD(errno);
448     }
449   }
450 
451   int rval = TEMP_FAILURE_RETRY(mkfifo(path.c_str(), mode));
452   if (rval == -1) {
453     return ErrorFD(errno);
454   }
455   return Open(path, O_RDWR);
456 }
457 
Socket(int domain,int socket_type,int protocol)458 SharedFD SharedFD::Socket(int domain, int socket_type, int protocol) {
459   int fd = TEMP_FAILURE_RETRY(socket(domain, socket_type, protocol));
460   if (fd == -1) {
461     return SharedFD(std::shared_ptr<FileInstance>(new FileInstance(fd, errno)));
462   } else {
463     return SharedFD(std::shared_ptr<FileInstance>(new FileInstance(fd, 0)));
464   }
465 }
466 
Mkstemp(std::string * path)467 SharedFD SharedFD::Mkstemp(std::string* path) {
468   int fd = mkstemp(path->data());
469   if (fd == -1) {
470     return SharedFD(std::shared_ptr<FileInstance>(new FileInstance(fd, errno)));
471   } else {
472     return SharedFD(std::shared_ptr<FileInstance>(new FileInstance(fd, 0)));
473   }
474 }
475 
ErrorFD(int error)476 SharedFD SharedFD::ErrorFD(int error) {
477   return SharedFD(std::shared_ptr<FileInstance>(new FileInstance(-1, error)));
478 }
479 
SocketLocalClient(const std::string & name,bool abstract,int in_type)480 SharedFD SharedFD::SocketLocalClient(const std::string& name, bool abstract,
481                                      int in_type) {
482   return SocketLocalClient(name, abstract, in_type, 0);
483 }
484 
SocketLocalClient(const std::string & name,bool abstract,int in_type,int timeout_seconds)485 SharedFD SharedFD::SocketLocalClient(const std::string& name, bool abstract,
486                                      int in_type, int timeout_seconds) {
487   struct sockaddr_un addr;
488   socklen_t addrlen;
489   MakeAddress(name.c_str(), abstract, &addr, &addrlen);
490   SharedFD rval = SharedFD::Socket(PF_UNIX, in_type, 0);
491   if (!rval->IsOpen()) {
492     return rval;
493   }
494   struct timeval timeout = {timeout_seconds, 0};
495   auto casted_addr = reinterpret_cast<sockaddr*>(&addr);
496   if (rval->ConnectWithTimeout(casted_addr, addrlen, &timeout) == -1) {
497     return SharedFD::ErrorFD(rval->GetErrno());
498   }
499   return rval;
500 }
501 
SocketLocalClient(int port,int type)502 SharedFD SharedFD::SocketLocalClient(int port, int type) {
503   sockaddr_in addr{};
504   addr.sin_family = AF_INET;
505   addr.sin_port = htons(port);
506   addr.sin_addr.s_addr = htonl(INADDR_ANY);
507   auto rval = SharedFD::Socket(AF_INET, type, 0);
508   if (!rval->IsOpen()) {
509     return rval;
510   }
511   if (rval->Connect(reinterpret_cast<const sockaddr*>(&addr), sizeof addr) < 0) {
512     return SharedFD::ErrorFD(rval->GetErrno());
513   }
514   return rval;
515 }
516 
SocketClient(const std::string & host,int port,int type)517 SharedFD SharedFD::SocketClient(const std::string& host, int port, int type) {
518   sockaddr_in addr{};
519   addr.sin_family = AF_INET;
520   addr.sin_port = htons(port);
521   addr.sin_addr.s_addr = inet_addr(host.c_str());
522   auto rval = SharedFD::Socket(AF_INET, type, 0);
523   if (!rval->IsOpen()) {
524     return rval;
525   }
526   if (rval->Connect(reinterpret_cast<const sockaddr*>(&addr), sizeof addr) < 0) {
527     return SharedFD::ErrorFD(rval->GetErrno());
528   }
529   return rval;
530 }
531 
Socket6Client(const std::string & host,const std::string & interface,int port,int type)532 SharedFD SharedFD::Socket6Client(const std::string& host, const std::string& interface,
533                                  int port, int type) {
534   sockaddr_in6 addr{};
535   addr.sin6_family = AF_INET6;
536   addr.sin6_port = htons(port);
537   inet_pton(AF_INET6, host.c_str(), &addr.sin6_addr);
538   auto rval = SharedFD::Socket(AF_INET6, type, 0);
539   if (!rval->IsOpen()) {
540     return rval;
541   }
542 
543   if (!interface.empty()) {
544     ifreq ifr{};
545     snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "%s", interface.c_str());
546 
547     if (rval->SetSockOpt(SOL_SOCKET, SO_BINDTODEVICE, &ifr, sizeof(ifr)) == -1) {
548       return SharedFD::ErrorFD(rval->GetErrno());
549     }
550   }
551 
552   if (rval->Connect(reinterpret_cast<const sockaddr*>(&addr), sizeof addr) < 0) {
553     return SharedFD::ErrorFD(rval->GetErrno());
554   }
555   return rval;
556 }
557 
SocketLocalServer(int port,int type)558 SharedFD SharedFD::SocketLocalServer(int port, int type) {
559   struct sockaddr_in addr;
560   memset(&addr, 0, sizeof(addr));
561   addr.sin_family = AF_INET;
562   addr.sin_port = htons(port);
563   addr.sin_addr.s_addr = htonl(INADDR_ANY);
564   SharedFD rval = SharedFD::Socket(AF_INET, type, 0);
565   if(!rval->IsOpen()) {
566     return rval;
567   }
568   int n = 1;
569   if (rval->SetSockOpt(SOL_SOCKET, SO_REUSEADDR, &n, sizeof(n)) == -1) {
570     LOG(ERROR) << "SetSockOpt failed " << rval->StrError();
571     return SharedFD::ErrorFD(rval->GetErrno());
572   }
573   if(rval->Bind(reinterpret_cast<sockaddr*>(&addr), sizeof(addr)) < 0) {
574     LOG(ERROR) << "Bind failed " << rval->StrError();
575     return SharedFD::ErrorFD(rval->GetErrno());
576   }
577   if (type == SOCK_STREAM || type == SOCK_SEQPACKET) {
578     if (rval->Listen(4) < 0) {
579       LOG(ERROR) << "Listen failed " << rval->StrError();
580       return SharedFD::ErrorFD(rval->GetErrno());
581     }
582   }
583   return rval;
584 }
585 
SocketLocalServer(const std::string & name,bool abstract,int in_type,mode_t mode)586 SharedFD SharedFD::SocketLocalServer(const std::string& name, bool abstract,
587                                      int in_type, mode_t mode) {
588   // DO NOT UNLINK addr.sun_path. It does NOT have to be null-terminated.
589   // See man 7 unix for more details.
590   if (!abstract) (void)unlink(name.c_str());
591 
592   struct sockaddr_un addr;
593   socklen_t addrlen;
594   MakeAddress(name.c_str(), abstract, &addr, &addrlen);
595   SharedFD rval = SharedFD::Socket(PF_UNIX, in_type, 0);
596   if (!rval->IsOpen()) {
597     return rval;
598   }
599 
600   int n = 1;
601   if (rval->SetSockOpt(SOL_SOCKET, SO_REUSEADDR, &n, sizeof(n)) == -1) {
602     LOG(ERROR) << "SetSockOpt failed " << rval->StrError();
603     return SharedFD::ErrorFD(rval->GetErrno());
604   }
605   if (rval->Bind(reinterpret_cast<sockaddr*>(&addr), addrlen) == -1) {
606     LOG(ERROR) << "Bind failed; name=" << name << ": " << rval->StrError();
607     return SharedFD::ErrorFD(rval->GetErrno());
608   }
609 
610   /* Only the bottom bits are really the socket type; there are flags too. */
611   constexpr int SOCK_TYPE_MASK = 0xf;
612   auto socket_type = in_type & SOCK_TYPE_MASK;
613 
614   // Connection oriented sockets: start listening.
615   if (socket_type == SOCK_STREAM || socket_type == SOCK_SEQPACKET) {
616     // Follows the default from socket_local_server
617     if (rval->Listen(1) == -1) {
618       LOG(ERROR) << "Listen failed: " << rval->StrError();
619       return SharedFD::ErrorFD(rval->GetErrno());
620     }
621   }
622 
623   if (!abstract) {
624     if (TEMP_FAILURE_RETRY(chmod(name.c_str(), mode)) == -1) {
625       LOG(ERROR) << "chmod failed: " << strerror(errno);
626       // However, continue since we do have a listening socket
627     }
628   }
629   return rval;
630 }
631 
VsockServer(unsigned int port,int type,unsigned int cid)632 SharedFD SharedFD::VsockServer(unsigned int port, int type, unsigned int cid) {
633   auto vsock = SharedFD::Socket(AF_VSOCK, type, 0);
634   if (!vsock->IsOpen()) {
635     return vsock;
636   }
637   sockaddr_vm addr{};
638   addr.svm_family = AF_VSOCK;
639   addr.svm_port = port;
640   addr.svm_cid = cid;
641   auto casted_addr = reinterpret_cast<sockaddr*>(&addr);
642   if (vsock->Bind(casted_addr, sizeof(addr)) == -1) {
643     LOG(ERROR) << "Port " << port << " Bind failed (" << vsock->StrError()
644                << ")";
645     return SharedFD::ErrorFD(vsock->GetErrno());
646   }
647   if (type == SOCK_STREAM || type == SOCK_SEQPACKET) {
648     if (vsock->Listen(4) < 0) {
649       LOG(ERROR) << "Port" << port << " Listen failed (" << vsock->StrError()
650                  << ")";
651       return SharedFD::ErrorFD(vsock->GetErrno());
652     }
653   }
654   return vsock;
655 }
656 
VsockServer(int type)657 SharedFD SharedFD::VsockServer(int type) {
658   return VsockServer(VMADDR_PORT_ANY, type);
659 }
660 
VsockClient(unsigned int cid,unsigned int port,int type)661 SharedFD SharedFD::VsockClient(unsigned int cid, unsigned int port, int type) {
662   auto vsock = SharedFD::Socket(AF_VSOCK, type, 0);
663   if (!vsock->IsOpen()) {
664     return vsock;
665   }
666   sockaddr_vm addr{};
667   addr.svm_family = AF_VSOCK;
668   addr.svm_port = port;
669   addr.svm_cid = cid;
670   auto casted_addr = reinterpret_cast<sockaddr*>(&addr);
671   if (vsock->Connect(casted_addr, sizeof(addr)) == -1) {
672     return SharedFD::ErrorFD(vsock->GetErrno());
673   }
674   return vsock;
675 }
676 
lock() const677 SharedFD WeakFD::lock() const {
678   auto locked_file_instance = value_.lock();
679   if (locked_file_instance) {
680     return SharedFD(locked_file_instance);
681   }
682   return SharedFD();
683 }
684 
ScopedMMap(void * ptr,size_t len)685 ScopedMMap::ScopedMMap(void* ptr, size_t len) : ptr_(ptr), len_(len) {}
686 
ScopedMMap()687 ScopedMMap::ScopedMMap() : ptr_(MAP_FAILED), len_(0) {}
688 
ScopedMMap(ScopedMMap && other)689 ScopedMMap::ScopedMMap(ScopedMMap&& other)
690     : ptr_(other.ptr_), len_(other.len_) {
691   other.ptr_ = MAP_FAILED;
692   other.len_ = 0;
693 }
694 
~ScopedMMap()695 ScopedMMap::~ScopedMMap() {
696   if (ptr_ != MAP_FAILED) {
697     munmap(ptr_, len_);
698   }
699 }
700 
ClosedInstance()701 /* static */ std::shared_ptr<FileInstance> FileInstance::ClosedInstance() {
702   return std::shared_ptr<FileInstance>(new FileInstance(-1, EBADF));
703 }
704 
Bind(const struct sockaddr * addr,socklen_t addrlen)705 int FileInstance::Bind(const struct sockaddr* addr, socklen_t addrlen) {
706   errno = 0;
707   int rval = bind(fd_, addr, addrlen);
708   errno_ = errno;
709   return rval;
710 }
711 
Connect(const struct sockaddr * addr,socklen_t addrlen)712 int FileInstance::Connect(const struct sockaddr* addr, socklen_t addrlen) {
713   errno = 0;
714   int rval = connect(fd_, addr, addrlen);
715   errno_ = errno;
716   return rval;
717 }
718 
UNMANAGED_Dup()719 int FileInstance::UNMANAGED_Dup() {
720   errno = 0;
721   int rval = TEMP_FAILURE_RETRY(dup(fd_));
722   errno_ = errno;
723   return rval;
724 }
725 
UNMANAGED_Dup2(int newfd)726 int FileInstance::UNMANAGED_Dup2(int newfd) {
727   errno = 0;
728   int rval = TEMP_FAILURE_RETRY(dup2(fd_, newfd));
729   errno_ = errno;
730   return rval;
731 }
732 
Fcntl(int command,int value)733 int FileInstance::Fcntl(int command, int value) {
734   errno = 0;
735   int rval = TEMP_FAILURE_RETRY(fcntl(fd_, command, value));
736   errno_ = errno;
737   return rval;
738 }
739 
Flock(int operation)740 Result<void> FileInstance::Flock(int operation) {
741   errno = 0;
742   int rval = TEMP_FAILURE_RETRY(flock(fd_, operation));
743   errno_ = errno;
744   CF_EXPECT(rval == 0, StrError());
745   return {};
746 }
747 
GetSockName(struct sockaddr * addr,socklen_t * addrlen)748 int FileInstance::GetSockName(struct sockaddr* addr, socklen_t* addrlen) {
749   errno = 0;
750   int rval = TEMP_FAILURE_RETRY(getsockname(fd_, addr, addrlen));
751   if (rval == -1) {
752     errno_ = errno;
753   }
754   return rval;
755 }
756 
VsockServerPort()757 unsigned int FileInstance::VsockServerPort() {
758   struct sockaddr_vm vm_socket;
759   socklen_t length = sizeof(vm_socket);
760   GetSockName(reinterpret_cast<struct sockaddr*>(&vm_socket), &length);
761   return vm_socket.svm_port;
762 }
763 
Ioctl(int request,void * val)764 int FileInstance::Ioctl(int request, void* val) {
765   errno = 0;
766   int rval = TEMP_FAILURE_RETRY(ioctl(fd_, request, val));
767   errno_ = errno;
768   return rval;
769 }
770 
LinkAtCwd(const std::string & path)771 int FileInstance::LinkAtCwd(const std::string& path) {
772   std::string name = "/proc/self/fd/";
773   name += std::to_string(fd_);
774   errno = 0;
775   int rval =
776       linkat(-1, name.c_str(), AT_FDCWD, path.c_str(), AT_SYMLINK_FOLLOW);
777   errno_ = errno;
778   return rval;
779 }
780 
Listen(int backlog)781 int FileInstance::Listen(int backlog) {
782   errno = 0;
783   int rval = listen(fd_, backlog);
784   errno_ = errno;
785   return rval;
786 }
787 
LSeek(off_t offset,int whence)788 off_t FileInstance::LSeek(off_t offset, int whence) {
789   errno = 0;
790   off_t rval = TEMP_FAILURE_RETRY(lseek(fd_, offset, whence));
791   errno_ = errno;
792   return rval;
793 }
794 
Recv(void * buf,size_t len,int flags)795 ssize_t FileInstance::Recv(void* buf, size_t len, int flags) {
796   errno = 0;
797   ssize_t rval = TEMP_FAILURE_RETRY(recv(fd_, buf, len, flags));
798   errno_ = errno;
799   return rval;
800 }
801 
RecvMsg(struct msghdr * msg,int flags)802 ssize_t FileInstance::RecvMsg(struct msghdr* msg, int flags) {
803   errno = 0;
804   ssize_t rval = TEMP_FAILURE_RETRY(recvmsg(fd_, msg, flags));
805   errno_ = errno;
806   return rval;
807 }
808 
Read(void * buf,size_t count)809 ssize_t FileInstance::Read(void* buf, size_t count) {
810   errno = 0;
811   ssize_t rval = TEMP_FAILURE_RETRY(read(fd_, buf, count));
812   errno_ = errno;
813   return rval;
814 }
815 
EventfdRead(eventfd_t * value)816 int FileInstance::EventfdRead(eventfd_t* value) {
817   errno = 0;
818   auto rval = eventfd_read(fd_, value);
819   errno_ = errno;
820   return rval;
821 }
822 
Send(const void * buf,size_t len,int flags)823 ssize_t FileInstance::Send(const void* buf, size_t len, int flags) {
824   errno = 0;
825   ssize_t rval = TEMP_FAILURE_RETRY(send(fd_, buf, len, flags));
826   errno_ = errno;
827   return rval;
828 }
829 
SendMsg(const struct msghdr * msg,int flags)830 ssize_t FileInstance::SendMsg(const struct msghdr* msg, int flags) {
831   errno = 0;
832   ssize_t rval = TEMP_FAILURE_RETRY(sendmsg(fd_, msg, flags));
833   errno_ = errno;
834   return rval;
835 }
836 
Shutdown(int how)837 int FileInstance::Shutdown(int how) {
838   errno = 0;
839   int rval = shutdown(fd_, how);
840   errno_ = errno;
841   return rval;
842 }
843 
SetSockOpt(int level,int optname,const void * optval,socklen_t optlen)844 int FileInstance::SetSockOpt(int level, int optname, const void* optval,
845                              socklen_t optlen) {
846   errno = 0;
847   int rval = setsockopt(fd_, level, optname, optval, optlen);
848   errno_ = errno;
849   return rval;
850 }
851 
GetSockOpt(int level,int optname,void * optval,socklen_t * optlen)852 int FileInstance::GetSockOpt(int level, int optname, void* optval,
853                              socklen_t* optlen) {
854   errno = 0;
855   int rval = getsockopt(fd_, level, optname, optval, optlen);
856   errno_ = errno;
857   return rval;
858 }
859 
SetTerminalRaw()860 int FileInstance::SetTerminalRaw() {
861   errno = 0;
862   termios terminal_settings;
863   int rval = tcgetattr(fd_, &terminal_settings);
864   errno_ = errno;
865   if (rval < 0) {
866     return rval;
867   }
868   cfmakeraw(&terminal_settings);
869   rval = tcsetattr(fd_, TCSANOW, &terminal_settings);
870   errno_ = errno;
871   return rval;
872 }
873 
StrError() const874 std::string FileInstance::StrError() const {
875   errno = 0;
876   return std::string(strerror(errno_));
877 }
878 
MMap(void * addr,size_t length,int prot,int flags,off_t offset)879 ScopedMMap FileInstance::MMap(void* addr, size_t length, int prot, int flags,
880                               off_t offset) {
881   errno = 0;
882   auto ptr = mmap(addr, length, prot, flags, fd_, offset);
883   errno_ = errno;
884   return ScopedMMap(ptr, length);
885 }
886 
Truncate(off_t length)887 ssize_t FileInstance::Truncate(off_t length) {
888   errno = 0;
889   ssize_t rval = TEMP_FAILURE_RETRY(ftruncate(fd_, length));
890   errno_ = errno;
891   return rval;
892 }
893 
Write(const void * buf,size_t count)894 ssize_t FileInstance::Write(const void* buf, size_t count) {
895   if (count == 0 && !IsRegular()) {
896     return 0;
897   }
898   errno = 0;
899   ssize_t rval = TEMP_FAILURE_RETRY(write(fd_, buf, count));
900   errno_ = errno;
901   return rval;
902 }
903 
EventfdWrite(eventfd_t value)904 int FileInstance::EventfdWrite(eventfd_t value) {
905   errno = 0;
906   int rval = eventfd_write(fd_, value);
907   errno_ = errno;
908   return rval;
909 }
910 
IsATTY()911 bool FileInstance::IsATTY() {
912   errno = 0;
913   int rval = isatty(fd_);
914   errno_ = errno;
915   return rval;
916 }
917 
ProcFdLinkTarget() const918 Result<std::string> FileInstance::ProcFdLinkTarget() const {
919   std::stringstream output_composer;
920   output_composer << "/proc/" << getpid() << "/fd/" << fd_;
921   const std::string mem_fd_link = output_composer.str();
922   std::string mem_fd_target;
923   CF_EXPECT(
924       android::base::Readlink(mem_fd_link, &mem_fd_target),
925       "Getting link for the memory file \"" << mem_fd_link << "\" failed");
926   return mem_fd_target;
927 }
928 
FileInstance(int fd,int in_errno)929 FileInstance::FileInstance(int fd, int in_errno)
930     : fd_(fd), errno_(in_errno), is_regular_file_(IsRegularFile(fd_)) {
931   // Ensure every file descriptor managed by a FileInstance has the CLOEXEC
932   // flag
933   TEMP_FAILURE_RETRY(fcntl(fd, F_SETFD, FD_CLOEXEC));
934   std::stringstream identity;
935   identity << "fd=" << fd << " @" << this;
936   identity_ = identity.str();
937 }
938 
Accept(struct sockaddr * addr,socklen_t * addrlen) const939 FileInstance* FileInstance::Accept(struct sockaddr* addr,
940                                    socklen_t* addrlen) const {
941   int fd = TEMP_FAILURE_RETRY(accept(fd_, addr, addrlen));
942   if (fd == -1) {
943     return new FileInstance(fd, errno);
944   } else {
945     return new FileInstance(fd, 0);
946   }
947 }
948 
949 }  // namespace cuttlefish
950