mirror of
https://github.com/brl/mutter.git
synced 2024-11-22 16:10:41 -05:00
f53fb5e2e0
This allows apps to catch out-of-memory errors when allocating textures. Textures can be pretty huge at times and so it's quite possible for an application to try and allocate more memory than is available. It's also very possible that the application can take some action in response to reduce memory pressure (such as freeing up texture caches perhaps) so we shouldn't just automatically abort like we do for trivial heap allocations. These public functions now take a CoglError argument so applications can catch out of memory errors: cogl_buffer_map cogl_buffer_map_range cogl_buffer_set_data cogl_framebuffer_read_pixels_into_bitmap cogl_pixel_buffer_new cogl_texture_new_from_data cogl_texture_new_from_bitmap Note: we've been quite conservative with how many apis we let throw OOM CoglErrors since we don't really want to put a burdon on developers to be checking for errors with every cogl api call. So long as there is some lower level api for apps to use that let them catch OOM errors for everything necessary that's enough and we don't have to make more convenient apis more awkward to use. The main focus is on bitmaps and texture allocations since they can be particularly large and prone to failing. A new cogl_attribute_buffer_new_with_size() function has been added in case developers need to catch OOM errors when allocating attribute buffers whereby they can first use _buffer_new_with_size() (which doesn't take a CoglError) followed by cogl_buffer_set_data() which will lazily allocate the buffer storage and report OOM errors. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit f7735e141ad537a253b02afa2a8238f96340b978) Note: since we can't break the API for Cogl 1.x then actually the main purpose of cherry picking this patch is to keep in-line with changes on the master branch so that we can easily cherry-pick patches. All the api changes relating stable apis released on the 1.12 branch have been reverted as part of cherry-picking this patch so this most just applies all the internal plumbing changes that enable us to correctly propagate OOM errors.
117 lines
2.8 KiB
C
117 lines
2.8 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2011 Intel Corporation.
|
|
*
|
|
* 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 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, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*
|
|
* Authors:
|
|
* Robert Bragg <robert@linux.intel.com>
|
|
*/
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "config.h"
|
|
#endif
|
|
|
|
#include "cogl-types.h"
|
|
#include "cogl-util.h"
|
|
#include "cogl-error-private.h"
|
|
|
|
#include <glib.h>
|
|
|
|
void
|
|
cogl_error_free (CoglError *error)
|
|
{
|
|
g_error_free ((GError *)error);
|
|
}
|
|
|
|
CoglError *
|
|
cogl_error_copy (CoglError *error)
|
|
{
|
|
return (CoglError *)g_error_copy ((GError *)error);
|
|
}
|
|
|
|
CoglBool
|
|
cogl_error_matches (CoglError *error,
|
|
uint32_t domain,
|
|
int code)
|
|
{
|
|
return g_error_matches ((GError *)error, domain, code);
|
|
}
|
|
|
|
#define ERROR_OVERWRITTEN_WARNING \
|
|
"CoglError set over the top of a previous CoglError or " \
|
|
"uninitialized memory.\nThis indicates a bug in someone's " \
|
|
"code. You must ensure an error is NULL before it's set.\n" \
|
|
"The overwriting error message was: %s"
|
|
|
|
void
|
|
_cogl_set_error (CoglError **error,
|
|
uint32_t domain,
|
|
int code,
|
|
const char *format,
|
|
...)
|
|
{
|
|
GError *new;
|
|
|
|
va_list args;
|
|
|
|
va_start (args, format);
|
|
|
|
if (error == NULL)
|
|
{
|
|
g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
|
|
va_end (args);
|
|
return;
|
|
}
|
|
|
|
new = g_error_new_valist (domain, code, format, args);
|
|
va_end (args);
|
|
|
|
if (*error == NULL)
|
|
*error = (CoglError *)new;
|
|
else
|
|
g_warning (ERROR_OVERWRITTEN_WARNING, new->message);
|
|
}
|
|
|
|
void
|
|
_cogl_set_error_literal (CoglError **error,
|
|
uint32_t domain,
|
|
int code,
|
|
const char *message)
|
|
{
|
|
_cogl_set_error (error, domain, code, "%s", message);
|
|
}
|
|
|
|
void
|
|
_cogl_propogate_error (CoglError **dest,
|
|
CoglError *src)
|
|
{
|
|
_COGL_RETURN_IF_FAIL (src != NULL);
|
|
|
|
_cogl_set_error_literal (dest, src->domain, src->code, src->message);
|
|
cogl_error_free (src);
|
|
}
|
|
|
|
void
|
|
_cogl_propogate_gerror (CoglError **dest,
|
|
GError *src)
|
|
{
|
|
_cogl_propogate_error (dest, (CoglError *)src);
|
|
}
|