Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(128)

Side by Side Diff: mojo/edk/system/options_validation.h

Issue 1350023003: Add a Mojo EDK for Chrome that uses one OS pipe per message pipe. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: more cleanup Created 5 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 // Copyright 2014 The Chromium Authors. All rights reserved. 1 // Copyright 2014 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 // Functions to help with verifying various |Mojo...Options| structs from the 5 // Functions to help with verifying various |Mojo...Options| structs from the
6 // (public, C) API. These are "extensible" structs, which all have |struct_size| 6 // (public, C) API. These are "extensible" structs, which all have |struct_size|
7 // as their first member. All fields (other than |struct_size|) are optional, 7 // as their first member. All fields (other than |struct_size|) are optional,
8 // but any |flags| specified must be known to the system (otherwise, an error of 8 // but any |flags| specified must be known to the system (otherwise, an error of
9 // |MOJO_RESULT_UNIMPLEMENTED| should be returned). 9 // |MOJO_RESULT_UNIMPLEMENTED| should be returned).
10 10
11 #ifndef THIRD_PARTY_MOJO_SRC_MOJO_EDK_SYSTEM_OPTIONS_VALIDATION_H_ 11 #ifndef MOJO_EDK_SYSTEM_OPTIONS_VALIDATION_H_
12 #define THIRD_PARTY_MOJO_SRC_MOJO_EDK_SYSTEM_OPTIONS_VALIDATION_H_ 12 #define MOJO_EDK_SYSTEM_OPTIONS_VALIDATION_H_
13 13
14 #include <stddef.h> 14 #include <stddef.h>
15 #include <stdint.h> 15 #include <stdint.h>
16 16
17 #include <algorithm> 17 #include <algorithm>
18 18
19 #include "base/logging.h" 19 #include "base/logging.h"
20 #include "mojo/edk/system/system_impl_export.h"
20 #include "mojo/public/c/system/types.h" 21 #include "mojo/public/c/system/types.h"
21 #include "mojo/public/cpp/system/macros.h" 22 #include "mojo/public/cpp/system/macros.h"
22 #include "third_party/mojo/src/mojo/edk/system/memory.h"
23 #include "third_party/mojo/src/mojo/edk/system/system_impl_export.h"
24 23
25 namespace mojo { 24 namespace mojo {
26 namespace system { 25 namespace edk {
27 26
28 template <class Options> 27 template <class Options>
29 class UserOptionsReader { 28 class UserOptionsReader {
30 public: 29 public:
31 // Constructor from a |UserPointer<const Options>| (which it checks -- this 30 // Constructor from a |const* Options| (which it checks -- this constructor
32 // constructor has side effects!). 31 // has side effects!).
33 // Note: We initialize |options_reader_| without checking, since we do a check 32 // Note: We initialize |options_reader_| without checking, since we do a check
34 // in |GetSizeForReader()|. 33 // in |GetSizeForReader()|.
35 explicit UserOptionsReader(UserPointer<const Options> options) 34 explicit UserOptionsReader(const Options* options) {
36 : options_reader_(UserPointer<const char>::Reader::NoCheck(), 35 CHECK(options && IsAligned<MOJO_ALIGNOF(Options)>(options));
37 options.template ReinterpretCast<const char>(), 36 options_ = GetSizeForReader(options) == 0 ? nullptr : options;
38 GetSizeForReader(options)) {
39 static_assert(offsetof(Options, struct_size) == 0, 37 static_assert(offsetof(Options, struct_size) == 0,
40 "struct_size not first member of Options"); 38 "struct_size not first member of Options");
41 // TODO(vtl): Enable when MSVC supports this (C++11 extended sizeof): 39 // TODO(vtl): Enable when MSVC supports this (C++11 extended sizeof):
42 // static_assert(sizeof(Options::struct_size) == sizeof(uint32_t), 40 // static_assert(sizeof(Options::struct_size) == sizeof(uint32_t),
43 // "Options::struct_size not a uint32_t"); 41 // "Options::struct_size not a uint32_t");
44 // (Or maybe assert that its type is uint32_t?) 42 // (Or maybe assert that its type is uint32_t?)
45 } 43 }
46 44
47 bool is_valid() const { return !!options_reader_.GetPointer(); } 45 bool is_valid() const { return !!options_; }
48 46
49 const Options& options() const { 47 const Options& options() const {
50 DCHECK(is_valid()); 48 DCHECK(is_valid());
51 return *reinterpret_cast<const Options*>(options_reader_.GetPointer()); 49 return *options_;
52 } 50 }
53 51
54 // Checks that the given (variable-size) |options| passed to the constructor 52 // Checks that the given (variable-size) |options| passed to the constructor
55 // (plausibly) has a member at the given offset with the given size. You 53 // (plausibly) has a member at the given offset with the given size. You
56 // probably want to use |OPTIONS_STRUCT_HAS_MEMBER()| instead. 54 // probably want to use |OPTIONS_STRUCT_HAS_MEMBER()| instead.
57 bool HasMember(size_t offset, size_t size) const { 55 bool HasMember(size_t offset, size_t size) const {
58 DCHECK(is_valid()); 56 DCHECK(is_valid());
59 // We assume that |offset| and |size| are reasonable, since they should come 57 // We assume that |offset| and |size| are reasonable, since they should come
60 // from |offsetof(Options, some_member)| and |sizeof(Options::some_member)|, 58 // from |offsetof(Options, some_member)| and |sizeof(Options::some_member)|,
61 // respectively. 59 // respectively.
62 return options().struct_size >= offset + size; 60 return options().struct_size >= offset + size;
63 } 61 }
64 62
65 private: 63 private:
66 static inline size_t GetSizeForReader(UserPointer<const Options> options) { 64 static inline size_t GetSizeForReader(const Options* options) {
67 uint32_t struct_size = 65 uint32_t struct_size = *reinterpret_cast<const uint32_t*>(options);
68 options.template ReinterpretCast<const uint32_t>().Get();
69 if (struct_size < sizeof(uint32_t)) 66 if (struct_size < sizeof(uint32_t))
70 return 0; 67 return 0;
71 68
72 // Check the full requested size.
73 // Note: Use |MOJO_ALIGNOF()| here to match the exact macro used in the
74 // declaration of Options structs.
75 internal::CheckUserPointerWithSize<MOJO_ALIGNOF(Options)>(options.pointer_,
76 struct_size);
77 options.template ReinterpretCast<const char>().CheckArray(struct_size);
78 // But we'll never look at more than |sizeof(Options)| bytes.
79 return std::min(static_cast<size_t>(struct_size), sizeof(Options)); 69 return std::min(static_cast<size_t>(struct_size), sizeof(Options));
80 } 70 }
81 71
82 UserPointer<const char>::Reader options_reader_; 72 template <size_t alignment>
73 static bool IsAligned(const void* pointer) {
74 return reinterpret_cast<uintptr_t>(pointer) % alignment == 0;
75 }
76
77 const Options* options_;
83 78
84 MOJO_DISALLOW_COPY_AND_ASSIGN(UserOptionsReader); 79 MOJO_DISALLOW_COPY_AND_ASSIGN(UserOptionsReader);
85 }; 80 };
86 81
87 // Macro to invoke |UserOptionsReader<Options>::HasMember()| parametrized by 82 // Macro to invoke |UserOptionsReader<Options>::HasMember()| parametrized by
88 // member name instead of offset and size. 83 // member name instead of offset and size.
89 // 84 //
90 // (We can't just give |HasMember()| a member pointer template argument instead, 85 // (We can't just give |HasMember()| a member pointer template argument instead,
91 // since there's no good/strictly-correct way to get an offset from that.) 86 // since there's no good/strictly-correct way to get an offset from that.)
92 // 87 //
93 // TODO(vtl): With C++11, use |sizeof(Options::member)| instead of (the 88 // TODO(vtl): With C++11, use |sizeof(Options::member)| instead of (the
94 // contortion below). We might also be able to pull out the type |Options| from 89 // contortion below). We might also be able to pull out the type |Options| from
95 // |reader| (using |decltype|) instead of requiring a parameter. 90 // |reader| (using |decltype|) instead of requiring a parameter.
96 #define OPTIONS_STRUCT_HAS_MEMBER(Options, member, reader) \ 91 #define OPTIONS_STRUCT_HAS_MEMBER(Options, member, reader) \
97 reader.HasMember(offsetof(Options, member), sizeof(reader.options().member)) 92 reader.HasMember(offsetof(Options, member), sizeof(reader.options().member))
98 93
99 } // namespace system 94 } // namespace edk
100 } // namespace mojo 95 } // namespace mojo
101 96
102 #endif // THIRD_PARTY_MOJO_SRC_MOJO_EDK_SYSTEM_OPTIONS_VALIDATION_H_ 97 #endif // MOJO_EDK_SYSTEM_OPTIONS_VALIDATION_H_
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698