mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 13:21:17 -05:00
9759608622
The Git project is not exactly the easiest project to get started in: it's written in C and POSIX shell, with bits of Perl, Rust and other languages sprinkled into it. On top of that, the project has grown somewhat organically over time, making the codebase hard to navigate. These are problems that we're aware of, and there have been and still are efforts to clean up some of the technical debt that is natural to exist an a project that is more than 20 years old. Furthermore, we provide resources to newcomers that help them out like our coding guidelines, code of conduct or "MyFirstContribution.adoc". But there is a rather practical problem: finding your way around in our project's tree is not easy. Doing a directory listing in the top-level directory will present you with more than 550 files, which makes it extremely hard for a newcomer to figure out what files they are even supposed to look at. This makes the onboarding experience somewhat harder than it really needs to be. This isn't only a problem for newcomers though, as I myself struggle to find the files I am looking for because of the sheer number of files. Besides the problem of discoverability it also creates a problem of structure. It is not obvious at all which files are part of "libgit.a" and which files are only linked into our final executables. So while we have this split in our build systems, that split is not evident at all in our tree. Introduce a new "lib/" directory and move all of our sources for "libgit.a" into it to fix these issues. It makes the split we have evident and reduces the number of files in our top-level tree from 550 files to ~80 files. This is still a lot of files, but it's significantly easier to navigate already. Furthermore, we can further iterate after this step and think about introducing a better structure for remaining files, as well. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
70 lines
1.7 KiB
C
70 lines
1.7 KiB
C
#ifndef MEM_POOL_H
|
|
#define MEM_POOL_H
|
|
|
|
struct mp_block {
|
|
struct mp_block *next_block;
|
|
char *next_free;
|
|
char *end;
|
|
uintmax_t space[FLEX_ARRAY]; /* more */
|
|
};
|
|
|
|
struct mem_pool {
|
|
struct mp_block *mp_block;
|
|
|
|
/*
|
|
* The amount of available memory to grow the pool by.
|
|
* This size does not include the overhead for the mp_block.
|
|
*/
|
|
size_t block_alloc;
|
|
|
|
/* The total amount of memory allocated by the pool. */
|
|
size_t pool_alloc;
|
|
};
|
|
|
|
/*
|
|
* Initialize mem_pool with specified initial size.
|
|
*/
|
|
void mem_pool_init(struct mem_pool *pool, size_t initial_size);
|
|
|
|
/*
|
|
* Discard all the memory the memory pool is responsible for.
|
|
*/
|
|
void mem_pool_discard(struct mem_pool *pool, int invalidate_memory);
|
|
|
|
/*
|
|
* Alloc memory from the mem_pool.
|
|
*/
|
|
void *mem_pool_alloc(struct mem_pool *pool, size_t len);
|
|
|
|
/*
|
|
* Allocate and zero memory from the memory pool.
|
|
*/
|
|
void *mem_pool_calloc(struct mem_pool *pool, size_t count, size_t size);
|
|
|
|
/*
|
|
* Allocate memory from the memory pool and copy str into it.
|
|
*/
|
|
char *mem_pool_strdup(struct mem_pool *pool, const char *str);
|
|
char *mem_pool_strndup(struct mem_pool *pool, const char *str, size_t len);
|
|
|
|
/*
|
|
* Allocate memory from the memory pool and format a string into it.
|
|
*/
|
|
__attribute__((format (printf, 2, 3)))
|
|
char *mem_pool_strfmt(struct mem_pool *pool, const char *fmt, ...);
|
|
|
|
/*
|
|
* Move the memory associated with the 'src' pool to the 'dst' pool. The 'src'
|
|
* pool will be empty and not contain any memory. It still needs to be free'd
|
|
* with a call to `mem_pool_discard`.
|
|
*/
|
|
void mem_pool_combine(struct mem_pool *dst, struct mem_pool *src);
|
|
|
|
/*
|
|
* Check if a memory pointed at by 'mem' is part of the range of
|
|
* memory managed by the specified mem_pool.
|
|
*/
|
|
int mem_pool_contains(struct mem_pool *pool, void *mem);
|
|
|
|
#endif
|