OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 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 DBUS_FILE_DESCRIPTOR_H_ | 5 #ifndef DBUS_FILE_DESCRIPTOR_H_ |
6 #define DBUS_FILE_DESCRIPTOR_H_ | 6 #define DBUS_FILE_DESCRIPTOR_H_ |
7 | 7 |
8 #include "base/basictypes.h" | 8 #include "base/basictypes.h" |
| 9 #include "base/memory/scoped_ptr.h" |
9 #include "dbus/dbus_export.h" | 10 #include "dbus/dbus_export.h" |
10 | 11 |
11 namespace dbus { | 12 namespace dbus { |
12 | 13 |
13 // FileDescriptor is a type used to encapsulate D-Bus file descriptors | 14 // FileDescriptor is a type used to encapsulate D-Bus file descriptors |
14 // and to follow the RAII idiom appropiate for use with message operations | 15 // and to follow the RAII idiom appropiate for use with message operations |
15 // where the descriptor might be easily leaked. To guard against this the | 16 // where the descriptor might be easily leaked. To guard against this the |
16 // descriptor is closed when an instance is destroyed if it is owned. | 17 // descriptor is closed when an instance is destroyed if it is owned. |
17 // Ownership is asserted only when PutValue is used and TakeValue can be | 18 // Ownership is asserted only when PutValue is used and TakeValue can be |
18 // used to take ownership. | 19 // used to take ownership. |
19 // | 20 // |
20 // For example, in the following | 21 // For example, in the following |
21 // FileDescriptor fd; | 22 // FileDescriptor fd; |
22 // if (!reader->PopString(&name) || | 23 // if (!reader->PopString(&name) || |
23 // !reader->PopFileDescriptor(&fd) || | 24 // !reader->PopFileDescriptor(&fd) || |
24 // !reader->PopUint32(&flags)) { | 25 // !reader->PopUint32(&flags)) { |
25 // the descriptor in fd will be closed if the PopUint32 fails. But | 26 // the descriptor in fd will be closed if the PopUint32 fails. But |
26 // writer.AppendFileDescriptor(dbus::FileDescriptor(1)); | 27 // writer.AppendFileDescriptor(dbus::FileDescriptor(1)); |
27 // will not automatically close "1" because it is not owned. | 28 // will not automatically close "1" because it is not owned. |
28 // | 29 // |
29 // Descriptors must be validated before marshalling in a D-Bus message | 30 // Descriptors must be validated before marshalling in a D-Bus message |
30 // or using them after unmarshalling. We disallow descriptors to a | 31 // or using them after unmarshalling. We disallow descriptors to a |
31 // directory to reduce the security risks. Splitting out validation | 32 // directory to reduce the security risks. Splitting out validation |
32 // also allows the caller to do this work on the File thread to conform | 33 // also allows the caller to do this work on the File thread to conform |
33 // with i/o restrictions. | 34 // with i/o restrictions. |
34 class CHROME_DBUS_EXPORT FileDescriptor { | 35 class CHROME_DBUS_EXPORT FileDescriptor { |
35 public: | 36 public: |
| 37 // This provides a simple way to pass around file descriptors since they must |
| 38 // be closed on a thread that is allowed to perform I/O. |
| 39 struct Deleter { |
| 40 void CHROME_DBUS_EXPORT operator()(FileDescriptor* fd); |
| 41 }; |
| 42 |
36 // Permits initialization without a value for passing to | 43 // Permits initialization without a value for passing to |
37 // dbus::MessageReader::PopFileDescriptor to fill in and from int values. | 44 // dbus::MessageReader::PopFileDescriptor to fill in and from int values. |
38 FileDescriptor() : value_(-1), owner_(false), valid_(false) {} | 45 FileDescriptor() : value_(-1), owner_(false), valid_(false) {} |
39 explicit FileDescriptor(int value) : value_(value), owner_(false), | 46 explicit FileDescriptor(int value) : value_(value), owner_(false), |
40 valid_(false) {} | 47 valid_(false) {} |
41 | 48 |
42 virtual ~FileDescriptor(); | 49 virtual ~FileDescriptor(); |
43 | 50 |
44 // Retrieves value as an int without affecting ownership. | 51 // Retrieves value as an int without affecting ownership. |
45 int value() const; | 52 int value() const; |
(...skipping 17 matching lines...) Expand all Loading... |
63 void CheckValidity(); | 70 void CheckValidity(); |
64 | 71 |
65 private: | 72 private: |
66 int value_; | 73 int value_; |
67 bool owner_; | 74 bool owner_; |
68 bool valid_; | 75 bool valid_; |
69 | 76 |
70 DISALLOW_COPY_AND_ASSIGN(FileDescriptor); | 77 DISALLOW_COPY_AND_ASSIGN(FileDescriptor); |
71 }; | 78 }; |
72 | 79 |
| 80 using ScopedFileDescriptor = |
| 81 scoped_ptr<FileDescriptor, FileDescriptor::Deleter>; |
| 82 |
73 } // namespace dbus | 83 } // namespace dbus |
74 | 84 |
75 #endif // DBUS_FILE_DESCRIPTOR_H_ | 85 #endif // DBUS_FILE_DESCRIPTOR_H_ |
OLD | NEW |