Skip to content

Commit 7dac493

Browse files
harningtharningt
committed
cf_buckets: adds new baseline implementation and preliminary design documentation
1 parent 523ea97 commit 7dac493

11 files changed

+359
-0
lines changed

‎CMakeLists.txt

+1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ ENDIF(NOT WIN32)
4141

4242
ADD_SUBDIRECTORY(submodules/cf_memsys)
4343
ADD_SUBDIRECTORY(cryptoface)
44+
ADD_SUBDIRECTORY(cf_buckets)
4445

4546
IF(BUILD_CF_BEECRYPT)
4647
ADD_SUBDIRECTORY(plugins/cf_beecrypt)

‎cf_buckets/CMakeLists.txt

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
cmake_minimum_required(VERSION 2.6)
2+
project(cf_buckets C)
3+
4+
# Pulldown libarena
5+
find_package(libarena REQUIRED CONFIG PATHS ${CMAKE_MODULE_PATH})
6+
# Pulldown cryptoface for error definitions, at least until a common error
7+
# system is in place
8+
find_package(cryptoface REQUIRED CONFIG PATHS ${CMAKE_MODULE_PATH})
9+
10+
SET(SOURCES
11+
src/cf_bucket.c
12+
src/cf_bucket_manager.c
13+
src/cf_memory_bucket.c
14+
)
15+
SET(HEADERS
16+
include/cf_bucket_internal.h
17+
include/cf_bucket_manager_internal.h
18+
)
19+
SET(PUBLIC_HEADERS
20+
include/cf_bucket.h
21+
include/cf_bucket_manager.h
22+
include/cf_memory_bucket.h
23+
)
24+
25+
add_library(cf_buckets STATIC ${SOURCES} ${HEADERS} ${PUBLIC_HEADERS})
26+
27+
target_link_libraries(cf_buckets ${LIBARENA_LIBRARIES})
28+
target_link_libraries(cf_buckets ${CRYPTOFACE_LIBRARIES})
29+
30+
include_directories(
31+
include
32+
${LIBARENA_INCLUDE_DIRS}
33+
${CRYPTOFACE_INCLUDE_DIRS}
34+
)

‎cf_buckets/include/cf_bucket.h

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
* Copyright (c) 2012 Thomas Harning Jr. <[email protected]>
3+
* Released under the MIT license. See included LICENSE details.
4+
*/
5+
#ifndef CF_BUCKET_H
6+
#define CF_BUCKET_H
7+
8+
#include <stdlib.h> /* size_t */
9+
10+
/*
11+
* @TODO: Centralize result codes
12+
*/
13+
14+
typedef struct cf_bucket *cf_bucket_t;
15+
16+
/**
17+
* Releases a bucket reference.
18+
*
19+
* @param bucket instance to release
20+
*
21+
* @returns 0 on success, non-zero on failure
22+
*/
23+
int cf_bucket_release(cf_bucket_t bucket);
24+
25+
#endif

‎cf_buckets/include/cf_bucket_internal.h

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
/*
2+
* Copyright (c) 2012 Thomas Harning Jr. <[email protected]>
3+
* Released under the MIT license. See included LICENSE details.
4+
*/
5+
#ifndef CF_BUCKET_INTERNAL_H
6+
#define CF_BUCKET_INTERNAL_H
7+
8+
#include "cf_bucket.h"
9+
#include "cf_bucket_manager.h"
10+
11+
/**
12+
* @see cf_bucket_release
13+
*/
14+
typedef int (* cf_bucket_release_op)(cf_bucket_t);
15+
16+
struct cf_bucket_ops {
17+
cf_bucket_release_op release;
18+
};
19+
20+
struct cf_bucket {
21+
/* BEGIN cf_bucket_manager_t MANAGED DATA */
22+
cf_bucket_manager_t manager;
23+
/* END cf_bucket_manager_t MANAGED DATA */
24+
const struct cf_bucket_ops *ops;
25+
};
26+
27+
#endif

‎cf_buckets/include/cf_bucket_manager.h

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/*
2+
* Copyright (c) 2012 Thomas Harning Jr. <[email protected]>
3+
* Released under the MIT license. See included LICENSE details.
4+
*/
5+
#ifndef CF_BUCKET_MANAGER_H
6+
#define CF_BUCKET_MANAGER_H
7+
8+
#include "cf_bucket.h"
9+
10+
/**
11+
* Manager for bucket instantiation and release.
12+
*/
13+
14+
typedef struct cf_bucket_manager *cf_bucket_manager_t;
15+
16+
/**
17+
* Obtains a new bucket manager instance.
18+
*
19+
* @param manager pointer to store new manage instance
20+
*
21+
* @returns 0 on success, non-zero on failure
22+
*/
23+
int cf_bucket_manager_new(cf_bucket_manager_t *manager);
24+
25+
/**
26+
* Releases a bucket manager instance.
27+
*
28+
* @param manager instance to operate on
29+
*
30+
* @returns 0 on success, non-zero on failure
31+
*/
32+
int cf_bucket_manager_destroy(cf_bucket_manager_t manager);
33+
34+
#endif

‎cf_buckets/include/cf_bucket_manager_internal.h

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/*
2+
* Copyright (c) 2012 Thomas Harning Jr. <[email protected]>
3+
* Released under the MIT license. See included LICENSE details.
4+
*/
5+
#ifndef CF_BUCKET_MANAGER_INTERNAL_H
6+
#define CF_BUCKET_MANAGER_INTERNAL_H
7+
8+
#include "cf_bucket_manager.h"
9+
10+
/**
11+
* Acquires a new bucket instance of a specific size.
12+
* The data must be >= sizeof base bucket as the front may be used for
13+
* management purposes (such as bucket re-use).
14+
*
15+
* @param bucket pointer to store allocated bucket in
16+
* @param manager pointer to operate on
17+
* @param size number of bytes to allocate for struct
18+
*
19+
* @returns 0 on success, non-zero on failure
20+
*/
21+
int cf_bucket_manager_allocate(cf_bucket_t *bucket, cf_bucket_manager_t manager, size_t size);
22+
23+
/**
24+
* Releases a bucket instance using its internally stored manager.
25+
*
26+
* @param bucket instance to release
27+
*
28+
* @returns 0 on success, non-zero on failure
29+
*/
30+
int cf_bucket_manager_release(cf_bucket_t bucket);
31+
32+
#endif

‎cf_buckets/include/cf_memory_bucket.h

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
* Copyright (c) 2012 Thomas Harning Jr. <[email protected]>
3+
* Released under the MIT license. See included LICENSE details.
4+
*/
5+
#ifndef CF_MEMORY_BUCKET_H
6+
#define CF_MEMORY_BUCKET_H
7+
8+
#include "cf_bucket.h"
9+
#include "cf_bucket_manager.h"
10+
11+
/* Header for simple memory-based buckets */
12+
13+
/**
14+
* Acquires a static, readonly, no-release bucket.
15+
*
16+
* @param bucket pointer to store the result in
17+
* @param data pointer to data
18+
* @param data_len length of data
19+
*
20+
* @return 0 on success, non-zero on failure
21+
*/
22+
int cf_memory_bucket_static_new(cf_bucket_t *bucket, cf_bucket_manager_t manager, void *data, size_t data_len);
23+
24+
#endif

‎cf_buckets/src/cf_bucket.c

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/*
2+
* Copyright (c) 2012 Thomas Harning Jr. <[email protected]>
3+
* Released under the MIT license. See included LICENSE details.
4+
*/
5+
#include "cf_bucket.h"
6+
#include "cf_bucket_internal.h"
7+
8+
int cf_bucket_release(cf_bucket_t bucket)
9+
{
10+
if (!bucket) {
11+
return -1;
12+
}
13+
return bucket->ops->release(bucket);
14+
}

‎cf_buckets/src/cf_bucket_manager.c

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
/*
2+
* Copyright (c) 2012 Thomas Harning Jr. <[email protected]>
3+
* Released under the MIT license. See included LICENSE details.
4+
*/
5+
6+
#include "cf_bucket_manager_internal.h"
7+
#include "cf_bucket_internal.h"
8+
9+
#include "arena/proto.h"
10+
11+
#include <string.h> /* memset */
12+
13+
struct cf_bucket_manager {
14+
/* Standard allocator for buckets and associated data */
15+
const struct arena_prototype *arena;
16+
};
17+
18+
int cf_bucket_manager_new(cf_bucket_manager_t *manager)
19+
{
20+
if (!manager) {
21+
return -1;
22+
}
23+
*manager = calloc(1, sizeof(**manager));
24+
if (!*manager) {
25+
return -1;
26+
}
27+
(*manager)->arena = ARENA_STDLIB;
28+
return 0;
29+
}
30+
31+
int cf_bucket_manager_destroy(cf_bucket_manager_t manager)
32+
{
33+
if (!manager) {
34+
return -1;
35+
}
36+
/* TODO: perform any state cleanup on buckets allocated */
37+
free(manager);
38+
return 0;
39+
}
40+
41+
42+
int cf_bucket_manager_allocate(cf_bucket_t *bucket, cf_bucket_manager_t manager, size_t size)
43+
{
44+
if (size < sizeof(**bucket)) {
45+
return -1;
46+
}
47+
*bucket = manager->arena->malloc(manager->arena, size, 0);
48+
if (!*bucket) {
49+
return -1;
50+
}
51+
memset(*bucket, 0, size);
52+
/* Store a self reference */
53+
(*bucket)->manager = manager;
54+
return 0;
55+
}
56+
57+
58+
int cf_bucket_manager_release(cf_bucket_t bucket)
59+
{
60+
if (!bucket) {
61+
return -1;
62+
}
63+
if (!bucket->manager) {
64+
return -2;
65+
}
66+
bucket->manager->arena->free(bucket->manager->arena, bucket);
67+
return 0;
68+
}

‎cf_buckets/src/cf_memory_bucket.c

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
/*
2+
* Copyright (c) 2012 Thomas Harning Jr. <[email protected]>
3+
* Released under the MIT license. See included LICENSE details.
4+
*/
5+
#include "cf_memory_bucket.h"
6+
#include "cf_bucket_internal.h"
7+
8+
static int cf_memory_bucket_static_release(cf_bucket_t bucket);
9+
10+
static const struct cf_bucket_ops STATIC_OPS = {
11+
cf_memory_bucket_static_release
12+
};
13+
14+
struct cf_memory_bucket
15+
{
16+
struct cf_bucket parent;
17+
void *data;
18+
size_t data_len;
19+
/* TODO: add bucket memory manager reference */
20+
};
21+
22+
int cf_memory_bucket_static_new(cf_bucket_t *bucket, cf_bucket_manager_t manager, void *data, size_t data_len)
23+
{
24+
struct cf_memory_bucket *instance = NULL;
25+
if (!bucket || (!data && data_len != 0)) {
26+
return -1;
27+
}
28+
instance = calloc(1, sizeof(*instance));
29+
if (!instance) {
30+
return -2;
31+
}
32+
instance->parent.ops = &STATIC_OPS;
33+
instance->data = data;
34+
instance->data_len = data_len;
35+
36+
*bucket = &instance->parent;
37+
38+
return 0;
39+
}
40+
41+
static int cf_memory_bucket_static_release(cf_bucket_t bucket)
42+
{
43+
if (!bucket) {
44+
return -1;
45+
}
46+
if (bucket->ops != &STATIC_OPS) {
47+
return -1;
48+
}
49+
free(bucket);
50+
return 0;
51+
}

‎docs/BUCKETS.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
Buckets
2+
=======
3+
4+
The bucket system is prepared in such a way that data buffers can me moved
5+
with ease and support many modes of transfer.
6+
7+
Buckets are effectively pointer to buffers, but may also represent data
8+
sourced from a stream that may support effective transfer to certain sinks.
9+
An example of such a bucket is one sourced from a file descriptor and then
10+
written to another file descriptor. Depending on the sources/destination
11+
file descriptor type, sendfile could be used to transfer the data, avoiding
12+
the memory buffers from being allocated and used in userspace.
13+
14+
Bucket State Information
15+
========================
16+
17+
* is-read-write
18+
* is-read-only
19+
* is-write-only
20+
21+
File Bucket Information
22+
+++++++++++++++++++++++
23+
24+
* fd
25+
* is-socket
26+
27+
Bucket Operations
28+
=================
29+
30+
31+
Streams
32+
=======
33+
34+
Steams abstract stream operations on top of buckets, such as:
35+
* read
36+
* to bucket
37+
* to stream
38+
* to buffer
39+
* write
40+
* from bucket
41+
* from stream
42+
* from buffer
43+
44+
Filters
45+
=======
46+
47+
Filters abstract operations on top of buckets and streams.
48+
49+
Some filters can accept multiple input/output streams.

0 commit comments

Comments
 (0)