rsAllocation.h revision 7d9c5ffccb7a5e682860f752403e5a03aed587be 
1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_STRUCTURED_ALLOCATION_H
18#define ANDROID_STRUCTURED_ALLOCATION_H
19
20#include "rsType.h"
21
22// ---------------------------------------------------------------------------
23namespace android {
24namespace renderscript {
25
26class Program;
27
28class Allocation : public ObjectBase {
29    // The graphics equilivent of malloc.  The allocation contains a structure of elements.
30
31public:
32    struct Hal {
33        void * drv;
34
35        struct State {
36            ObjectBaseRef<const Type> type;
37            void * mallocPtr;
38
39            uint32_t usageFlags;
40            RsAllocationMipmapControl mipmapControl;
41
42            // Cached fields from the Type and Element
43            // to prevent pointer chasing in critical loops.
44            uint32_t dimensionX;
45            uint32_t dimensionY;
46            uint32_t dimensionZ;
47            uint32_t elementSizeBytes;
48            bool hasMipmaps;
49            bool hasFaces;
50            bool hasReferences;
51        };
52        State state;
53    };
54    Hal mHal;
55
56    Allocation(Context *rsc, const Type *, uint32_t usages,
57               RsAllocationMipmapControl mc = RS_ALLOCATION_MIPMAP_NONE);
58
59    virtual ~Allocation();
60    void updateCache();
61
62    void setCpuWritable(bool);
63    void setGpuWritable(bool);
64    void setCpuReadable(bool);
65    void setGpuReadable(bool);
66
67    bool fixAllocation();
68
69    void * getPtr() const {return mHal.state.mallocPtr;}
70    const Type * getType() const {return mHal.state.type.get();}
71
72    void syncAll(Context *rsc, RsAllocationUsageType src);
73
74    void deferredUploadToTexture(const Context *rsc);
75    void uploadToTexture(const Context *rsc);
76    uint32_t getTextureID() const {return mTextureID;}
77
78    void deferredAllocateRenderTarget(const Context *rsc);
79    void allocateRenderTarget(const Context *rsc);
80    uint32_t getRenderTargetID() const {return mRenderTargetID;}
81
82    uint32_t getGLTarget() const;
83
84    void deferredUploadToBufferObject(const Context *rsc);
85    void uploadToBufferObject(const Context *rsc);
86    uint32_t getBufferObjectID() const {return mBufferID;}
87
88    void copyRange1D(Context *rsc, const Allocation *src, int32_t srcOff, int32_t destOff, int32_t len);
89
90    void resize1D(Context *rsc, uint32_t dimX);
91    void resize2D(Context *rsc, uint32_t dimX, uint32_t dimY);
92
93    void data(Context *rsc, uint32_t xoff, uint32_t lod, uint32_t count, const void *data, uint32_t sizeBytes);
94    void data(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t lod, RsAllocationCubemapFace face,
95                 uint32_t w, uint32_t h, const void *data, uint32_t sizeBytes);
96    void data(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t zoff, uint32_t lod, RsAllocationCubemapFace face,
97                 uint32_t w, uint32_t h, uint32_t d, const void *data, uint32_t sizeBytes);
98
99    void elementData(Context *rsc, uint32_t x,
100                        const void *data, uint32_t elementOff, uint32_t sizeBytes);
101    void elementData(Context *rsc, uint32_t x, uint32_t y,
102                        const void *data, uint32_t elementOff, uint32_t sizeBytes);
103
104    void read(void *data);
105
106    void enableGLVertexBuffers() const;
107    void setupGLIndexBuffers() const;
108
109    void addProgramToDirty(const Program *);
110    void removeProgramToDirty(const Program *);
111
112    virtual void dumpLOGV(const char *prefix) const;
113    virtual void serialize(OStream *stream) const;
114    virtual RsA3DClassID getClassId() const { return RS_A3D_CLASS_ID_ALLOCATION; }
115    static Allocation *createFromStream(Context *rsc, IStream *stream);
116
117    virtual void uploadCheck(Context *rsc);
118
119    bool getIsScript() const {
120        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_SCRIPT) != 0;
121    }
122    bool getIsTexture() const {
123        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_TEXTURE) != 0;
124    }
125    bool getIsRenderTarget() const {
126        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_RENDER_TARGET) != 0;
127    }
128    bool getIsBufferObject() const {
129        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_VERTEX) != 0;
130    }
131
132    void incRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
133    void decRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
134
135    void sendDirty() const;
136    bool getHasGraphicsMipmaps() const {
137        return mHal.state.mipmapControl != RS_ALLOCATION_MIPMAP_NONE;
138    }
139
140
141protected:
142    Vector<const Program *> mToDirtyList;
143
144    // Is we have a non-null user bitmap callback we do not own the bits and
145    // instead call this function to free the memort when its time.
146    RsBitmapCallback_t mUserBitmapCallback;
147    void *mUserBitmapCallbackData;
148
149    // Usage restrictions
150    bool mCpuWrite;
151    bool mCpuRead;
152    bool mGpuWrite;
153    bool mGpuRead;
154
155    // more usage hint data from the application
156    // which can be used by a driver to pick the best memory type.
157    // Likely ignored for now
158    float mReadWriteRatio;
159    float mUpdateSize;
160
161
162    // Is this a legal structure to be used as a texture source.
163    // Initially this will require 1D or 2D and color data
164    uint32_t mTextureID;
165
166    // Is this a legal structure to be used as a vertex source.
167    // Initially this will require 1D and x(yzw).  Additional per element data
168    // is allowed.
169    uint32_t mBufferID;
170
171    // Is this a legal structure to be used as an FBO render target
172    uint32_t mRenderTargetID;
173
174    bool mUploadDeferred;
175
176private:
177    void init(Context *rsc, const Type *);
178    void upload2DTexture(bool isFirstUpload);
179    void update2DTexture(const void *ptr, uint32_t xoff, uint32_t yoff,
180                         uint32_t lod, RsAllocationCubemapFace face, uint32_t w, uint32_t h);
181
182    void allocScriptMemory();
183    void freeScriptMemory();
184
185};
186
187}
188}
189#endif
190
191