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_FILE_DESCRIPTOR_SHUFFLE_H_ | 5 #ifndef BASE_FILE_DESCRIPTOR_SHUFFLE_H_ |
6 #define BASE_FILE_DESCRIPTOR_SHUFFLE_H_ | 6 #define BASE_FILE_DESCRIPTOR_SHUFFLE_H_ |
7 #pragma once | 7 #pragma once |
8 | 8 |
9 // This code exists to perform the shuffling of file descriptors which is | 9 // This code exists to perform the shuffling of file descriptors which is |
10 // commonly needed when forking subprocesses. The naive approve is very simple, | 10 // commonly needed when forking subprocesses. The naive approve is very simple, |
11 // just call dup2 to setup the desired descriptors, but wrong. It's tough to | 11 // just call dup2 to setup the desired descriptors, but wrong. It's tough to |
12 // handle the edge cases (like mapping 0 -> 1, 1 -> 0) correctly. | 12 // handle the edge cases (like mapping 0 -> 1, 1 -> 0) correctly. |
13 // | 13 // |
14 // In order to unittest this code, it's broken into the abstract action (an | 14 // In order to unittest this code, it's broken into the abstract action (an |
15 // injective multimap) and the concrete code for dealing with file descriptors. | 15 // injective multimap) and the concrete code for dealing with file descriptors. |
16 // Users should use the code like this: | 16 // Users should use the code like this: |
17 // base::InjectiveMultimap file_descriptor_map; | 17 // base::InjectiveMultimap file_descriptor_map; |
18 // file_descriptor_map.push_back(base::InjectionArc(devnull, 0, true)); | 18 // file_descriptor_map.push_back(base::InjectionArc(devnull, 0, true)); |
19 // file_descriptor_map.push_back(base::InjectionArc(devnull, 2, true)); | 19 // file_descriptor_map.push_back(base::InjectionArc(devnull, 2, true)); |
20 // file_descriptor_map.push_back(base::InjectionArc(pipe[1], 1, true)); | 20 // file_descriptor_map.push_back(base::InjectionArc(pipe[1], 1, true)); |
21 // base::ShuffleFileDescriptors(file_descriptor_map); | 21 // base::ShuffleFileDescriptors(file_descriptor_map); |
22 // | 22 // |
23 // and trust the the Right Thing will get done. | 23 // and trust the the Right Thing will get done. |
24 | 24 |
25 #include <vector> | 25 #include <vector> |
26 | 26 |
27 #include "base/base_export.h" | 27 #include "base/base_export.h" |
| 28 #include "base/compiler_specific.h" |
28 | 29 |
29 namespace base { | 30 namespace base { |
30 | 31 |
31 // A Delegate which performs the actions required to perform an injective | 32 // A Delegate which performs the actions required to perform an injective |
32 // multimapping in place. | 33 // multimapping in place. |
33 class InjectionDelegate { | 34 class InjectionDelegate { |
34 public: | 35 public: |
35 // Duplicate |fd|, an element of the domain, and write a fresh element of the | 36 // Duplicate |fd|, an element of the domain, and write a fresh element of the |
36 // domain into |result|. Returns true iff successful. | 37 // domain into |result|. Returns true iff successful. |
37 virtual bool Duplicate(int* result, int fd) = 0; | 38 virtual bool Duplicate(int* result, int fd) = 0; |
38 // Destructively move |src| to |dest|, overwriting |dest|. Returns true iff | 39 // Destructively move |src| to |dest|, overwriting |dest|. Returns true iff |
39 // successful. | 40 // successful. |
40 virtual bool Move(int src, int dest) = 0; | 41 virtual bool Move(int src, int dest) = 0; |
41 // Delete an element of the domain. | 42 // Delete an element of the domain. |
42 virtual void Close(int fd) = 0; | 43 virtual void Close(int fd) = 0; |
43 | 44 |
44 protected: | 45 protected: |
45 virtual ~InjectionDelegate() {} | 46 virtual ~InjectionDelegate() {} |
46 }; | 47 }; |
47 | 48 |
48 // An implementation of the InjectionDelegate interface using the file | 49 // An implementation of the InjectionDelegate interface using the file |
49 // descriptor table of the current process as the domain. | 50 // descriptor table of the current process as the domain. |
50 class FileDescriptorTableInjection : public InjectionDelegate { | 51 class FileDescriptorTableInjection : public InjectionDelegate { |
51 virtual bool Duplicate(int* result, int fd); | 52 virtual bool Duplicate(int* result, int fd) OVERRIDE; |
52 virtual bool Move(int src, int dest); | 53 virtual bool Move(int src, int dest) OVERRIDE; |
53 virtual void Close(int fd); | 54 virtual void Close(int fd) OVERRIDE; |
54 }; | 55 }; |
55 | 56 |
56 // A single arc of the directed graph which describes an injective multimapping. | 57 // A single arc of the directed graph which describes an injective multimapping. |
57 struct InjectionArc { | 58 struct InjectionArc { |
58 InjectionArc(int in_source, int in_dest, bool in_close) | 59 InjectionArc(int in_source, int in_dest, bool in_close) |
59 : source(in_source), | 60 : source(in_source), |
60 dest(in_dest), | 61 dest(in_dest), |
61 close(in_close) { | 62 close(in_close) { |
62 } | 63 } |
63 | 64 |
(...skipping 14 matching lines...) Expand all Loading... |
78 | 79 |
79 // This function will not call malloc but will mutate |map| | 80 // This function will not call malloc but will mutate |map| |
80 static inline bool ShuffleFileDescriptors(InjectiveMultimap* map) { | 81 static inline bool ShuffleFileDescriptors(InjectiveMultimap* map) { |
81 FileDescriptorTableInjection delegate; | 82 FileDescriptorTableInjection delegate; |
82 return PerformInjectiveMultimapDestructive(map, &delegate); | 83 return PerformInjectiveMultimapDestructive(map, &delegate); |
83 } | 84 } |
84 | 85 |
85 } // namespace base | 86 } // namespace base |
86 | 87 |
87 #endif // BASE_FILE_DESCRIPTOR_SHUFFLE_H_ | 88 #endif // BASE_FILE_DESCRIPTOR_SHUFFLE_H_ |
OLD | NEW |