libcouchbase: 3.1.4 to 3.2.0 compatibility report

Test Info

Library Name	libcouchbase
Version #1	3.1.4
Version #2	3.2.0
Arch	x86_64
GCC Version	10
Subject	Binary Compatibility

Test Results

Total Header Files	25
Total Libraries	1
Total Symbols / Types	622 / 356
Compatibility	99.3%

Problem Summary

	Severity	Count
Added Symbols	-	24
Removed Symbols	High	2
Problems with Data Types	High	0
	Medium	1
	Low	3
Problems with Symbols	High	0
	Medium	0
	Low	0
Problems with Constants	Low	12
Other Changes in Constants	-	20

Added Symbols 24

couchbase.h, libcouchbase.so.8.0.1
lcb_cmdstore_preserve_expiry ( lcb_CMDSTORE* cmd, int should_preserve )
lcb_cmdsubdoc_preserve_expiry ( lcb_CMDSUBDOC* cmd, int should_preserve )
lcb_createopts_meter ( lcb_CREATEOPTS* options, lcbmetrics_METER const* metrics )
lcb_createopts_tracer ( lcb_CREATEOPTS* options, lcbtrace_TRACER* tracer )
lcb_respgetreplica_is_active ( lcb_RESPGETREPLICA const* resp )

metrics.h, libcouchbase.so.8.0.1
lcbmetrics_meter_cookie ( lcbmetrics_METER const* meter, void** cookie )
lcbmetrics_meter_create ( lcbmetrics_METER** meter, void* cookie )
lcbmetrics_meter_destroy ( lcbmetrics_METER const* meter )
lcbmetrics_meter_dtor_callback ( lcbmetrics_METER* meter, void(*callback)(lcbmetrics_METER const*) )
lcbmetrics_meter_value_recorder_callback ( lcbmetrics_METER* meter, lcbmetrics_VALUE_RECORDER_CALLBACK callback )
lcbmetrics_valuerecorder_cookie ( lcbmetrics_VALUERECORDER const* recorder, void** cookie )
lcbmetrics_valuerecorder_create ( lcbmetrics_VALUERECORDER** recorder, void* cookie )
lcbmetrics_valuerecorder_destroy ( lcbmetrics_VALUERECORDER const* recorder )
lcbmetrics_valuerecorder_dtor_callback ( lcbmetrics_VALUERECORDER* recorder, void(*callback)(lcbmetrics_VALUERECORDER const*) )
lcbmetrics_valuerecorder_record_value_callback ( lcbmetrics_VALUERECORDER* recorder, lcbmetrics_RECORD_VALUE callback )

tracing.h, libcouchbase.so.8.0.1
lcbtrace_span_get_is_dispatch ( lcbtrace_SPAN* span, int* dispatch )
lcbtrace_span_get_is_outer ( lcbtrace_SPAN* span, int* outer )
lcbtrace_span_get_service ( lcbtrace_SPAN* span, enum lcbtrace_SERVICE* svc )
lcbtrace_span_set_is_dispatch ( lcbtrace_SPAN* span, int dispatch )
lcbtrace_span_set_is_encode ( lcbtrace_SPAN* span, int encode )
lcbtrace_span_set_is_outer ( lcbtrace_SPAN* span, int outer )
lcbtrace_span_set_service ( lcbtrace_SPAN* span, enum lcbtrace_SERVICE svc )
lcbtrace_span_should_finish ( lcbtrace_SPAN* span )
lcbtrace_span_wrap ( lcbtrace_TRACER* tracer, char const* opname, uint64_t start, void* external_span, lcbtrace_SPAN** lcbspan )

to the top

Removed Symbols 2

utils.h, libcouchbase.so.7.0.5
lcb_resp_get_error_context ( int cbtype, struct lcb_RESPBASE_ const* rb )
lcb_resp_get_error_ref ( int cbtype, struct lcb_RESPBASE_ const* rb )

to the top

Problems with Data Types, Medium Severity 1

	Change	Effect
1	Type of field v has been changed from union lcbtrace_TRACER::._anon_42 (8 bytes) to union lcbtrace_TRACER::._anon_44 (40 bytes).	1) This field may be incorrectly initialized or accessed by applications. 2) Size of the inclusive type has been changed.

tracing.h
[+] struct lcbtrace_TRACER 1

to the top

Problems with Data Types, Low Severity 3

	Change	Effect
1	Base type has been changed from struct lcb_RESPBASE_ to void.	Replacement of the base data type may indicate a change in its semantic meaning.

	Change	Effect
1	Type of field v has been changed from union lcbcrypto_PROVIDER::._anon_203 to union lcbcrypto_PROVIDER::._anon_206.	Replacement of the field data type may indicate a change in the semantic meaning of the field.

	Change	Effect
1	Size of this type has been changed from 40 bytes to 72 bytes.	The fields or parameters of such data type may be incorrectly initialized or accessed by old client applications.

couchbase.h
[+] typedef lcb_RESPBASE 1

crypto.h
[+] struct lcbcrypto_PROVIDER 1

tracing.h
[+] struct lcbtrace_TRACER 1

to the top

Problems with Constants, Low Severity 12

	Change	Effect
1	The value of constant LCB_CNTL__MAX has been changed from 0x66 to 0x68.	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

	Change	Effect
1	The value of constant LCBTRACE_OP_DISPATCH_TO_SERVER has been changed from "dispatch_to_server" to "dispatch".	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

	Change	Effect
1	The value of constant LCBTRACE_TAG_COMPONENT has been changed from "component" to "db.couchbase.component".	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

	Change	Effect
1	The constant LCBTRACE_TAG_DB_TYPE with value "db.type" has been removed.	The value of this constant may no longer be properly handled by new-version library functions.

	Change	Effect
1	The value of constant LCBTRACE_TAG_LOCAL_ADDRESS has been changed from "local.address" to "net.host.name".	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

	Change	Effect
1	The value of constant LCBTRACE_TAG_LOCAL_ID has been changed from "couchbase.local_id" to "db.couchbase.local_id".	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

	Change	Effect
1	The value of constant LCBTRACE_TAG_OPERATION_ID has been changed from "couchbase.operation_id" to "db.couchbase.operation_id".	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

	Change	Effect
1	The value of constant LCBTRACE_TAG_PEER_ADDRESS has been changed from "peer.address" to "net.peer.name".	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

	Change	Effect
1	The value of constant LCBTRACE_TAG_PEER_LATENCY has been changed from "peer.latency" to "db.couchbase.server_duration".	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

	Change	Effect
1	The value of constant LCBTRACE_TAG_SERVICE has been changed from "couchbase.service" to "db.couchbase.service".	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

	Change	Effect
1	The value of constant LCBTRACE_TAG_SERVICE_N1QL has been changed from "n1ql" to "query".	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

	Change	Effect
1	The value of constant LCBTRACE_TAG_SERVICE_VIEW has been changed from "view" to "views".	Applications will pass an old value of this constant as the parameter to the new-version library functions, that expect a new one. This may result in crash of incorrect behavior of applications.

cntl.h
[+] LCB_CNTL__MAX

tracing.h
[+] LCBTRACE_OP_DISPATCH_TO_SERVER
[+] LCBTRACE_TAG_COMPONENT
[+] LCBTRACE_TAG_DB_TYPE
[+] LCBTRACE_TAG_LOCAL_ADDRESS
[+] LCBTRACE_TAG_LOCAL_ID
[+] LCBTRACE_TAG_OPERATION_ID
[+] LCBTRACE_TAG_PEER_ADDRESS
[+] LCBTRACE_TAG_PEER_LATENCY
[+] LCBTRACE_TAG_SERVICE
[+] LCBTRACE_TAG_SERVICE_N1QL
[+] LCBTRACE_TAG_SERVICE_VIEW

to the top

Other Changes in Constants 20

	Change	Effect
1	The constant LCB_CNTL_ENABLE_OP_METRICS with value 0x67 has been added.	No effect.

	Change	Effect
1	The constant LCB_CNTL_OP_METRICS_FLUSH_INTERVAL with value 0x66 has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_F_LOGGING with value 0x01 has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_F_EXTERNAL with value 0x02 has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_OP_ANALYTICS with value "analytics" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_OP_LOOKUPIN with value "lookup_in" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_OP_MUTATEIN with value "mutate_in" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_OP_QUERY with value "query" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_OP_SEARCH with value "search" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_OP_VIEW with value "views" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_TAG_COLLECTION with value "db.couchbase.collection" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_TAG_DURABILITY with value "db.couchbase.durability" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_TAG_LOCAL_PORT with value "net.host.port" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_TAG_OPERATION with value "db.operation" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_TAG_PEER_PORT with value "net.peer.port" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_TAG_RETRIES with value "db.couchbase.retries" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_TAG_SCOPE with value "db.couchbase.scope" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_TAG_STATEMENT with value "db.statement" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_TAG_SYSTEM with value "db.system" has been added.	No effect.

	Change	Effect
1	The constant LCBTRACE_TAG_TRANSPORT with value "db.net.transport" has been added.	No effect.

cntl.h
[+] LCB_CNTL_ENABLE_OP_METRICS
[+] LCB_CNTL_OP_METRICS_FLUSH_INTERVAL

metrics.h
[+] LCBTRACE_F_LOGGING

tracing.h
[+] LCBTRACE_F_EXTERNAL
[+] LCBTRACE_OP_ANALYTICS
[+] LCBTRACE_OP_LOOKUPIN
[+] LCBTRACE_OP_MUTATEIN
[+] LCBTRACE_OP_QUERY
[+] LCBTRACE_OP_SEARCH
[+] LCBTRACE_OP_VIEW
[+] LCBTRACE_TAG_COLLECTION
[+] LCBTRACE_TAG_DURABILITY
[+] LCBTRACE_TAG_LOCAL_PORT
[+] LCBTRACE_TAG_OPERATION
[+] LCBTRACE_TAG_PEER_PORT
[+] LCBTRACE_TAG_RETRIES
[+] LCBTRACE_TAG_SCOPE
[+] LCBTRACE_TAG_STATEMENT
[+] LCBTRACE_TAG_SYSTEM
[+] LCBTRACE_TAG_TRANSPORT

to the top

Header Files 25

assert.h
auth.h
cntl-private.h
cntl.h
configuration.h
couchbase.h
crypto.h
iops.h
ixmgmt.h
kvbuf.h
libev_io_opts.h
libevent_io_opts.h
libuv_compat.h
libuv_io_opts.h
logger.h
metrics.h
pktfwd.h
plugin-internal.h
select_io_opts.h
sysdefs.h
tracing.h
utils.h
vbucket.h
visibility.h
wsaerr.h

to the top

Libraries 1

libcouchbase.so.7.0.5

to the top

Test Info

Library Name	libcouchbase
Version #1	3.1.4
Version #2	3.2.0
Arch	x86_64
Subject	Source Compatibility

Test Results

Total Header Files	25
Total Libraries	1
Total Symbols / Types	627 / 359
Compatibility	99.3%

Problem Summary

	Severity	Count
Added Symbols	-	25
Removed Symbols	High	2
Problems with Data Types	High	0
	Medium	1
	Low	3
Problems with Symbols	High	0
	Medium	0
	Low	0
Problems with Constants	Low	16
Other Changes in Constants	-	20

Added Symbols 25

couchbase.h
lcb_cmdstore_preserve_expiry ( lcb_CMDSTORE* cmd, int should_preserve )
lcb_cmdsubdoc_preserve_expiry ( lcb_CMDSUBDOC* cmd, int should_preserve )
lcb_createopts_meter ( lcb_CREATEOPTS* options, lcbmetrics_METER const* metrics )
lcb_createopts_tracer ( lcb_CREATEOPTS* options, lcbtrace_TRACER* tracer )
lcb_respgetreplica_is_active ( lcb_RESPGETREPLICA const* resp )

metrics.h
lcbmetrics_meter_cookie ( lcbmetrics_METER const* meter, void** cookie )
lcbmetrics_meter_create ( lcbmetrics_METER** meter, void* cookie )
lcbmetrics_meter_destroy ( lcbmetrics_METER const* meter )
lcbmetrics_meter_dtor_callback ( lcbmetrics_METER* meter, void(*callback)(lcbmetrics_METER const*) )
lcbmetrics_meter_value_recorder_callback ( lcbmetrics_METER* meter, lcbmetrics_VALUE_RECORDER_CALLBACK callback )
lcbmetrics_valuerecorder_cookie ( lcbmetrics_VALUERECORDER const* recorder, void** cookie )
lcbmetrics_valuerecorder_create ( lcbmetrics_VALUERECORDER** recorder, void* cookie )
lcbmetrics_valuerecorder_destroy ( lcbmetrics_VALUERECORDER const* recorder )
lcbmetrics_valuerecorder_dtor_callback ( lcbmetrics_VALUERECORDER* recorder, void(*callback)(lcbmetrics_VALUERECORDER const*) )
lcbmetrics_valuerecorder_record_value_callback ( lcbmetrics_VALUERECORDER* recorder, lcbmetrics_RECORD_VALUE callback )

tracing.h
lcbtrace_span_get_is_dispatch ( lcbtrace_SPAN* span, int* dispatch )
lcbtrace_span_get_is_encoding ( lcbtrace_SPAN* span, int* encoding )
lcbtrace_span_get_is_outer ( lcbtrace_SPAN* span, int* outer )
lcbtrace_span_get_service ( lcbtrace_SPAN* span, enum lcbtrace_SERVICE* svc )
lcbtrace_span_set_is_dispatch ( lcbtrace_SPAN* span, int dispatch )
lcbtrace_span_set_is_encode ( lcbtrace_SPAN* span, int encode )
lcbtrace_span_set_is_outer ( lcbtrace_SPAN* span, int outer )
lcbtrace_span_set_service ( lcbtrace_SPAN* span, enum lcbtrace_SERVICE svc )
lcbtrace_span_should_finish ( lcbtrace_SPAN* span )
lcbtrace_span_wrap ( lcbtrace_TRACER* tracer, char const* opname, uint64_t start, void* external_span, lcbtrace_SPAN** lcbspan )

to the top

Removed Symbols 2

utils.h
lcb_resp_get_error_context ( int cbtype, struct lcb_RESPBASE_ const* rb )
lcb_resp_get_error_ref ( int cbtype, struct lcb_RESPBASE_ const* rb )

to the top

Problems with Data Types, Medium Severity 1

	Change	Effect
1	Type of field v has been changed from union lcbtrace_TRACER::._anon_42 to union lcbtrace_TRACER::._anon_44 of different format.	Recompilation of a client program may be broken.

tracing.h
[+] struct lcbtrace_TRACER 1

to the top

Problems with Data Types, Low Severity 3

	Change	Effect
1	Base type has been changed from struct lcb_RESPBASE_ to void.	Recompilation of a client program may be broken.

	Change	Effect
1	Type of field v has been changed from union lcbcrypto_PROVIDER::._anon_203 to union lcbcrypto_PROVIDER::._anon_206.	Recompilation of a client program may be broken.

	Change	Effect
1	Type of field v has been changed from union lcbuv_options_st::._anon_182 to union lcbuv_options_st::._anon_185.	Recompilation of a client program may be broken.

couchbase.h
[+] typedef lcb_RESPBASE 1

crypto.h
[+] struct lcbcrypto_PROVIDER 1

libuv_io_opts.h
[+] struct lcbuv_options_st 1

to the top

Problems with Constants, Low Severity 16

	Change	Effect
1	The value of constant LCB_CNTL__MAX has been changed from 0x66 to 0x68.	Recompilation of a client program may be broken.

	Change	Effect
1	The value of constant LCB_VERSION has been changed from 0x030104 to 0x030200.	Recompilation of a client program may be broken.

	Change	Effect
1	The value of constant LCB_VERSION_CHANGESET has been changed from "513555d6c63dec7fd7166450282be92c6f74ef47" to "c712686af5825f2f05c89112e555cd09906aa727".	Recompilation of a client program may be broken.

	Change	Effect
1	The value of constant LCB_VERSION_STRING has been changed from "3.1.4" to "3.2.0".	Recompilation of a client program may be broken.

cntl.h
[+] LCB_CNTL__MAX

configuration.h
[+] LCB_VERSION
[+] LCB_VERSION_CHANGESET
[+] LCB_VERSION_STRING

tracing.h
[+] LCBTRACE_OP_DISPATCH_TO_SERVER
[+] LCBTRACE_TAG_COMPONENT
[+] LCBTRACE_TAG_DB_TYPE
[+] LCBTRACE_TAG_LOCAL_ADDRESS
[+] LCBTRACE_TAG_LOCAL_ID
[+] LCBTRACE_TAG_OPERATION_ID
[+] LCBTRACE_TAG_PEER_ADDRESS
[+] LCBTRACE_TAG_PEER_LATENCY
[+] LCBTRACE_TAG_SERVICE
[+] LCBTRACE_TAG_SERVICE_N1QL
[+] LCBTRACE_TAG_SERVICE_VIEW

utils.h
[+] LCB_CMD_BASE

to the top

Other Changes in Constants 20

Header Files 25

to the top

Libraries 1

libcouchbase.so.7.0.5

to the top

API compatibility report for the libcouchbase library between 3.1.4 and 3.2.0 versions on x86_64

Test Info

Test Results

Problem Summary

Added Symbols 24

Removed Symbols 2

Problems with Data Types, Medium Severity 1

Problems with Data Types, Low Severity 3

Problems with Constants, Low Severity 12

Other Changes in Constants 20

Header Files 25

Libraries 1

Test Info

Test Results

Problem Summary

Added Symbols 25

Removed Symbols 2

Problems with Data Types, Medium Severity 1

Problems with Data Types, Low Severity 3

Problems with Constants, Low Severity 16

Other Changes in Constants 20

Header Files 25

Libraries 1