cc/gapir/context.h

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef GAPIR_CONTEXT_H
#define GAPIR_CONTEXT_H

#include <gapic/target.h>
#include <gapic/timer.h>

#include <memory>
#include <string>
#include <unordered_map>

namespace gapir {

class Interpreter;
class MemoryManager;
class PostBuffer;
class Renderer;
class ReplayRequest;
class ResourceInMemoryCache;
class ResourceProvider;
class ServerConnection;
class Stack;

// Context object for the replay containing the Gl context, the memory manager and the replay
// specific functions to handle network communication of the interpreter
class Context {
public:
    // Creates a new Context object and initialize it with loading the replay request, setting up
    // the memory manager, setting up the caches and prefetching the resources
    static std::unique_ptr<Context> create(const ServerConnection& gazer,
                                           ResourceProvider* resourceProvider,
                                           MemoryManager* memoryManager);

    ~Context();

    void prefetch(ResourceInMemoryCache* cache) const;

    // Run the interpreter over the opcode stream of the replay request and returns true if the
    // interpretation was successful false otherwise
    bool interpret();

private:
    enum {
        MAX_TIMERS       = 256,
        POST_BUFFER_SIZE = 2*1024*1024,
    };

    Context(const ServerConnection& gazer, ResourceProvider* resourceProvider,
            MemoryManager* memoryManager);

    // Initialize the context object with loading the replay request, setting up the memory manager,
    // setting up the caches and prefetching the resources
    bool initialize();

    // Register the callbacks for the interpreter (Gl functions, load resource, post resource)
    void registerCallbacks(Interpreter* interpreter);

    // Post a chunk of data where the number of bytes is on the top of the stack (uint32_t) and the
    // address for the data is the second element on the stack (void*)
    bool postData(Stack* stack);

    // Load a resource from the resource provider where the index of the resource is at the top of
    // the stack (uint32_t) and the target address is at the second element of the stack (void*)
    bool loadResource(Stack* stack);

    // Starts the timer identified by u8 index.
    bool startTimer(Stack* stack);

    // Stops the timer identified by u8 index and returns u64 elapsed nanoseconds since its start.
    bool stopTimer(Stack* stack, bool pushReturn);

    // Flushes any pending post data buffered from calling postData.
    bool flushPostBuffer(Stack *stack);

    // Server connection object to fetch and post resources back to the server
    const ServerConnection& mServer;

    // Resource provider (possibly with caching) to fetch the resources required by the replay. It
    // is owned by the creator of the Context object.
    ResourceProvider* mResourceProvider;

    // Memory manager to manage the memory used by the replay and by the interpreter. Is is owned by
    // the creator of the Context object.
    MemoryManager* mMemoryManager;

    // The data of the request for this context belongs to
    std::unique_ptr<ReplayRequest> mReplayRequest;

    // An array of timers.
    gapic::Timer mTimers[MAX_TIMERS];

    // The constructed renderers.
    std::unordered_map<uint32_t, Renderer*> mRenderers;

    // The currently bound renderer.
    Renderer* mBoundRenderer;

    // A buffer for data to be sent back to the server.
    std::unique_ptr<PostBuffer> mPostBuffer;
};

}  // namespace gapir

#endif  // GAPIR_CONTEXT_H