mirror of
https://github.com/libgit2/libgit2.git
synced 2026-01-25 11:06:32 +00:00
9dd1bfe81c
Remove the number of functions that custom allocator users need to provide; nobody should need to implement `substrdup`. Keep it to the basics that are actually _needed_ for allocation (malloc, realloc, free) and reimplement the rest ourselves. In addition, move the failure check and error setting _out_ of the custom allocators and into a wrapper so that users don't need to deal with this. This also allows us to call our allocator (without the wrapper) early so that it does not try to set an error on failure, which may be important for bootstrapping.
68 lines
2.1 KiB
C
68 lines
2.1 KiB
C
/*
|
|
* Copyright (C) the libgit2 contributors. All rights reserved.
|
|
*
|
|
* This file is part of libgit2, distributed under the GNU GPL v2 with
|
|
* a Linking Exception. For full terms see the included COPYING file.
|
|
*/
|
|
|
|
#ifndef INCLUDE_sys_git_alloc_h__
|
|
#define INCLUDE_sys_git_alloc_h__
|
|
|
|
#include "git2/common.h"
|
|
|
|
GIT_BEGIN_DECL
|
|
|
|
/**
|
|
* An instance for a custom memory allocator
|
|
*
|
|
* Setting the pointers of this structure allows the developer to implement
|
|
* custom memory allocators. The global memory allocator can be set by using
|
|
* "GIT_OPT_SET_ALLOCATOR" with the `git_libgit2_opts` function. Keep in mind
|
|
* that all fields need to be set to a proper function.
|
|
*/
|
|
typedef struct {
|
|
/** Allocate `n` bytes of memory */
|
|
void * GIT_CALLBACK(gmalloc)(size_t n, const char *file, int line);
|
|
|
|
/**
|
|
* This function shall deallocate the old object `ptr` and return a
|
|
* pointer to a new object that has the size specified by `size`. In
|
|
* case `ptr` is `NULL`, a new array shall be allocated.
|
|
*/
|
|
void * GIT_CALLBACK(grealloc)(void *ptr, size_t size, const char *file, int line);
|
|
|
|
/**
|
|
* This function shall free the memory pointed to by `ptr`. In case
|
|
* `ptr` is `NULL`, this shall be a no-op.
|
|
*/
|
|
void GIT_CALLBACK(gfree)(void *ptr);
|
|
} git_allocator;
|
|
|
|
/**
|
|
* Initialize the allocator structure to use the `stdalloc` pointer.
|
|
*
|
|
* Set up the structure so that all of its members are using the standard
|
|
* "stdalloc" allocator functions. The structure can then be used with
|
|
* `git_allocator_setup`.
|
|
*
|
|
* @param allocator The allocator that is to be initialized.
|
|
* @return An error code or 0.
|
|
*/
|
|
int git_stdalloc_init_allocator(git_allocator *allocator);
|
|
|
|
/**
|
|
* Initialize the allocator structure to use the `crtdbg` pointer.
|
|
*
|
|
* Set up the structure so that all of its members are using the "crtdbg"
|
|
* allocator functions. Note that this allocator is only available on Windows
|
|
* platforms and only if libgit2 is being compiled with "-DMSVC_CRTDBG".
|
|
*
|
|
* @param allocator The allocator that is to be initialized.
|
|
* @return An error code or 0.
|
|
*/
|
|
int git_win32_crtdbg_init_allocator(git_allocator *allocator);
|
|
|
|
GIT_END_DECL
|
|
|
|
#endif
|