1/*
2 * Copyright (C) 2009-2012 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
22struct ANativeWindow;
23
24// ---------------------------------------------------------------------------
25namespace android {
26
27namespace renderscript {
28
29/*****************************************************************************
30 * CAUTION
31 *
32 * Any layout changes for this class may require a corresponding change to be
33 * made to frameworks/compile/libbcc/lib/ScriptCRT/rs_core.c, which contains
34 * a partial copy of the information below.
35 *
36 *****************************************************************************/
37class Allocation : public ObjectBase {
38    // The graphics equivalent of malloc.  The allocation contains a structure of elements.
39
40public:
41    const static int MAX_LOD = 16;
42
43    struct Hal {
44        void * drv;
45
46        struct State {
47            const Type * type;
48
49            uint32_t usageFlags;
50            RsAllocationMipmapControl mipmapControl;
51
52            // Cached fields from the Type and Element
53            // to prevent pointer chasing in critical loops.
54            uint32_t dimensionX;
55            uint32_t dimensionY;
56            uint32_t dimensionZ;
57            uint32_t elementSizeBytes;
58            bool hasMipmaps;
59            bool hasFaces;
60            bool hasReferences;
61            void * unused_01;
62            int32_t surfaceTextureID;
63            void *wndSurface;
64            void *surfaceTexture;
65            RsDataType eType;
66        };
67        State state;
68
69        struct DrvState {
70            mutable void * mallocPtrLOD0;
71            mutable uint32_t strideLOD0;
72        } drvState;
73
74    };
75    Hal mHal;
76
77    static Allocation * createAllocation(Context *rsc, const Type *, uint32_t usages,
78                                         RsAllocationMipmapControl mc = RS_ALLOCATION_MIPMAP_NONE,
79                                         void *ptr = 0);
80    virtual ~Allocation();
81    void updateCache();
82
83    const Type * getType() const {return mHal.state.type;}
84
85    void syncAll(Context *rsc, RsAllocationUsageType src);
86
87    void copyRange1D(Context *rsc, const Allocation *src, int32_t srcOff, int32_t destOff, int32_t len);
88
89    void resize1D(Context *rsc, uint32_t dimX);
90    void resize2D(Context *rsc, uint32_t dimX, uint32_t dimY);
91
92    void data(Context *rsc, uint32_t xoff, uint32_t lod, uint32_t count, const void *data, size_t sizeBytes);
93    void data(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t lod, RsAllocationCubemapFace face,
94                 uint32_t w, uint32_t h, const void *data, size_t sizeBytes);
95    void data(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t zoff, uint32_t lod, RsAllocationCubemapFace face,
96                 uint32_t w, uint32_t h, uint32_t d, const void *data, size_t sizeBytes);
97
98    void read(Context *rsc, uint32_t xoff, uint32_t lod, uint32_t count, void *data, size_t sizeBytes);
99    void read(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t lod, RsAllocationCubemapFace face,
100                 uint32_t w, uint32_t h, void *data, size_t sizeBytes);
101    void read(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t zoff, uint32_t lod, RsAllocationCubemapFace face,
102                 uint32_t w, uint32_t h, uint32_t d, void *data, size_t sizeBytes);
103
104    void elementData(Context *rsc, uint32_t x,
105                     const void *data, uint32_t elementOff, size_t sizeBytes);
106    void elementData(Context *rsc, uint32_t x, uint32_t y,
107                     const void *data, uint32_t elementOff, size_t sizeBytes);
108
109    void addProgramToDirty(const Program *);
110    void removeProgramToDirty(const Program *);
111
112    virtual void dumpLOGV(const char *prefix) const;
113    virtual void serialize(Context *rsc, OStream *stream) const;
114    virtual RsA3DClassID getClassId() const { return RS_A3D_CLASS_ID_ALLOCATION; }
115    static Allocation *createFromStream(Context *rsc, IStream *stream);
116
117    bool getIsScript() const {
118        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_SCRIPT) != 0;
119    }
120    bool getIsTexture() const {
121        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_TEXTURE) != 0;
122    }
123    bool getIsRenderTarget() const {
124        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_RENDER_TARGET) != 0;
125    }
126    bool getIsBufferObject() const {
127        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_VERTEX) != 0;
128    }
129
130    void incRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
131    void decRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
132    virtual bool freeChildren();
133
134    void sendDirty(const Context *rsc) const;
135    bool getHasGraphicsMipmaps() const {
136        return mHal.state.mipmapControl != RS_ALLOCATION_MIPMAP_NONE;
137    }
138
139protected:
140    Vector<const Program *> mToDirtyList;
141    ObjectBaseRef<const Type> mType;
142    void setType(const Type *t) {
143        mType.set(t);
144        mHal.state.type = t;
145    }
146
147private:
148    void freeChildrenUnlocked();
149    Allocation(Context *rsc, const Type *, uint32_t usages, RsAllocationMipmapControl mc, void *ptr);
150
151    uint32_t getPackedSize() const;
152    static void writePackedData(Context *rsc, const Type *type, uint8_t *dst,
153                                const uint8_t *src, bool dstPadded);
154    void unpackVec3Allocation(Context *rsc, const void *data, size_t dataSize);
155    void packVec3Allocation(Context *rsc, OStream *stream) const;
156};
157
158}
159}
160#endif
161
162