e0abd7fd89bccf924f1016e2062210edd53bcc87
[WebKit-https.git] / Source / WebKit2 / Shared / ShareableResource.h
1 /*
2  * Copyright (C) 2012 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef ShareableResource_h
27 #define ShareableResource_h
28
29 #if ENABLE(SHAREABLE_RESOURCE)
30
31 #include "SharedMemory.h"
32
33 #include <wtf/PassRefPtr.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/RefPtr.h>
36 #include <wtf/RetainPtr.h>
37
38
39 namespace WebCore {
40 class SharedBuffer;
41 }
42
43 namespace WebKit {
44     
45 class ShareableResource : public RefCounted<ShareableResource> {
46 public:
47
48     class Handle {
49         WTF_MAKE_NONCOPYABLE(Handle);
50     public:
51         Handle();
52
53         bool isNull() const { return m_handle.isNull(); }
54         unsigned size() const { return m_size; }
55
56         void encode(IPC::ArgumentEncoder&) const;
57         static bool decode(IPC::ArgumentDecoder&, Handle&);
58
59         PassRefPtr<WebCore::SharedBuffer> tryWrapInSharedBuffer() const;
60
61     private:
62         friend class ShareableResource;
63
64         mutable SharedMemory::Handle m_handle;
65         unsigned m_offset;
66         unsigned m_size;
67     };
68
69     // Create a shareable resource that uses malloced memory.
70     static Ref<ShareableResource> create(PassRefPtr<SharedMemory>, unsigned offset, unsigned size);
71
72     // Create a shareable resource from a handle.
73     static PassRefPtr<ShareableResource> map(const Handle&);
74
75     // Create a handle.
76     bool createHandle(Handle&);
77
78     ~ShareableResource();
79
80     const char* data() const;
81     unsigned size() const;
82     
83 private:
84     ShareableResource(PassRefPtr<SharedMemory>, unsigned offset, unsigned size);
85     PassRefPtr<WebCore::SharedBuffer> wrapInSharedBuffer();
86
87     RefPtr<SharedMemory> m_sharedMemory;
88
89     unsigned m_offset;
90     unsigned m_size;    
91 };
92
93 } // namespace WebKit
94
95 #endif // ENABLE(SHAREABLE_RESOURCE)
96
97 #endif // ShareableResource_h