1 // Copyright 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef MOJO_PUBLIC_BINDINGS_LIB_BINDINGS_SERIALIZATION_H_
6 #define MOJO_PUBLIC_BINDINGS_LIB_BINDINGS_SERIALIZATION_H_
10 #include "mojo/public/bindings/buffer.h"
11 #include "mojo/public/bindings/message.h"
16 size_t Align(size_t size);
18 // Pointers are encoded as relative offsets. The offsets are relative to the
19 // address of where the offset value is stored, such that the pointer may be
20 // recovered with the expression:
22 // ptr = reinterpret_cast<char*>(offset) + *offset
24 // A null pointer is encoded as an offset value of 0.
26 void EncodePointer(const void* ptr, uint64_t* offset);
27 const void* DecodePointerRaw(const uint64_t* offset);
30 inline void DecodePointer(const uint64_t* offset, T** ptr) {
31 *ptr = reinterpret_cast<T*>(const_cast<void*>(DecodePointerRaw(offset)));
34 // Check that the given pointer references memory contained within the message.
35 bool ValidatePointer(const void* ptr, const Message& message);
37 // Handles are encoded as indices into a vector of handles. These functions
38 // manipulate the value of |handle|, mapping it to and from an index.
39 void EncodeHandle(Handle* handle, std::vector<Handle>* handles);
40 bool DecodeHandle(Handle* handle, std::vector<Handle>* handles);
42 // The following 2 functions are used to encode/decode all objects (structs and
43 // arrays) in a consistent manner.
46 inline void Encode(T* obj, std::vector<Handle>* handles) {
48 obj->ptr->EncodePointersAndHandles(handles);
49 EncodePointer(obj->ptr, &obj->offset);
53 inline bool Decode(T* obj, Message* message) {
54 DecodePointer(&obj->offset, &obj->ptr);
56 if (!ValidatePointer(obj->ptr, *message))
58 if (!obj->ptr->DecodePointersAndHandles(message))
64 } // namespace internal
67 #endif // MOJO_PUBLIC_BINDINGS_LIB_BINDINGS_SERIALIZATION_H_