Skip to content

Commit b661e9a

Browse files
ethomsonethomson
authored
Merge pull request libgit2#5578 from libgit2/ethomson/friendlier_getting_started
Friendlier getting started in the lack of git_libgit2_init
2 parents a5cb2cc + 08f28ff commit b661e9a

File tree

8 files changed

+172
-4
lines changed

8 files changed

+172
-4
lines changed

‎src/alloc.c‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,22 @@
88
#include "alloc.h"
99
#include "runtime.h"
1010

11+
#include "allocators/failalloc.h"
1112
#include "allocators/stdalloc.h"
1213
#include "allocators/win32_leakcheck.h"
1314

14-
git_allocator git__allocator;
15+
/* Fail any allocation until git_libgit2_init is called. */
16+
git_allocator git__allocator = {
17+
git_failalloc_malloc,
18+
git_failalloc_calloc,
19+
git_failalloc_strdup,
20+
git_failalloc_strndup,
21+
git_failalloc_substrdup,
22+
git_failalloc_realloc,
23+
git_failalloc_reallocarray,
24+
git_failalloc_mallocarray,
25+
git_failalloc_free
26+
};
1527

1628
static int setup_default_allocator(void)
1729
{
@@ -25,10 +37,10 @@ static int setup_default_allocator(void)
2537
int git_allocator_global_init(void)
2638
{
2739
/*
28-
* We don't want to overwrite any allocator which has been set before
29-
* the init function is called.
40+
* We don't want to overwrite any allocator which has been set
41+
* before the init function is called.
3042
*/
31-
if (git__allocator.gmalloc != NULL)
43+
if (git__allocator.gmalloc != git_failalloc_malloc)
3244
return 0;
3345

3446
return setup_default_allocator();

‎src/allocators/failalloc.c‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
/*
2+
* Copyright (C) the libgit2 contributors. All rights reserved.
3+
*
4+
* This file is part of libgit2, distributed under the GNU GPL v2 with
5+
* a Linking Exception. For full terms see the included COPYING file.
6+
*/
7+
8+
#include "failalloc.h"
9+
10+
void *git_failalloc_malloc(size_t len, const char *file, int line)
11+
{
12+
GIT_UNUSED(len);
13+
GIT_UNUSED(file);
14+
GIT_UNUSED(line);
15+
16+
return NULL;
17+
}
18+
19+
void *git_failalloc_calloc(size_t nelem, size_t elsize, const char *file, int line)
20+
{
21+
GIT_UNUSED(nelem);
22+
GIT_UNUSED(elsize);
23+
GIT_UNUSED(file);
24+
GIT_UNUSED(line);
25+
26+
return NULL;
27+
}
28+
29+
char *git_failalloc_strdup(const char *str, const char *file, int line)
30+
{
31+
GIT_UNUSED(str);
32+
GIT_UNUSED(file);
33+
GIT_UNUSED(line);
34+
35+
return NULL;
36+
}
37+
38+
char *git_failalloc_strndup(const char *str, size_t n, const char *file, int line)
39+
{
40+
GIT_UNUSED(str);
41+
GIT_UNUSED(n);
42+
GIT_UNUSED(file);
43+
GIT_UNUSED(line);
44+
45+
return NULL;
46+
}
47+
48+
char *git_failalloc_substrdup(const char *start, size_t n, const char *file, int line)
49+
{
50+
GIT_UNUSED(start);
51+
GIT_UNUSED(n);
52+
GIT_UNUSED(file);
53+
GIT_UNUSED(line);
54+
55+
return NULL;
56+
}
57+
58+
void *git_failalloc_realloc(void *ptr, size_t size, const char *file, int line)
59+
{
60+
GIT_UNUSED(ptr);
61+
GIT_UNUSED(size);
62+
GIT_UNUSED(file);
63+
GIT_UNUSED(line);
64+
65+
return NULL;
66+
}
67+
68+
void *git_failalloc_reallocarray(void *ptr, size_t nelem, size_t elsize, const char *file, int line)
69+
{
70+
GIT_UNUSED(ptr);
71+
GIT_UNUSED(nelem);
72+
GIT_UNUSED(elsize);
73+
GIT_UNUSED(file);
74+
GIT_UNUSED(line);
75+
76+
return NULL;
77+
}
78+
79+
void *git_failalloc_mallocarray(size_t nelem, size_t elsize, const char *file, int line)
80+
{
81+
GIT_UNUSED(nelem);
82+
GIT_UNUSED(elsize);
83+
GIT_UNUSED(file);
84+
GIT_UNUSED(line);
85+
86+
return NULL;
87+
}
88+
89+
void git_failalloc_free(void *ptr)
90+
{
91+
GIT_UNUSED(ptr);
92+
}

‎src/allocators/failalloc.h‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/*
2+
* Copyright (C) the libgit2 contributors. All rights reserved.
3+
*
4+
* This file is part of libgit2, distributed under the GNU GPL v2 with
5+
* a Linking Exception. For full terms see the included COPYING file.
6+
*/
7+
8+
#ifndef INCLUDE_allocators_failalloc_h__
9+
#define INCLUDE_allocators_failalloc_h__
10+
11+
#include "common.h"
12+
13+
extern void *git_failalloc_malloc(size_t len, const char *file, int line);
14+
extern void *git_failalloc_calloc(size_t nelem, size_t elsize, const char *file, int line);
15+
extern char *git_failalloc_strdup(const char *str, const char *file, int line);
16+
extern char *git_failalloc_strndup(const char *str, size_t n, const char *file, int line);
17+
extern char *git_failalloc_substrdup(const char *start, size_t n, const char *file, int line);
18+
extern void *git_failalloc_realloc(void *ptr, size_t size, const char *file, int line);
19+
extern void *git_failalloc_reallocarray(void *ptr, size_t nelem, size_t elsize, const char *file, int line);
20+
extern void *git_failalloc_mallocarray(size_t nelem, size_t elsize, const char *file, int line);
21+
extern void git_failalloc_free(void *ptr);
22+
23+
#endif

‎src/errors.c‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
#include "threadstate.h"
1111
#include "posix.h"
1212
#include "buffer.h"
13+
#include "libgit2.h"
1314

1415
/********************************************
1516
* New error handling
@@ -20,6 +21,11 @@ static git_error g_git_oom_error = {
2021
GIT_ERROR_NOMEMORY
2122
};
2223

24+
static git_error g_git_uninitialized_error = {
25+
"libgit2 has not been initialized; you must call git_libgit2_init",
26+
GIT_ERROR_INVALID
27+
};
28+
2329
static void set_error_from_buffer(int error_class)
2430
{
2531
git_error *error = &GIT_THREADSTATE->error_t;
@@ -131,6 +137,10 @@ void git_error_clear(void)
131137

132138
const git_error *git_error_last(void)
133139
{
140+
/* If the library is not initialized, return a static error. */
141+
if (!git_libgit2_init_count())
142+
return &g_git_uninitialized_error;
143+
134144
return GIT_THREADSTATE->last_error;
135145
}
136146

‎src/libgit2.c‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,11 @@ int git_libgit2_init(void)
9090
return git_runtime_init(init_fns, ARRAY_SIZE(init_fns));
9191
}
9292

93+
int git_libgit2_init_count(void)
94+
{
95+
return git_runtime_init_count();
96+
}
97+
9398
int git_libgit2_shutdown(void)
9499
{
95100
return git_runtime_shutdown();

‎src/libgit2.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
#ifndef INCLUDE_libgit2_h__
88
#define INCLUDE_libgit2_h__
99

10+
extern int git_libgit2_init_count(void);
11+
1012
extern const char *git_libgit2__user_agent(void);
1113
extern const char *git_libgit2__ssl_ciphers(void);
1214

‎src/runtime.c‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,21 @@ int git_runtime_init(git_runtime_init_fn init_fns[], size_t cnt)
127127
return ret;
128128
}
129129

130+
int git_runtime_init_count(void)
131+
{
132+
int ret;
133+
134+
if (init_lock() < 0)
135+
return -1;
136+
137+
ret = git_atomic32_get(&init_count);
138+
139+
if (init_unlock() < 0)
140+
return -1;
141+
142+
return ret;
143+
}
144+
130145
int git_runtime_shutdown(void)
131146
{
132147
int ret;

‎src/runtime.h‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@ typedef void (*git_runtime_shutdown_fn)(void);
2828
*/
2929
int git_runtime_init(git_runtime_init_fn init_fns[], size_t cnt);
3030

31+
/*
32+
* Returns the number of initializations active (the number of calls to
33+
* `git_runtime_init` minus the number of calls sto `git_runtime_shutdown`).
34+
* If 0, the runtime is not currently initialized.
35+
*
36+
* @return The number of initializations performed or an error
37+
*/
38+
int git_runtime_init_count(void);
39+
3140
/**
3241
* Shut down the runtime. If this is the last shutdown call,
3342
* such that there are no remaining `init` calls, then any

0 commit comments

Comments
 (0)