iframe-proxy | Sunbelt Computer Software

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

* 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_git_odb_backend_h__

#define INCLUDE_git_odb_backend_h__

#include "common.h"

#include "types.h"

#include "indexer.h"

/**

* @file git2/backend.h

* @brief Object database backends manage the storage of git objects

* @defgroup git_odb Git object database routines

* @ingroup Git

* @{

GIT_BEGIN_DECL

/** Options for configuring a packfile object backend. */

typedef struct {

unsigned int version; /**< version for the struct */

/**

* Type of object IDs to use for this object database, or

* 0 for default (currently SHA1).

git_oid_t oid_type;

} git_odb_backend_pack_options;

/** The current version of the diff options structure */

#define GIT_ODB_BACKEND_PACK_OPTIONS_VERSION 1

/**

* Stack initializer for odb pack backend options. Alternatively use

* `git_odb_backend_pack_options_init` programmatic initialization.

#define GIT_ODB_BACKEND_PACK_OPTIONS_INIT \

{ GIT_ODB_BACKEND_PACK_OPTIONS_VERSION }

typedef enum {

GIT_ODB_BACKEND_LOOSE_FSYNC = (1 << 0)

} git_odb_backend_loose_flag_t;

/** Options for configuring a loose object backend. */

typedef struct {

unsigned int version; /**< version for the struct */

/** A combination of the `git_odb_backend_loose_flag_t` types. */

uint32_t flags;

/**

* zlib compression level to use (0-9), where 1 is the fastest

* at the expense of larger files, and 9 produces the best

* compression at the expense of speed. 0 indicates that no

* compression should be performed. -1 is the default (currently

* optimizing for speed).

int compression_level;

/** Permissions to use creating a directory or 0 for defaults */

unsigned int dir_mode;

/** Permissions to use creating a file or 0 for defaults */

unsigned int file_mode;

/**

* Type of object IDs to use for this object database, or

* 0 for default (currently SHA1).

git_oid_t oid_type;

} git_odb_backend_loose_options;

/** The current version of the diff options structure */

#define GIT_ODB_BACKEND_LOOSE_OPTIONS_VERSION 1

/**

* Stack initializer for odb loose backend options. Alternatively use

* `git_odb_backend_loose_options_init` programmatic initialization.

#define GIT_ODB_BACKEND_LOOSE_OPTIONS_INIT \

{ GIT_ODB_BACKEND_LOOSE_OPTIONS_VERSION, 0, -1 }

* Constructors for in-box ODB backends.

#ifdef GIT_EXPERIMENTAL_SHA256

/**

* Create a backend for a directory containing packfiles.

* @param[out] out location to store the odb backend pointer

* @param objects_dir the Git repository's objects directory

* @param opts the options to use when creating the pack backend

* @return 0 or an error code

GIT_EXTERN(int) git_odb_backend_pack(

git_odb_backend **out,

const char *objects_dir,

const git_odb_backend_pack_options *opts);

/**

* Create a backend for a single packfile.

* @param[out] out location to store the odb backend pointer

* @param index_file path to the packfile's .idx file

* @param opts the options to use when creating the pack backend

* @return 0 or an error code

GIT_EXTERN(int) git_odb_backend_one_pack(

git_odb_backend **out,

const char *index_file,

const git_odb_backend_pack_options *opts);

/**

* Create a backend for loose objects

* @param[out] out location to store the odb backend pointer

* @param objects_dir the Git repository's objects directory

* @param opts options for the loose object backend or NULL

* @return 0 or an error code

GIT_EXTERN(int) git_odb_backend_loose(

git_odb_backend **out,

const char *objects_dir,

git_odb_backend_loose_options *opts);

#else

/**

* Create a backend for a directory containing packfiles.

* @param[out] out location to store the odb backend pointer

* @param objects_dir the Git repository's objects directory

* @return 0 or an error code

GIT_EXTERN(int) git_odb_backend_pack(

git_odb_backend **out,

const char *objects_dir);

/**

* Create a backend out of a single packfile

* This can be useful for inspecting the contents of a single

* packfile.

* @param[out] out location to store the odb backend pointer

* @param index_file path to the packfile's .idx file

* @return 0 or an error code

GIT_EXTERN(int) git_odb_backend_one_pack(

git_odb_backend **out,

const char *index_file);

/**

* Create a backend for loose objects

* @param[out] out location to store the odb backend pointer

* @param objects_dir the Git repository's objects directory

* @param compression_level zlib compression level (0-9), or -1 for the default

* @param do_fsync if non-zero, perform an fsync on write

* @param dir_mode permission to use when creating directories, or 0 for default

* @param file_mode permission to use when creating directories, or 0 for default

* @return 0 or an error code

GIT_EXTERN(int) git_odb_backend_loose(

git_odb_backend **out,

const char *objects_dir,

int compression_level,

int do_fsync,

unsigned int dir_mode,

unsigned int file_mode);

#endif

/** Streaming mode */

typedef enum {

GIT_STREAM_RDONLY = (1 << 1),

GIT_STREAM_WRONLY = (1 << 2),

GIT_STREAM_RW = (GIT_STREAM_RDONLY | GIT_STREAM_WRONLY)

} git_odb_stream_t;

/**

* A stream to read/write from a backend.

* This represents a stream of data being written to or read from a

* backend. When writing, the frontend functions take care of

* calculating the object's id and all `finalize_write` needs to do is

* store the object with the id it is passed.

struct git_odb_stream {

git_odb_backend *backend;

unsigned int mode;

void *hash_ctx;

#ifdef GIT_EXPERIMENTAL_SHA256

git_oid_t oid_type;

#endif

git_object_size_t declared_size;

git_object_size_t received_bytes;

/**

* Write at most `len` bytes into `buffer` and advance the stream.

int GIT_CALLBACK(read)(git_odb_stream *stream, char *buffer, size_t len);

/**

* Write `len` bytes from `buffer` into the stream.

int GIT_CALLBACK(write)(git_odb_stream *stream, const char *buffer, size_t len);

/**

* Store the contents of the stream as an object with the id

* specified in `oid`.

* This method might not be invoked if:

* - an error occurs earlier with the `write` callback,

* - the object referred to by `oid` already exists in any backend, or

* - the final number of received bytes differs from the size declared

* with `git_odb_open_wstream()`

int GIT_CALLBACK(finalize_write)(git_odb_stream *stream, const git_oid *oid);

/**

* Free the stream's memory.

* This method might be called without a call to `finalize_write` if

* an error occurs or if the object is already present in the ODB.

void GIT_CALLBACK(free)(git_odb_stream *stream);

};

/** A stream to write a pack file to the ODB */

struct git_odb_writepack {

git_odb_backend *backend;

int GIT_CALLBACK(append)(git_odb_writepack *writepack, const void *data, size_t size, git_indexer_progress *stats);

int GIT_CALLBACK(commit)(git_odb_writepack *writepack, git_indexer_progress *stats);

void GIT_CALLBACK(free)(git_odb_writepack *writepack);

};

/** @} */

GIT_END_DECL

#endif

Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Repository navigation

odb_backend.h

odb_backend.h

Sunbelt Computer Software

PL/B Language Development and Support

FilesExpand file tree

odb_backend.h

Latest commit

History

odb_backend.h

File metadata and controls