enlightenment/efl
enlightenment
/
efl
8
7
Fork 15
Code Issues 12 Pull Requests 2 Projects Releases Wiki Activity
efl/src/lib/eina/eina_safety_checks.c

92 lines
2.5 KiB
C
Raw Normal View History

missing file, sorry. SVN revision: 42215
2009-09-03 17:56:16 -07:00
/* EINA - EFL data type library
* Copyright (C) 2008 Gustavo Sverzut Barbieri
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library;
* if not, see <http://www.gnu.org/licenses/>.
*/
* finish benchmark tutorial * move internal _init and _shutdown functions in the Global part of the code, as it is where they belong * fix minor documentation stuff SVN revision: 44730
2009-12-27 00:45:30 -08:00
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include "eina_private.h"
fix most compilation errors with vc++ (there are still a problem with eina_log and output of the log messages: STDERR_FILENO, STDOUT_FILENO and isatty()) fix some warnings and header files inclusion update vcproj files SVN revision: 47384
2010-03-22 23:41:17 -07:00
#include "eina_error.h"
#include "eina_log.h"
* finish benchmark tutorial * move internal _init and _shutdown functions in the Global part of the code, as it is where they belong * fix minor documentation stuff SVN revision: 44730
2009-12-27 00:45:30 -08:00
#include "eina_safety_checks.h"
eina: Rename EAPI macro to EINA_API in Eina library Summary: Patch from a series of patches to rename EAPI symbols to specific library DSOs. EAPI was designed to be able to pass `__attribute__ ((visibility ("default")))` for symbols with GCC, which would mean that even if -fvisibility=hidden was used when compiling the library, the needed symbols would get exported. MSVC __almost__ works like GCC (or mingw) in which you can declare everything as export and it will just work (slower, but it will work). But there's a caveat: global variables will not work the same way for MSVC, but works for mingw and GCC. For global variables (as opposed to functions), MSVC requires correct DSO visibility for MSVC: instead of declaring a symbol as export for everything, you need to declare it as import when importing from another DSO and export when defining it locally. With current EAPI definitions, we get the following example working in mingw and MSVC (observe it doesn't define any global variables as exported symbols). Example 1: dll1: ``` EAPI void foo(void); EAPI void bar() { foo(); } ``` dll2: ``` EAPI void foo() { printf ("foo\n"); } ``` This works fine with API defined as __declspec(dllexport) in both cases and for gcc defining as `__atttribute__((visibility("default")))` However, the following: Example 2: dll1: ``` EAPI extern int foo; EAPI void foobar(void); EAPI void bar() { foo = 5; foobar(); } ``` dll2: ``` EAPI int foo = 0; EAPI void foobar() { printf ("foo %d\n", foo); } ``` This will work on mingw but will not work for MSVC. And that's why EAPI is the only solution that worked for MSVC. Co-authored-by: João Paulo Taylor Ienczak Zanette <jpaulotiz@gmail.com> Co-authored-by: Ricardo Campos <ricardo.campos@expertise.dev> Co-authored-by: Lucas Cavalcante de Sousa <lucks.sousa@gmail.com> Reviewers: jptiz, lucas, woohyun, vtorri, raster Reviewed By: jptiz, lucas, vtorri Subscribers: ProhtMeyhet, cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D12188
2020-11-25 04:35:48 -08:00
EINA_API Eina_Error EINA_ERROR_SAFETY_FAILED = 0;
* finish benchmark tutorial * move internal _init and _shutdown functions in the Global part of the code, as it is where they belong * fix minor documentation stuff SVN revision: 44730
2009-12-27 00:45:30 -08:00
Eina safety: Add internal function to log errors The main reason is convenience for debugging when using GDB, this will give a simple breakpoint for all safety check failures. Also, this creates a more visible log domain (red).
2015-12-14 23:56:13 -08:00
static int EINA_SAFETY_LOG_DOMAIN = 0;
static int initcnt = 0;
* finish benchmark tutorial * move internal _init and _shutdown functions in the Global part of the code, as it is where they belong * fix minor documentation stuff SVN revision: 44730
2009-12-27 00:45:30 -08:00
/**
Eina safety: Add internal function to log errors The main reason is convenience for debugging when using GDB, this will give a simple breakpoint for all safety check failures. Also, this creates a more visible log domain (red).
2015-12-14 23:56:13 -08:00
* Log entry-point called every time an eina safety check fails.
* finish benchmark tutorial * move internal _init and _shutdown functions in the Global part of the code, as it is where they belong * fix minor documentation stuff SVN revision: 44730
2009-12-27 00:45:30 -08:00
*
Eina safety: Add internal function to log errors The main reason is convenience for debugging when using GDB, this will give a simple breakpoint for all safety check failures. Also, this creates a more visible log domain (red).
2015-12-14 23:56:13 -08:00
* One purpose of this dedicated function is to provide a convenient breakpoint
* for GDB debugging. Also, this gives it a dedicated log domain, rather than
* using the default one.
* finish benchmark tutorial * move internal _init and _shutdown functions in the Global part of the code, as it is where they belong * fix minor documentation stuff SVN revision: 44730
2009-12-27 00:45:30 -08:00
*
Eina safety: Add internal function to log errors The main reason is convenience for debugging when using GDB, this will give a simple breakpoint for all safety check failures. Also, this creates a more visible log domain (red).
2015-12-14 23:56:13 -08:00
* @since 1.17
* @internal
* finish benchmark tutorial * move internal _init and _shutdown functions in the Global part of the code, as it is where they belong * fix minor documentation stuff SVN revision: 44730
2009-12-27 00:45:30 -08:00
*/
Eina_Bool
eina_safety_checks_shutdown(void)
{
Eina safety: Add internal function to log errors The main reason is convenience for debugging when using GDB, this will give a simple breakpoint for all safety check failures. Also, this creates a more visible log domain (red).
2015-12-14 23:56:13 -08:00
if (!initcnt) return EINA_FALSE;
if (!(--initcnt))
{
eina_log_domain_unregister(EINA_SAFETY_LOG_DOMAIN);
EINA_SAFETY_LOG_DOMAIN = 0;
}
* finish benchmark tutorial * move internal _init and _shutdown functions in the Global part of the code, as it is where they belong * fix minor documentation stuff SVN revision: 44730
2009-12-27 00:45:30 -08:00
return EINA_TRUE;
}
missing file, sorry. SVN revision: 42215
2009-09-03 17:56:16 -07:00
/**
EINA API BREAK: no more individual modules init/shutdown. Being able to indivually initialize individual modules was initially "good", but at end it's putting complexities on users that would try to "optimize" by doing just what they used, but in the end most people would get them wrong, users would have to do lots of code and etc. At the end it does not worth. Most module init just register handful errors and log domains, so are cheap. The exception is mempool users, that would dlopen() stuff, but people that are concerned (embedded) can just compile those statically in eina. Since at the end any real application would use most of modules, we actually end saving lots of function calls that would do nothing other than increment a global counter. I also did the init/shutdown use an array, making it easier to maintain. The inital dependencies were analysed by a script I wrote, I hope it's all right. Please fix any breakages you find! SVN revision: 42300
2009-09-06 15:21:56 -07:00
* @internal
missing file, sorry. SVN revision: 42215
2009-09-03 17:56:16 -07:00
* @brief Initialize the safety checks module.
*
EINA API BREAK: no more individual modules init/shutdown. Being able to indivually initialize individual modules was initially "good", but at end it's putting complexities on users that would try to "optimize" by doing just what they used, but in the end most people would get them wrong, users would have to do lots of code and etc. At the end it does not worth. Most module init just register handful errors and log domains, so are cheap. The exception is mempool users, that would dlopen() stuff, but people that are concerned (embedded) can just compile those statically in eina. Since at the end any real application would use most of modules, we actually end saving lots of function calls that would do nothing other than increment a global counter. I also did the init/shutdown use an array, making it easier to maintain. The inital dependencies were analysed by a script I wrote, I hope it's all right. Please fix any breakages you find! SVN revision: 42300
2009-09-06 15:21:56 -07:00
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
missing file, sorry. SVN revision: 42215
2009-09-03 17:56:16 -07:00
*
* This function sets up the safety checks module of Eina. It is
EINA API BREAK: no more individual modules init/shutdown. Being able to indivually initialize individual modules was initially "good", but at end it's putting complexities on users that would try to "optimize" by doing just what they used, but in the end most people would get them wrong, users would have to do lots of code and etc. At the end it does not worth. Most module init just register handful errors and log domains, so are cheap. The exception is mempool users, that would dlopen() stuff, but people that are concerned (embedded) can just compile those statically in eina. Since at the end any real application would use most of modules, we actually end saving lots of function calls that would do nothing other than increment a global counter. I also did the init/shutdown use an array, making it easier to maintain. The inital dependencies were analysed by a script I wrote, I hope it's all right. Please fix any breakages you find! SVN revision: 42300
2009-09-06 15:21:56 -07:00
* called by eina_init().
missing file, sorry. SVN revision: 42215
2009-09-03 17:56:16 -07:00
*
* @see eina_init()
*/
EINA API BREAK: no more individual modules init/shutdown. Being able to indivually initialize individual modules was initially "good", but at end it's putting complexities on users that would try to "optimize" by doing just what they used, but in the end most people would get them wrong, users would have to do lots of code and etc. At the end it does not worth. Most module init just register handful errors and log domains, so are cheap. The exception is mempool users, that would dlopen() stuff, but people that are concerned (embedded) can just compile those statically in eina. Since at the end any real application would use most of modules, we actually end saving lots of function calls that would do nothing other than increment a global counter. I also did the init/shutdown use an array, making it easier to maintain. The inital dependencies were analysed by a script I wrote, I hope it's all right. Please fix any breakages you find! SVN revision: 42300
2009-09-06 15:21:56 -07:00
Eina_Bool
missing file, sorry. SVN revision: 42215
2009-09-03 17:56:16 -07:00
eina_safety_checks_init(void)
{
Eina safety: Add internal function to log errors The main reason is convenience for debugging when using GDB, this will give a simple breakpoint for all safety check failures. Also, this creates a more visible log domain (red).
2015-12-14 23:56:13 -08:00
if (!(initcnt++))
{
EINA_SAFETY_LOG_DOMAIN = eina_log_domain_register("eina_safety", EINA_COLOR_RED);
Eina safety: Set error flag in case of safety check error Eina_Error is almost not used at all. Meh.
2015-12-15 00:39:37 -08:00
EINA_ERROR_SAFETY_FAILED = eina_error_msg_static_register("Safety check failed");
Eina safety: Add internal function to log errors The main reason is convenience for debugging when using GDB, this will give a simple breakpoint for all safety check failures. Also, this creates a more visible log domain (red).
2015-12-14 23:56:13 -08:00
}
EINA API BREAK: no more individual modules init/shutdown. Being able to indivually initialize individual modules was initially "good", but at end it's putting complexities on users that would try to "optimize" by doing just what they used, but in the end most people would get them wrong, users would have to do lots of code and etc. At the end it does not worth. Most module init just register handful errors and log domains, so are cheap. The exception is mempool users, that would dlopen() stuff, but people that are concerned (embedded) can just compile those statically in eina. Since at the end any real application would use most of modules, we actually end saving lots of function calls that would do nothing other than increment a global counter. I also did the init/shutdown use an array, making it easier to maintain. The inital dependencies were analysed by a script I wrote, I hope it's all right. Please fix any breakages you find! SVN revision: 42300
2009-09-06 15:21:56 -07:00
return EINA_TRUE;
missing file, sorry. SVN revision: 42215
2009-09-03 17:56:16 -07:00
}
eina: Rename EAPI macro to EINA_API in Eina library Summary: Patch from a series of patches to rename EAPI symbols to specific library DSOs. EAPI was designed to be able to pass `__attribute__ ((visibility ("default")))` for symbols with GCC, which would mean that even if -fvisibility=hidden was used when compiling the library, the needed symbols would get exported. MSVC __almost__ works like GCC (or mingw) in which you can declare everything as export and it will just work (slower, but it will work). But there's a caveat: global variables will not work the same way for MSVC, but works for mingw and GCC. For global variables (as opposed to functions), MSVC requires correct DSO visibility for MSVC: instead of declaring a symbol as export for everything, you need to declare it as import when importing from another DSO and export when defining it locally. With current EAPI definitions, we get the following example working in mingw and MSVC (observe it doesn't define any global variables as exported symbols). Example 1: dll1: ``` EAPI void foo(void); EAPI void bar() { foo(); } ``` dll2: ``` EAPI void foo() { printf ("foo\n"); } ``` This works fine with API defined as __declspec(dllexport) in both cases and for gcc defining as `__atttribute__((visibility("default")))` However, the following: Example 2: dll1: ``` EAPI extern int foo; EAPI void foobar(void); EAPI void bar() { foo = 5; foobar(); } ``` dll2: ``` EAPI int foo = 0; EAPI void foobar() { printf ("foo %d\n", foo); } ``` This will work on mingw but will not work for MSVC. And that's why EAPI is the only solution that worked for MSVC. Co-authored-by: João Paulo Taylor Ienczak Zanette <jpaulotiz@gmail.com> Co-authored-by: Ricardo Campos <ricardo.campos@expertise.dev> Co-authored-by: Lucas Cavalcante de Sousa <lucks.sousa@gmail.com> Reviewers: jptiz, lucas, woohyun, vtorri, raster Reviewed By: jptiz, lucas, vtorri Subscribers: ProhtMeyhet, cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D12188
2020-11-25 04:35:48 -08:00
EINA_API void
Eina safety: Add internal function to log errors The main reason is convenience for debugging when using GDB, this will give a simple breakpoint for all safety check failures. Also, this creates a more visible log domain (red).
2015-12-14 23:56:13 -08:00
_eina_safety_error(const char *file, const char *func, int line, const char *str)
{
Eina safety: Set error flag in case of safety check error Eina_Error is almost not used at all. Meh.
2015-12-15 00:39:37 -08:00
eina_error_set(EINA_ERROR_SAFETY_FAILED);
Eina safety: Add internal function to log errors The main reason is convenience for debugging when using GDB, this will give a simple breakpoint for all safety check failures. Also, this creates a more visible log domain (red).
2015-12-14 23:56:13 -08:00
if (EINA_SAFETY_LOG_DOMAIN)
{
eina_log_print(EINA_SAFETY_LOG_DOMAIN, EINA_LOG_LEVEL_ERR,
file, func, line, "%s", str);
}
else
{
eina_log_print(EINA_LOG_DOMAIN_DEFAULT, EINA_LOG_LEVEL_ERR,
file, func, line, "%s", str);
}
}