| 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 IPC_FILE_DESCRIPTOR_SET_POSIX_H_ | 5 #ifndef IPC_FILE_DESCRIPTOR_SET_POSIX_H_ |
| 6 #define IPC_FILE_DESCRIPTOR_SET_POSIX_H_ | 6 #define IPC_FILE_DESCRIPTOR_SET_POSIX_H_ |
| 7 | 7 |
| 8 #include <vector> | 8 #include <vector> |
| 9 | 9 |
| 10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
| 11 #include "base/file_descriptor_posix.h" | 11 #include "base/files/file.h" |
| 12 #include "base/memory/ref_counted.h" | 12 #include "base/memory/ref_counted.h" |
| 13 #include "base/memory/scoped_vector.h" |
| 13 #include "ipc/ipc_export.h" | 14 #include "ipc/ipc_export.h" |
| 14 | 15 |
| 15 // ----------------------------------------------------------------------------- | 16 // ----------------------------------------------------------------------------- |
| 16 // A FileDescriptorSet is an ordered set of POSIX file descriptors. These are | 17 // A FileDescriptorSet is an ordered set of POSIX file descriptors. These are |
| 17 // associated with IPC messages so that descriptors can be transmitted over a | 18 // associated with IPC messages so that descriptors can be transmitted over a |
| 18 // UNIX domain socket. | 19 // UNIX domain socket. |
| 19 // ----------------------------------------------------------------------------- | 20 // ----------------------------------------------------------------------------- |
| 20 class IPC_EXPORT FileDescriptorSet | 21 class IPC_EXPORT FileDescriptorSet |
| 21 : public base::RefCountedThreadSafe<FileDescriptorSet> { | 22 : public base::RefCountedThreadSafe<FileDescriptorSet> { |
| 22 public: | 23 public: |
| 23 FileDescriptorSet(); | 24 FileDescriptorSet(); |
| 24 | 25 |
| 25 // This is the maximum number of descriptors per message. We need to know this | 26 // This is the maximum number of descriptors per message. We need to know this |
| 26 // because the control message kernel interface has to be given a buffer which | 27 // because the control message kernel interface has to be given a buffer which |
| 27 // is large enough to store all the descriptor numbers. Otherwise the kernel | 28 // is large enough to store all the descriptor numbers. Otherwise the kernel |
| 28 // tells us that it truncated the control data and the extra descriptors are | 29 // tells us that it truncated the control data and the extra descriptors are |
| 29 // lost. | 30 // lost. |
| 30 // | 31 // |
| 31 // In debugging mode, it's a fatal error to try and add more than this number | 32 // In debugging mode, it's a fatal error to try and add more than this number |
| 32 // of descriptors to a FileDescriptorSet. | 33 // of descriptors to a FileDescriptorSet. |
| 33 static const size_t kMaxDescriptorsPerMessage = 7; | 34 static const size_t kMaxDescriptorsPerMessage = 7; |
| 34 | 35 |
| 35 // --------------------------------------------------------------------------- | 36 // --------------------------------------------------------------------------- |
| 36 // Interfaces for building during message serialisation... | 37 // Interfaces for building during message serialisation... |
| 37 | 38 |
| 38 // Add a descriptor to the end of the set. Returns false iff the set is full. | 39 // Add a descriptor to the end of the set. Returns false iff the set is full. |
| 39 bool Add(int fd); | 40 bool AddToBorrow(base::PlatformFile fd); |
| 40 // Add a descriptor to the end of the set and automatically close it after | 41 // Add a descriptor to the end of the set and automatically close it after |
| 41 // transmission. Returns false iff the set is full. | 42 // transmission. Returns false iff the set is full. |
| 42 bool AddAndAutoClose(int fd); | 43 bool AddToOwn(base::File fd); |
| 43 | 44 |
| 44 // --------------------------------------------------------------------------- | 45 // --------------------------------------------------------------------------- |
| 45 | 46 |
| 46 | 47 |
| 47 // --------------------------------------------------------------------------- | 48 // --------------------------------------------------------------------------- |
| 48 // Interfaces for accessing during message deserialisation... | 49 // Interfaces for accessing during message deserialisation... |
| 49 | 50 |
| 50 // Return the number of descriptors | 51 // Return the number of descriptors |
| 51 unsigned size() const { return descriptors_.size(); } | 52 unsigned size() const { |
| 53 return owned_descriptors_.size() + borrowed_descriptors_.size(); |
| 54 } |
| 55 |
| 52 // Return true if no unconsumed descriptors remain | 56 // Return true if no unconsumed descriptors remain |
| 53 bool empty() const { return descriptors_.empty(); } | 57 bool empty() const { return 0 == size(); } |
| 54 // Fetch the nth descriptor from the beginning of the set. Code using this | 58 // Take the nth descriptor from the beginning of the set, |
| 55 // /must/ access the descriptors in order, except that it may wrap from the | 59 // transferring the ownership of the descriptor taken. Code using this |
| 56 // end to index 0 again. | 60 // /must/ access the descriptors in order, and must do it at most once. |
| 57 // | 61 // |
| 58 // This interface is designed for the deserialising code as it doesn't | 62 // This interface is designed for the deserialising code as it doesn't |
| 59 // support close flags. | 63 // support close flags. |
| 60 // returns: file descriptor, or -1 on error | 64 // returns: file descriptor, or -1 on error |
| 61 int GetDescriptorAt(unsigned n) const; | 65 base::PlatformFile TakeDescriptorAt(unsigned n); |
| 62 | 66 |
| 63 // --------------------------------------------------------------------------- | 67 // --------------------------------------------------------------------------- |
| 64 | 68 |
| 65 | 69 |
| 66 // --------------------------------------------------------------------------- | 70 // --------------------------------------------------------------------------- |
| 67 // Interfaces for transmission... | 71 // Interfaces for transmission... |
| 68 | 72 |
| 69 // Fill an array with file descriptors without 'consuming' them. CommitAll | 73 // Fill an array with file descriptors without 'consuming' them. CommitAll |
| 70 // must be called after these descriptors have been transmitted. | 74 // must be called after these descriptors have been transmitted. |
| 71 // buffer: (output) a buffer of, at least, size() integers. | 75 // buffer: (output) a buffer of, at least, size() integers. |
| 72 void GetDescriptors(int* buffer) const; | 76 void GetDescriptors(int* buffer) const; |
| 73 // This must be called after transmitting the descriptors returned by | 77 // This must be called after transmitting the descriptors returned by |
| 74 // GetDescriptors. It marks all the descriptors as consumed and closes those | 78 // GetDescriptors. It marks all the descriptors as consumed and closes those |
| 75 // which are auto-close. | 79 // which are auto-close. |
| 76 void CommitAll(); | 80 void CommitAll(); |
| 77 // Returns true if any contained file descriptors appear to be handles to a | 81 // Returns true if any contained file descriptors appear to be handles to a |
| 78 // directory. | 82 // directory. |
| 79 bool ContainsDirectoryDescriptor() const; | 83 bool ContainsDirectoryDescriptor() const; |
| 80 // Fetch all filedescriptors with the "auto close" property. | 84 // Fetch all filedescriptors with the "auto close" property. |
| 81 // Used instead of CommitAll() when closing must be handled manually. | 85 // Used instead of CommitAll() when closing must be handled manually. |
| 82 void ReleaseFDsToClose(std::vector<int>* fds); | 86 void ReleaseFDsToClose(std::vector<base::PlatformFile>* fds); |
| 83 | 87 |
| 84 // --------------------------------------------------------------------------- | 88 // --------------------------------------------------------------------------- |
| 85 | 89 |
| 86 | 90 |
| 87 // --------------------------------------------------------------------------- | 91 // --------------------------------------------------------------------------- |
| 88 // Interfaces for receiving... | 92 // Interfaces for receiving... |
| 89 | 93 |
| 90 // Set the contents of the set from the given buffer. This set must be empty | 94 // Set the contents of the set from the given buffer. This set must be empty |
| 91 // before calling. The auto-close flag is set on all the descriptors so that | 95 // before calling. The auto-close flag is set on all the descriptors so that |
| 92 // unconsumed descriptors are closed on destruction. | 96 // unconsumed descriptors are closed on destruction. |
| 93 void SetDescriptors(const int* buffer, unsigned count); | 97 void SetDescriptors(const base::PlatformFile* buffer, unsigned count); |
| 94 | 98 |
| 95 // --------------------------------------------------------------------------- | 99 // --------------------------------------------------------------------------- |
| 96 | 100 |
| 97 private: | 101 private: |
| 98 friend class base::RefCountedThreadSafe<FileDescriptorSet>; | 102 friend class base::RefCountedThreadSafe<FileDescriptorSet>; |
| 99 | 103 |
| 100 ~FileDescriptorSet(); | 104 ~FileDescriptorSet(); |
| 101 | 105 |
| 102 // A vector of descriptors and close flags. If this message is sent, then | 106 // A vector of descriptors and close flags. If this message is sent, then |
| 103 // these descriptors are sent as control data. After sending, any descriptors | 107 // these descriptors are sent as control data. After sending, any descriptors |
| 104 // with a true flag are closed. If this message has been received, then these | 108 // with a true flag are closed. If this message has been received, then these |
| 105 // are the descriptors which were received and all close flags are true. | 109 // are the descriptors which were received and all close flags are true. |
| 106 std::vector<base::FileDescriptor> descriptors_; | 110 std::vector<base::PlatformFile> borrowed_descriptors_; |
| 111 ScopedVector<base::File> owned_descriptors_; |
| 107 | 112 |
| 108 // This contains the index of the next descriptor which should be consumed. | 113 // This contains the index of the next descriptor which should be consumed. |
| 109 // It's used in a couple of ways. Firstly, at destruction we can check that | 114 // It's used in a couple of ways. Firstly, at destruction we can check that |
| 110 // all the descriptors have been read (with GetNthDescriptor). Secondly, we | 115 // all the descriptors have been read (with GetNthDescriptor). Secondly, we |
| 111 // can check that they are read in order. | 116 // can check that they are read in order. |
| 112 mutable unsigned consumed_descriptor_highwater_; | 117 mutable unsigned consumed_descriptor_highwater_; |
| 113 | 118 |
| 114 DISALLOW_COPY_AND_ASSIGN(FileDescriptorSet); | 119 DISALLOW_COPY_AND_ASSIGN(FileDescriptorSet); |
| 115 }; | 120 }; |
| 116 | 121 |
| 117 #endif // IPC_FILE_DESCRIPTOR_SET_POSIX_H_ | 122 #endif // IPC_FILE_DESCRIPTOR_SET_POSIX_H_ |
| OLD | NEW |