Skip to content

fix: UBs #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Jul 12, 2022
Merged

fix: UBs #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
aa293ab
test: add test_spring_source_row_builder
laysakura Jul 12, 2022
e50a97c
fix: CString
laysakura Jul 12, 2022
d958945
fix: add test_spring_config()
laysakura Jul 12, 2022
91357e5
fix: UB around SpringConfig
laysakura Jul 12, 2022
f3d484e
fix: C header compile errors
laysakura Jul 12, 2022
fc55357
feat: impl Copy, ... to SpringErrno
laysakura Jul 12, 2022
60586a0
refactor: split tests
laysakura Jul 12, 2022
2aabeac
test: add test_spring_config_toml
laysakura Jul 12, 2022
dbb8bd0
fix: UB around SpringSourceRowBuilder
laysakura Jul 12, 2022
f05938e
fix: UB around SpringSourceRow
laysakura Jul 12, 2022
a337938
test: add test_spring_open
laysakura Jul 12, 2022
86c300a
fix: UB around SpringPipeline
laysakura Jul 12, 2022
3b03a5f
fix: remove spring_source_row_close because spring_push deallocate it
laysakura Jul 12, 2022
e3a2422
fix: size of c1_value
laysakura Jul 12, 2022
98bc2ce
test: add test_spring_sink_row
laysakura Jul 12, 2022
d09bed0
fix: UB around SpringSinkRow
laysakura Jul 12, 2022
04ba819
docs: CHANGELOG
laysakura Jul 12, 2022
f668c10
chore: rm unnecessary file
laysakura Jul 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,26 @@ Also check the changes in springql-core: <https://github.com/SpringQL/SpringQL/b
<!-- markdownlint-disable MD024 -->
## [Unreleased]

## [v0.16.0+4] - 2022-07-12

### Fixed

- Undefined behaviors on the following structures: ([#62](https://github.com/SpringQL/SpringQL-client-c/pull/62))
- SpringConfig
- SpringPipeline
- SpringSinkRow
- SpringSourceRow
- SpringSourceRowBuilder

### Changed

- `spring_push()` takes `SpringSourceRow *` instead of `const SpringSourceRow *`. It de-allocates `SpringSourceRow *`. ([#62](https://github.com/SpringQL/SpringQL-client-c/pull/62))
- `spring_source_row_add_column_blob()` returns new builder instead of modifying the existing one. ([#62](https://github.com/SpringQL/SpringQL-client-c/pull/62))

### Removed

- `spring_source_row_close()` ([#62](https://github.com/SpringQL/SpringQL-client-c/pull/62))

## [v0.16.0+3] - 2022-07-11

### Fixed
Expand Down Expand Up @@ -124,8 +144,9 @@ Depends on springql-core v0.7.1.
[Semantic Versioning]: https://semver.org/

<!-- Versions -->
[Unreleased]: https://github.com/SpringQL/SpringQL-client-c/compare/v0.16.0+3...HEAD
[Unreleased]: https://github.com/SpringQL/SpringQL-client-c/compare/v0.16.0+4...HEAD
[Released]: https://github.com/SpringQL/SpringQL-client-c/releases
[v0.16.0+4]: https://github.com/SpringQL/SpringQL-client-c/compare/v0.16.0+4...v0.16.0+4
[v0.16.0+3]: https://github.com/SpringQL/SpringQL-client-c/compare/v0.16.0+2...v0.16.0+3
[v0.16.0+2]: https://github.com/SpringQL/SpringQL-client-c/compare/v0.16.0...v0.16.0+2
[v0.16.0]: https://github.com/SpringQL/SpringQL-client-c/compare/v0.15.0+2...v0.16.0
Expand Down
88 changes: 43 additions & 45 deletions springql.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,35 +42,35 @@ typedef enum SpringErrno {
/**
* Configuration.
*/
typedef void *SpringConfig;
typedef struct SpringConfig SpringConfig;

/**
* Pipeline (dataflow definition) in SpringQL.
*/
typedef void *SpringPipeline;
typedef struct SpringPipeline SpringPipeline;

/**
* Row object to pop from an in memory queue.
*/
typedef void *SpringSinkRow;
typedef struct SpringSinkRow SpringSinkRow;

/**
* Row object to push into an in memory queue.
*/
typedef void *SpringSourceRow;
typedef struct SpringSourceRow SpringSourceRow;

/**
* Builder of SpringSourceRow
*/
typedef void *SpringSourceRowBuilder;
typedef struct SpringSourceRowBuilder SpringSourceRowBuilder;

/**
* Returns default configuration.
*
* Returned value is not modifiable (it is just a void pointer).
* If you would like to change the default configuration, use `spring_config_toml()` instead.
*/
SpringConfig *spring_config_default(void);
struct SpringConfig *spring_config_default(void);

/**
* Configuration by TOML format string.
Expand All @@ -89,7 +89,7 @@ SpringConfig *spring_config_default(void);
* - `overwrite_config_toml` includes invalid key and/or value.
* - `overwrite_config_toml` is not valid as TOML.
*/
SpringConfig *spring_config_toml(const char *overwrite_config_toml);
struct SpringConfig *spring_config_toml(const char *overwrite_config_toml);

/**
* Frees heap occupied by a `SpringConfig`.
Expand All @@ -99,7 +99,7 @@ SpringConfig *spring_config_toml(const char *overwrite_config_toml);
* - `Ok`: on success.
* - `CNull`: `config` is a NULL pointer.
*/
enum SpringErrno spring_config_close(SpringConfig *config);
enum SpringErrno spring_config_close(struct SpringConfig *config);

/**
* Creates and open an in-process stream pipeline.
Expand All @@ -113,7 +113,7 @@ enum SpringErrno spring_config_close(SpringConfig *config);
*
* No errors are expected currently.
*/
SpringPipeline *spring_open(const SpringConfig *config);
struct SpringPipeline *spring_open(const struct SpringConfig *config);

/**
* Frees heap occupied by a `SpringPipeline`.
Expand All @@ -123,7 +123,7 @@ SpringPipeline *spring_open(const SpringConfig *config);
* - `Ok`: on success.
* - `CNull`: `pipeline` is a NULL pointer.
*/
enum SpringErrno spring_close(SpringPipeline *pipeline);
enum SpringErrno spring_close(struct SpringPipeline *pipeline);

/**
* Execute commands (DDL) to modify the pipeline.
Expand All @@ -138,7 +138,7 @@ enum SpringErrno spring_close(SpringPipeline *pipeline);
* - `InvalidOption`:
* - `OPTIONS` in `CREATE` statement includes invalid key or value.
*/
enum SpringErrno spring_command(const SpringPipeline *pipeline, const char *sql);
enum SpringErrno spring_command(const struct SpringPipeline *pipeline, const char *sql);

/**
* Pop a row from an in memory queue. This is a blocking function.
Expand All @@ -156,7 +156,7 @@ enum SpringErrno spring_command(const SpringPipeline *pipeline, const char *sql)
*
* - `Unavailable`: queue named `queue` does not exist.
*/
SpringSinkRow *spring_pop(const SpringPipeline *pipeline, const char *queue);
struct SpringSinkRow *spring_pop(const struct SpringPipeline *pipeline, const char *queue);

/**
* Pop a row from an in memory queue. This is a non-blocking function.
Expand All @@ -170,21 +170,23 @@ SpringSinkRow *spring_pop(const SpringPipeline *pipeline, const char *queue);
*
* - `Unavailable`: queue named `queue` does not exist.
*/
SpringSinkRow *spring_pop_non_blocking(const SpringPipeline *pipeline,
const char *queue,
bool *is_err);
struct SpringSinkRow *spring_pop_non_blocking(const struct SpringPipeline *pipeline,
const char *queue,
bool *is_err);

/**
* Push a row into an in memory queue. This is a non-blocking function.
*
* `row` is freed internally.
*
* # Returns
*
* - `Ok`: on success.
* - `Unavailable`: queue named `queue` does not exist.
*/
enum SpringErrno spring_push(const SpringPipeline *pipeline,
enum SpringErrno spring_push(const struct SpringPipeline *pipeline,
const char *queue,
const SpringSourceRow *row);
struct SpringSourceRow *row);

/**
* Create a source row from JSON string
Expand All @@ -198,7 +200,7 @@ enum SpringErrno spring_push(const SpringPipeline *pipeline,
*
* - `InvalidFormat`: JSON string is invalid.
*/
SpringSourceRow *spring_source_row_from_json(const char *json);
struct SpringSourceRow *spring_source_row_from_json(const char *json);

/**
* Start creating a source row using a builder.
Expand All @@ -207,10 +209,12 @@ SpringSourceRow *spring_source_row_from_json(const char *json);
*
* Pointer to the builder
*/
SpringSourceRowBuilder *spring_source_row_builder(void);
struct SpringSourceRowBuilder *spring_source_row_builder(void);

/**
* Add a BLOB column to the builder.
* Add a BLOB column to the builder and return the new one.
*
* `builder` is freed internally.
*
* # Parameters
*
Expand All @@ -221,13 +225,17 @@ SpringSourceRowBuilder *spring_source_row_builder(void);
*
* # Returns
*
* - `Ok`: on success.
* - non-NULL: Successfully created a row.
* - NULL: Error occurred.
*
* # Errors
*
* - `Sql`: `column_name` is already added to the builder.
*/
enum SpringErrno spring_source_row_add_column_blob(SpringSourceRowBuilder *builder,
const char *column_name,
const void *v,
int v_len);
struct SpringSourceRowBuilder *spring_source_row_add_column_blob(struct SpringSourceRowBuilder *builder,
const char *column_name,
const void *v,
int v_len);

/**
* Finish creating a source row using a builder.
Expand All @@ -238,17 +246,7 @@ enum SpringErrno spring_source_row_add_column_blob(SpringSourceRowBuilder *build
*
* SpringSourceRow
*/
SpringSourceRow *spring_source_row_build(SpringSourceRowBuilder *builder);

/**
* Frees heap occupied by a `SpringSourceRow`.
*
* # Returns
*
* - `Ok`: on success.
* - `CNull`: `pipeline` is a NULL pointer.
*/
enum SpringErrno spring_source_row_close(SpringSourceRow *row);
struct SpringSourceRow *spring_source_row_build(struct SpringSourceRowBuilder *builder);

/**
* Frees heap occupied by a `SpringSinkRow`.
Expand All @@ -258,7 +256,7 @@ enum SpringErrno spring_source_row_close(SpringSourceRow *row);
* - `Ok`: on success.
* - `CNull`: `pipeline` is a NULL pointer.
*/
enum SpringErrno spring_sink_row_close(SpringSinkRow *row);
enum SpringErrno spring_sink_row_close(struct SpringSinkRow *row);

/**
* Get a 2-byte integer column.
Expand All @@ -277,7 +275,7 @@ enum SpringErrno spring_sink_row_close(SpringSinkRow *row);
* - `i_col` is out of range.
* - `CNull`: Column value is NULL.
*/
enum SpringErrno spring_column_short(const SpringSinkRow *row, uint16_t i_col, short *out);
enum SpringErrno spring_column_short(const struct SpringSinkRow *row, uint16_t i_col, short *out);

/**
* Get a 4-byte integer column.
Expand All @@ -296,7 +294,7 @@ enum SpringErrno spring_column_short(const SpringSinkRow *row, uint16_t i_col, s
* - `i_col` is out of range.
* - `CNull`: Column value is NULL.
*/
enum SpringErrno spring_column_int(const SpringSinkRow *row, uint16_t i_col, int *out);
enum SpringErrno spring_column_int(const struct SpringSinkRow *row, uint16_t i_col, int *out);

/**
* Get an 8-byte integer column.
Expand All @@ -315,7 +313,7 @@ enum SpringErrno spring_column_int(const SpringSinkRow *row, uint16_t i_col, int
* - `i_col` is out of range.
* - `CNull`: Column value is NULL.
*/
enum SpringErrno spring_column_long(const SpringSinkRow *row, uint16_t i_col, long *out);
enum SpringErrno spring_column_long(const struct SpringSinkRow *row, uint16_t i_col, long *out);

/**
* Get a 4-byte unsigned integer column.
Expand All @@ -334,7 +332,7 @@ enum SpringErrno spring_column_long(const SpringSinkRow *row, uint16_t i_col, lo
* - `i_col` is out of range.
* - `CNull`: Column value is NULL.
*/
enum SpringErrno spring_column_unsigned_int(const SpringSinkRow *row,
enum SpringErrno spring_column_unsigned_int(const struct SpringSinkRow *row,
uint16_t i_col,
unsigned int *out);

Expand All @@ -356,7 +354,7 @@ enum SpringErrno spring_column_unsigned_int(const SpringSinkRow *row,
* - `i_col` is out of range.
* - `CNull`: Column value is NULL.
*/
int spring_column_text(const SpringSinkRow *row, uint16_t i_col, char *out, int out_len);
int spring_column_text(const struct SpringSinkRow *row, uint16_t i_col, char *out, int out_len);

/**
* Get a BLOB column.
Expand All @@ -376,7 +374,7 @@ int spring_column_text(const SpringSinkRow *row, uint16_t i_col, char *out, int
* - `i_col` is out of range.
* - `CNull`: Column value is NULL.
*/
int spring_column_blob(const SpringSinkRow *row, uint16_t i_col, void *out, int out_len);
int spring_column_blob(const struct SpringSinkRow *row, uint16_t i_col, void *out, int out_len);

/**
* Get a bool column.
Expand All @@ -395,7 +393,7 @@ int spring_column_blob(const SpringSinkRow *row, uint16_t i_col, void *out, int
* - `i_col` is out of range.
* - `CNull`: Column value is NULL.
*/
enum SpringErrno spring_column_bool(const SpringSinkRow *row, uint16_t i_col, bool *out);
enum SpringErrno spring_column_bool(const struct SpringSinkRow *row, uint16_t i_col, bool *out);

/**
* Get a 4-byte floating point column.
Expand All @@ -414,7 +412,7 @@ enum SpringErrno spring_column_bool(const SpringSinkRow *row, uint16_t i_col, bo
* - `i_col` is out of range.
* - `CNull`: Column value is NULL.
*/
enum SpringErrno spring_column_float(const SpringSinkRow *row, uint16_t i_col, float *out);
enum SpringErrno spring_column_float(const struct SpringSinkRow *row, uint16_t i_col, float *out);

/**
* Write the most recent error number into `errno_` and message into a caller-provided buffer as a UTF-8
Expand Down
Loading