1 /*
2  * Copyright (c) 2011-2018, 2020 The Linux Foundation. All rights reserved.
3  * Not a Contribution
4  *
5  * Copyright (C) 2008 The Android Open Source Project
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19 
20 #ifndef __GR_BUF_MGR_H__
21 #define __GR_BUF_MGR_H__
22 
23 #include <pthread.h>
24 
25 #include <mutex>
26 #include <unordered_map>
27 #include <unordered_set>
28 #include <utility>
29 #include <vector>
30 
31 #include "gr_allocator.h"
32 #include "gr_buf_descriptor.h"
33 #include "gr_adreno_info.h"
34 #include "gr_utils.h"
35 #include "gralloc_priv.h"
36 
37 namespace gralloc {
38 using gralloc::Error;
39 class BufferManager {
40  public:
41   ~BufferManager();
42 
43   Error AllocateBuffer(const BufferDescriptor &descriptor, buffer_handle_t *handle,
44                        unsigned int bufferSize = 0, bool testAlloc = false);
45   Error RetainBuffer(private_handle_t const *hnd);
46   Error ReleaseBuffer(private_handle_t const *hnd);
47   Error LockBuffer(const private_handle_t *hnd, uint64_t usage);
48   Error UnlockBuffer(const private_handle_t *hnd);
49   Error Dump(std::ostringstream *os);
50   Error ValidateBufferSize(private_handle_t const *hnd, BufferInfo info);
51   Error IsBufferImported(const private_handle_t *hnd);
52   static BufferManager *GetInstance();
53   Error GetMetadata(private_handle_t *handle, int64_t metadatatype_value, hidl_vec<uint8_t> *out);
54   Error SetMetadata(private_handle_t *handle, int64_t metadatatype_value, hidl_vec<uint8_t> in);
55   Error GetReservedRegion(private_handle_t *handle, void **reserved_region,
56                           uint64_t *reserved_region_size);
57   Error FlushBuffer(const private_handle_t *handle);
58   Error RereadBuffer(const private_handle_t *handle);
59   Error GetAllHandles(std::vector<const private_handle_t *> *out_handle_list);
60   void SetGrallocDebugProperties(gralloc::GrallocProperties props);
61 
62  private:
63   BufferManager();
64   Error MapBuffer(private_handle_t const *hnd);
65 
66   // Imports the ion fds into the current process. Returns an error for invalid handles
67   Error ImportHandleLocked(private_handle_t *hnd);
68 
69   // Creates a Buffer from the valid private handle and adds it to the map
70   void RegisterHandleLocked(const private_handle_t *hnd, int ion_handle, int ion_handle_meta);
71 
72   // Wrapper structure over private handle
73   // Values associated with the private handle
74   // that do not need to go over IPC can be placed here
75   // This structure is also not expected to be ABI stable
76   // unlike private_handle_t
77   struct Buffer {
78     const private_handle_t *handle = nullptr;
79     int ref_count = 1;
80     // Hold the main and metadata ion handles
81     // Freed from the allocator process
82     // and unused in the mapping process
83     int ion_handle_main = -1;
84     int ion_handle_meta = -1;
85 
86     Buffer() = delete;
87     explicit Buffer(const private_handle_t *h, int ih_main = -1, int ih_meta = -1)
88         : handle(h), ion_handle_main(ih_main), ion_handle_meta(ih_meta) {}
IncRefBuffer89     void IncRef() { ++ref_count; }
DecRefBuffer90     bool DecRef() { return --ref_count == 0; }
91     uint64_t reserved_size = 0;
92     void *reserved_region_ptr = nullptr;
93   };
94 
95   Error FreeBuffer(std::shared_ptr<Buffer> buf);
96 
97   // Get the wrapper Buffer object from the handle, returns nullptr if handle is not found
98   std::shared_ptr<Buffer> GetBufferFromHandleLocked(const private_handle_t *hnd);
99   Allocator *allocator_ = NULL;
100   std::mutex buffer_lock_;
101   std::unordered_map<const private_handle_t *, std::shared_ptr<Buffer>> handles_map_ = {};
102   std::atomic<uint64_t> next_id_;
103 };
104 
105 }  // namespace gralloc
106 
107 #endif  // __GR_BUF_MGR_H__
108