Change tbm debug level
[platform/core/uifw/libtbm.git] / src / tbm_bufmgr_int.h
1 /**************************************************************************
2
3 libtbm
4
5 Copyright 2012 Samsung Electronics co., Ltd. All Rights Reserved.
6
7 Contact: SooChan Lim <sc1.lim@samsung.com>, Sangjin Lee <lsj119@samsung.com>
8 Boram Park <boram1288.park@samsung.com>, Changyeon Lee <cyeon.lee@samsung.com>
9
10 Permission is hereby granted, free of charge, to any person obtaining a
11 copy of this software and associated documentation files (the
12 "Software"), to deal in the Software without restriction, including
13 without limitation the rights to use, copy, modify, merge, publish,
14 distribute, sub license, and/or sell copies of the Software, and to
15 permit persons to whom the Software is furnished to do so, subject to
16 the following conditions:
17
18 The above copyright notice and this permission notice (including the
19 next paragraph) shall be included in all copies or substantial portions
20 of the Software.
21
22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
25 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
27 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
28 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29
30 **************************************************************************/
31
32 #ifndef _TBM_BUFMGR_INT_H_
33 #define _TBM_BUFMGR_INT_H_
34
35 #include <unistd.h>
36 #include <limits.h>
37 #include <stdlib.h>
38 #include <stdio.h>
39 #include <sys/ioctl.h>
40 #include <sys/types.h>
41 #include <sys/stat.h>
42 #include <fcntl.h>
43 #include <dlfcn.h>
44 #include <dirent.h>
45 #include <string.h>
46 #include <errno.h>
47 #include <pthread.h>
48 #include <tbm_bufmgr.h>
49 #include <tbm_surface.h>
50 #include <tbm_surface_internal.h>
51 #include <tbm_bufmgr_backend.h>
52 #include <tbm_surface_queue.h>
53
54 #define DEBUG
55 #ifdef DEBUG
56 extern int bDebug;
57
58 #define DBG(...) { if (bDebug&0x1) TBM_LOG_D(__VA_ARGS__); }
59 #define DBG_LOCK(...) { if (bDebug&0x2) TBM_LOG_D(__VA_ARGS__); }
60 #else
61 #define DBG(...)
62 #define DBG_LOCK(...)
63 #endif /* DEBUG */
64
65 #ifdef HAVE_DLOG
66 #include <dlog.h>
67
68 extern int bDlog;
69
70 #ifdef LOG_TAG
71 #undef LOG_TAG
72 #endif
73
74 #define LOG_TAG "TBM"
75
76 #define TBM_LOG_D(fmt, ...) {\
77         if (bDlog) {\
78                 LOGD("[TBM:D] " fmt, ##__VA_ARGS__);\
79         } \
80         else {\
81                 fprintf(stderr, "[TBM:D(%d)(%s:%d)] " fmt, getpid(), __func__, __LINE__, ##__VA_ARGS__);\
82         } \
83 }
84
85 #define TBM_LOG_I(fmt, ...) {\
86         if (bDlog) {\
87                 LOGD("[TBM:I] " fmt, ##__VA_ARGS__);\
88         } \
89         else {\
90                 fprintf(stderr, "[TBM:I(%d)(%s:%d)] " fmt, getpid(), __func__, __LINE__, ##__VA_ARGS__);\
91         } \
92 }
93
94 #define TBM_LOG_W(fmt, ...) {\
95         if (bDlog) {\
96                 LOGW("[TBM:W] " fmt, ##__VA_ARGS__);\
97         } \
98         else {\
99                 fprintf(stderr, "[TBM:W(%d)(%s:%d)] " fmt, getpid(), __func__, __LINE__, ##__VA_ARGS__);\
100         } \
101 }
102
103 #define TBM_LOG_E(fmt, ...) {\
104         if (bDlog) {\
105                 LOGE("[TBM:E] " fmt, ##__VA_ARGS__);\
106         } \
107         else {\
108                 fprintf(stderr, "[TBM:E(%d)(%s:%d)] " fmt, getpid(), __func__, __LINE__, ##__VA_ARGS__);\
109         } \
110 }
111
112 #define TBM_DEBUG(fmt, ...) {\
113         if (bDlog) {\
114                 LOGE("[TBM_DEBUG] " fmt, ##__VA_ARGS__);\
115         } \
116         else {\
117                 fprintf(stderr, "[TBM:DEBUG(%d)] " fmt, getpid(), ##__VA_ARGS__);\
118         } \
119 }
120 #else
121 #define TBM_LOG_D(fmt, ...)   fprintf(stderr, "[TBM:D(%d)(%s:%d)] " fmt, getpid(), __func__, __LINE__, ##__VA_ARGS__)
122 #define TBM_LOG_I(fmt, ...)   fprintf(stderr, "[TBM:I(%d)(%s:%d)] " fmt, getpid(), __func__, __LINE__, ##__VA_ARGS__)
123 #define TBM_LOG_W(fmt, ...)   fprintf(stderr, "[TBM:W(%d)(%s:%d)] " fmt, getpid(), __func__, __LINE__, ##__VA_ARGS__)
124 #define TBM_LOG_E(fmt, ...)   fprintf(stderr, "[TBM:E(%d)(%s:%d)] " fmt, getpid(), __func__, __LINE__, ##__VA_ARGS__)
125 #define TBM_DEBUG(fmt, ...)   fprintf(stderr, "[TBM:DEBUG(%d)] " fmt, getpid(), ##__VA_ARGS__)
126 #endif /* HAVE_DLOG */
127
128 /* check condition */
129 #define TBM_RETURN_IF_FAIL(cond) {\
130         if (!(cond)) {\
131                 TBM_LOG_E("'%s' failed.\n", #cond);\
132                 return;\
133         } \
134 }
135 #define TBM_RETURN_VAL_IF_FAIL(cond, val) {\
136         if (!(cond)) {\
137                 TBM_LOG_E("'%s' failed.\n", #cond);\
138                 return val;\
139         } \
140 }
141 #define TBM_GOTO_VAL_IF_FAIL(cond, val) {\
142         if (!(cond)) {\
143                 TBM_LOG_E("'%s' failed.\n", #cond);\
144                 goto val;\
145         } \
146 }
147
148 /* check flags */
149 #define RETURN_CHECK_FLAG(cond) {\
150         if ((cond)) {\
151                 return;\
152         } \
153 }
154 #define RETURN_VAL_CHECK_FLAG(cond, val) {\
155         if ((cond)) {\
156                 return val;\
157         } \
158 }
159
160 /* check validation */
161 #define TBM_BUFMGR_IS_VALID(mgr) (mgr)
162 #define TBM_BO_IS_VALID(bo) (bo && \
163                             TBM_BUFMGR_IS_VALID(bo->bufmgr) && \
164                             bo->item_link.next && \
165                             bo->item_link.next->prev == &bo->item_link)
166 #define TBM_SURFACE_IS_VALID(surf) (surf && \
167                                    TBM_BUFMGR_IS_VALID(surf->bufmgr) && \
168                                    surf->item_link.next && \
169                                    surf->item_link.next->prev == &surf->item_link)
170
171 struct list_head {
172         struct list_head *prev;
173         struct list_head *next;
174 };
175
176 /**
177  * @brief tbm_bo : buffer object of Tizen Buffer Manager
178  */
179 struct _tbm_bo {
180         tbm_bufmgr bufmgr;                      /* tbm buffer manager */
181
182         int ref_cnt;                            /* ref count of bo */
183
184         int flags;                                      /* TBM_BO_FLAGS :bo memory type */
185
186         struct list_head user_data_list;        /* list of the user_date in bo */
187
188         void *priv;                                     /* bo private */
189
190         struct list_head item_link;     /* link of bo */
191
192         tbm_surface_h surface; /* tbm_surface */
193
194         int lock_cnt;                           /* lock count of bo */
195
196         unsigned int map_cnt;           /* device map count */
197 };
198
199 /**
200  * @brief tbm_bufmgr : structure for tizen buffer manager
201  *
202  */
203 struct _tbm_bufmgr {
204         pthread_mutex_t lock;           /* mutex lock */
205
206         int ref_count;                          /*reference count */
207
208         int fd;                                         /* bufmgr fd */
209
210         int lock_type;                          /* lock_type of bufmgr */
211
212         struct list_head bo_list;       /* list of bos belonging to bufmgr */
213
214         struct list_head surf_list;     /* list of surfaces belonging to bufmgr */
215
216         void *module_data;
217
218         tbm_bufmgr_backend backend;     /* bufmgr backend */
219 };
220
221 /**
222  * @brief tbm_surface : structure for tizen buffer surface
223  *
224  */
225 struct _tbm_surface {
226         tbm_bufmgr bufmgr;                      /* tbm buffer manager */
227
228         tbm_surface_info_s info;        /* tbm surface information */
229
230         int flags;
231
232         int num_bos;                            /* the number of buffer objects */
233
234         tbm_bo bos[4];
235
236         int num_planes;                         /* the number of buffer objects */
237
238         int planes_bo_idx[TBM_SURF_PLANE_MAX];
239
240         int refcnt;
241
242         unsigned int debug_pid;
243
244         struct list_head item_link; /* link of surface */
245
246         struct list_head user_data_list;        /* list of the user_date in surface */
247 };
248
249 typedef struct {
250         unsigned long key;
251         void *data;
252         tbm_data_free free_func;
253
254         /* link of user_data */
255         struct list_head item_link;
256 } tbm_user_data;
257
258 int _tbm_bo_set_surface(tbm_bo bo, tbm_surface_h surface);
259 int _tbm_surface_is_valid(tbm_surface_h surface);
260
261 /* functions for mutex */
262 int tbm_surface_internal_get_info(tbm_surface_h surface, int opt,
263                                   tbm_surface_info_s *info, int map);
264 void tbm_surface_internal_unmap(tbm_surface_h surface);
265 unsigned int tbm_surface_internal_get_width(tbm_surface_h surface);
266 unsigned int tbm_surface_internal_get_height(tbm_surface_h surface);
267 tbm_format tbm_surface_internal_get_format(tbm_surface_h surface);
268 unsigned int _tbm_surface_internal_get_debug_pid(tbm_surface_h surface);
269 char *_tbm_surface_internal_format_to_str(tbm_format format);
270
271 tbm_user_data *user_data_lookup(struct list_head *user_data_list,
272                                 unsigned long key);
273 tbm_user_data *user_data_create(unsigned long key,
274                                 tbm_data_free data_free_func);
275 void user_data_delete(tbm_user_data *user_data);
276
277 #endif                                                  /* _TBM_BUFMGR_INT_H_ */