1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
|
#ifndef AWS_S3_CHECKSUM_CONTEXT_H
#define AWS_S3_CHECKSUM_CONTEXT_H
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
#include "aws/s3/s3_client.h"
#include <aws/common/byte_buf.h>
#include <aws/common/mutex.h>
#include <aws/common/ref_count.h>
struct aws_s3_meta_request_checksum_config_storage;
AWS_EXTERN_C_BEGIN
/**
* Upload request checksum context that encapsulates all checksum-related state and behavior
* for individual upload part requests. This replaces the complex tri-state buffer logic
* with a cleaner approach. Uses reference counting for lifetime management since context
* is transferred between functions.
*/
struct aws_s3_upload_request_checksum_context {
struct aws_allocator *allocator;
struct aws_ref_count ref_count;
/* Configuration */
enum aws_s3_checksum_algorithm algorithm;
enum aws_s3_checksum_location location;
struct {
/* Note: don't directly access the synced_data. */
/* Lock to make sure the checksum context is safe to be access from different threads. */
struct aws_mutex lock;
struct aws_byte_buf base64_checksum;
/* The checksum already be calculated or not. */
bool checksum_calculated;
} synced_data;
/* Validation */
size_t encoded_checksum_size;
};
/**
* Create a new upload request checksum context from configuration and buffer parameters.
* This function encapsulates all the complex logic for determining buffer state.
* Returns with reference count of 1.
*
* @param allocator Memory allocator
* @param checksum_config Meta request level checksum configuration (can be NULL)
* @return New checksum context or NULL on error
*/
AWS_S3_API
struct aws_s3_upload_request_checksum_context *aws_s3_upload_request_checksum_context_new(
struct aws_allocator *allocator,
const struct aws_s3_meta_request_checksum_config_storage *checksum_config);
/**
* Create a new upload request checksum context with an existing base64 encoded checksum value.
* This is useful when resuming uploads or when the checksum is pre-calculated.
* Returns with reference count of 1.
*
* @param allocator Memory allocator
* @param checksum_config Meta request level checksum configuration (can be NULL)
* @param existing_base64_checksum Pre-calculated checksum value as a byte cursor
* @return New checksum context or NULL on error (e.g., if checksum size doesn't match algorithm)
*/
AWS_S3_API
struct aws_s3_upload_request_checksum_context *aws_s3_upload_request_checksum_context_new_with_existing_base64_checksum(
struct aws_allocator *allocator,
const struct aws_s3_meta_request_checksum_config_storage *checksum_config,
struct aws_byte_cursor existing_base64_checksum);
/**
* Acquire a reference to the upload request checksum context.
* Use this when transferring ownership to another function/structure.
*
* @param context The checksum context to acquire
* @return The same context pointer (for convenience)
*/
AWS_S3_API
struct aws_s3_upload_request_checksum_context *aws_s3_upload_request_checksum_context_acquire(
struct aws_s3_upload_request_checksum_context *context);
/**
* Release a reference to the upload request checksum context.
* When the reference count reaches zero, the context will be destroyed.
* Always returns NULL.
*
* @param context The checksum context to release
*/
AWS_S3_API
struct aws_s3_upload_request_checksum_context *aws_s3_upload_request_checksum_context_release(
struct aws_s3_upload_request_checksum_context *context);
/**
* Check if checksum calculation is needed based on context state.
* Returns true if the context has a valid algorithm and the checksum has not been calculated yet.
*
* @param context The checksum context to check
* @return true if checksum calculation is needed, false otherwise
*/
AWS_S3_API
bool aws_s3_upload_request_checksum_context_should_calculate(struct aws_s3_upload_request_checksum_context *context);
/**
* Check if checksum should be added to HTTP headers.
* Returns true if the context has a valid algorithm and the location is set to header.
*
* @param context The checksum context to check
* @return true if checksum should be added to headers, false otherwise
*/
AWS_S3_API
bool aws_s3_upload_request_checksum_context_should_add_header(
const struct aws_s3_upload_request_checksum_context *context);
/**
* Check if checksum should be added as trailer (aws-chunked encoding).
* Returns true if the context has a valid algorithm and the location is set to trailer.
*
* @param context The checksum context to check
* @return true if checksum should be added as trailer, false otherwise
*/
AWS_S3_API
bool aws_s3_upload_request_checksum_context_should_add_trailer(
const struct aws_s3_upload_request_checksum_context *context);
/**
* Encode the checksum to base64 and store it in the context.
* This function is thread-safe and can be called from multiple threads.
* Returns AWS_OP_SUCCESS on success, AWS_OP_ERR otherwise
*
* @param context The checksum context
* @param raw_checksum_cursor the byte cursor to the raw checksum value.
* @return AWS_OP_SUCCESS on success, AWS_OP_ERR otherwise
*/
AWS_S3_API
int aws_s3_upload_request_checksum_context_finalize_checksum(
struct aws_s3_upload_request_checksum_context *context,
struct aws_byte_cursor raw_checksum_cursor);
/**
* Get a cursor to the current base64 encoded checksum value (for use in headers/trailers).
* Returns an empty cursor if the checksum has not been calculated yet.
*
* @param context The checksum context
* @return Byte cursor to the calculated checksum, or empty cursor if not available
*/
AWS_S3_API
struct aws_byte_cursor aws_s3_upload_request_checksum_context_get_checksum_cursor(
struct aws_s3_upload_request_checksum_context *context);
AWS_EXTERN_C_END
#endif /* AWS_S3_CHECKSUM_CONTEXT_H */
|
