Binary compatibility report for the OpenR2 library between 1.3.3 and current versions on x86

Test Info

Library Name	OpenR2
Version #1	1.3.3
Version #2	current
CPU Type	x86
GCC Version	4.6.1

Test Results

Total Header Files	6
Total Shared Libraries	1
Total Symbols / Types	87 / 77
Verdict	Incompatible (9.8%)

Problem Summary

	Severity	Count
Added Symbols	-	19
Removed Symbols	High	4
Problems with Data Types	High	0
	Medium	5
	Low	6
Problems with Symbols	High	5
	Medium	4
	Low	5
Problems with Constants	Low	0
Other Changes in Data Types	-	7
Other Changes in Constants	-	8

Added Symbols (19)

r2chan.h, libopenr2.so.5.0.0
openr2_chan_get_cas ( openr2_chan_t* r2chan, enum openr2_cas_signal_t* rxcas, enum openr2_cas_signal_t* txcas )
openr2_chan_get_rx_cas ( openr2_chan_t* r2chan )
openr2_chan_get_tx_cas ( openr2_chan_t* r2chan )
openr2_chan_process_cas_signaling ( openr2_chan_t* r2chan )
openr2_chan_process_mf_signaling ( openr2_chan_t* r2chan )
openr2_chan_process_oob_events ( openr2_chan_t* r2chan )
openr2_chan_process_signaling ( openr2_chan_t* r2chan )
openr2_chan_run_schedule ( openr2_chan_t* r2chan )
openr2_chan_set_mflib_handles ( openr2_chan_t* r2chan, void* mf_write_handle, void* mf_read_handle )
openr2_chan_set_span_id ( openr2_chan_t* r2chan, int span_id )

r2context.h, libopenr2.so.5.0.0
openr2_context_set_io_type ( openr2_context_t* r2context, enum openr2_io_type_t io_type, struct openr2_io_interface_t* io_interface )
openr2_context_set_mflib_interface ( openr2_context_t* r2context, struct openr2_mflib_interface_t* mflib )
openr2_context_set_transcoder_interface ( openr2_context_t* r2context, struct openr2_transcoder_interface_t* transcoder )

r2engine.h, libopenr2.so.5.0.0
openr2_mf_rx ( openr2_mf_rx_state_t* s, int16_t const* amp, int samples )
openr2_mf_rx_init ( openr2_mf_rx_state_t* s, int fwd )
openr2_mf_tx ( openr2_mf_tx_state_t* s, int16_t* amp, int samples )
openr2_mf_tx_init ( openr2_mf_tx_state_t* s, int fwd )
openr2_mf_tx_put ( openr2_mf_tx_state_t* s, char digit )

r2log.h, libopenr2.so.5.0.0
openr2_generic_set_logging_func ( openr2_generic_logging_func_t logcallback )

to the top

Removed Symbols (4)

r2chan.h, libopenr2.so.3.1.2
openr2_chan_handle_cas ( openr2_chan_t* r2chan )
openr2_chan_process_event ( openr2_chan_t* r2chan )

r2context.h, libopenr2.so.3.1.2
openr2_context_get_dtmf_detection_end_timeout ( openr2_context_t* r2context )
openr2_context_set_dtmf_detection_end_timeout ( openr2_context_t* r2context, int dtmf_end )

to the top

Problems with Symbols, High Severity (5)

	Change	Effect
1	Parameter channo of type int has been added to the calling stack at the middle position.	Layout of parameter's stack has been changed and therefore parameters at higher positions in the stack may be incorrectly initialized by applications.
2	3rd middle parameter mf_write_handle has been removed from the calling stack.	Layout of parameter's stack has been changed and therefore parameters at higher positions in the stack may be incorrectly initialized by applications.
3	The pointer level of 2nd parameter chanfd has been increased from 0 to 1.	The library function may try to access unallocated memory by the dereferencing of old parameter value and therefore cause a crash of applications.

	Change	Effect
1	1st middle parameter mflib has been removed from the calling stack.	Layout of parameter's stack has been changed and therefore parameters at higher positions in the stack may be incorrectly initialized by applications.
2	3rd middle parameter transcoder has been removed from the calling stack.	Layout of parameter's stack has been changed and therefore parameters at higher positions in the stack may be incorrectly initialized by applications.

r2chan.h, libopenr2.so.3.1.2
[+] openr2_chan_new_from_fd ( openr2_context_t* r2context, int chanfd, void* mf_write_handle, void* mf_read_handle ) (3)

r2context.h, libopenr2.so.3.1.2
[+] openr2_context_new ( struct openr2_mflib_interface_t* mflib, struct openr2_event_interface_t* callmgmt, struct openr2_transcoder_interface_t* transcoder, enum openr2_variant_t variant, int max_ani, int max_dnis ) (2)

to the top

Problems with Data Types, Medium Severity (5)

	Change	Effect
1	Field on_call_proceed has been added at the middle position of this structural type.	1) Size of the inclusive type has been changed. 2) Layout of structure fields has been changed and therefore fields at higher positions of the structure definition may be incorrectly accessed by applications.

	Change	Effect
1	Value of member OR2_CAUSE_FORCED_RELEASE has been changed from 8 to 7.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
2	Value of member OR2_CAUSE_NUMBER_CHANGED has been changed from 9 to 8.	Applications may execute a wrong branch of code in the library and therefore change the behavior.

	Change	Effect
1	Value of member OR2_CALLING_PARTY_CATEGORY_TEST_EQUIPMENT has been changed from 6 to 5.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
2	Value of member OR2_CALLING_PARTY_CATEGORY_UNKNOWN has been changed from 5 to 7.	Applications may execute a wrong branch of code in the library and therefore change the behavior.

r2context.h
[+] struct openr2_event_interface_t (1)

r2proto.h
[+] enum openr2_call_disconnect_cause_t (2)
[+] enum openr2_calling_party_category_t (2)

to the top

Problems with Symbols, Medium Severity (4)

	Change	Effect
1	Parameter ani_restricted of type int has been added to the calling stack.	This parameter will not be initialized by old clients.

	Change	Effect
1	3rd parameter mf_write_handle has been removed from the calling stack.	This parameter will be ignored by the function.
2	4th parameter mf_read_handle has been removed from the calling stack.	This parameter will be ignored by the function.

	Change	Effect
1	4th parameter mf_read_handle has been removed from the calling stack.	This parameter will be ignored by the function.

r2chan.h, libopenr2.so.3.1.2
[+] openr2_chan_make_call ( openr2_chan_t* r2chan, char const* ani, char const* dnid, enum openr2_calling_party_category_t category ) (1)
[+] openr2_chan_new ( openr2_context_t* r2context, int channo, void* mf_write_handle, void* mf_read_handle ) (2)
[+] openr2_chan_new_from_fd ( openr2_context_t* r2context, int chanfd, void* mf_write_handle, void* mf_read_handle ) (1)

to the top

Problems with Data Types, Low Severity (6)

	Change	Effect
1	Field on_call_log_created has been added to this type.	1) This field will not be initialized by old clients. 2) Size of the inclusive type has been changed. NOTE: this field should be accessed only from the new library functions, otherwise it may result in crash or incorrect behavior of applications.
2	Size of this type has been changed from 64 bytes to 72 bytes.	The fields or parameters of such data type may be incorrectly initialized or accessed by old client applications.

	Change	Effect
1	Base type has been changed from void()(openr2_chan_t,char const,char const,enum openr2_calling_party_category_t) to void()(openr2_chan_t,char const,char const,enum openr2_calling_party_category_t,int).	Replacement of the base data type may indicate a change in its semantic meaning.

	Change	Effect
1	Base type has been changed from void()(openr2_context_t,enum openr2_log_level_t,char const,va_list) to void()(openr2_context_t,char const,char const,unsigned int,enum openr2_log_level_t,char const,va_list).	Replacement of the base data type may indicate a change in its semantic meaning.

	Change	Effect
1	The member OR2_CAUSE_COLLECT_CALL_REJECTED has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.

	Change	Effect
1	The member OR2_VAR_INDONESIA has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.

r2context.h
[+] struct openr2_event_interface_t (2)
[+] typedef openr2_handle_call_offered_func (1)
[+] typedef openr2_handle_context_logging_func (1)

r2proto.h
[+] enum openr2_call_disconnect_cause_t (1)
[+] enum openr2_variant_t (1)

to the top

Problems with Symbols, Low Severity (5)

	Change	Effect
1	The pointer level of return value has been increased from 0 to 1.	Applications will treat the return value as the lower-dimension array and will not read all elements. This may change the behavior of applications.
2	Type of return value has been changed from int to openr2_io_fd_t.	Replacement of return type may indicate a change in its semantic meaning.

	Change	Effect
1	3rd parameter dnid has been renamed to dnis.	Renaming of a parameter may indicate a change in its semantic meaning.

	Change	Effect
1	Type of 2nd parameter chanfd has been changed from int to openr2_io_fd_t.	Replacement of parameter data type may indicate a change in its semantic meaning.

	Change	Effect
1	Base type of 2nd parameter logcallback has been changed from void()(openr2_chan_t,enum openr2_log_level_t,char const,va_list) to void()(openr2_chan_t,char const,char const,unsigned int,enum openr2_log_level_t,char const,va_list).	Replacement of parameter base type may indicate a change in its semantic meaning.

r2chan.h, libopenr2.so.3.1.2
[+] openr2_chan_get_fd ( openr2_chan_t* r2chan ) (2)
[+] openr2_chan_make_call ( openr2_chan_t* r2chan, char const* ani, char const* dnid, enum openr2_calling_party_category_t category ) (1)
[+] openr2_chan_new_from_fd ( openr2_context_t* r2context, int chanfd, void* mf_write_handle, void* mf_read_handle ) (1)
[+] openr2_chan_set_logging_func ( openr2_chan_t* r2chan, openr2_logging_func_t logcallback ) (1)

to the top

Other Changes in Data Types (7)

	Change	Effect
1	The member OR2_LIBERR_INVALID_CHAN_NUMBER with value 4 has been added.	No effect.
2	The member OR2_LIBERR_INVALID_INTERFACE with value 6 has been added.	No effect.
3	The member OR2_LIBERR_NO_IO_IFACE_AVAILABLE with value 3 has been added.	No effect.
4	The member OR2_LIBERR_OUT_OF_MEMORY with value 5 has been added.	No effect.

	Change	Effect
1	The member OR2_CAUSE_GLARE with value 9 has been added.	No effect.

	Change	Effect
1	The member OR2_CALLING_PARTY_CATEGORY_PAY_PHONE with value 6 has been added.	No effect.

	Change	Effect
1	The member OR2_ALARM_RAISED with value 12 has been added.	No effect.

r2context.h
[+] enum openr2_liberr_t (4)

r2proto.h
[+] enum openr2_call_disconnect_cause_t (1)
[+] enum openr2_calling_party_category_t (1)
[+] enum openr2_protocol_error_t (1)

to the top

Other Changes in Constants (8)

	Change	Effect
1	The constant OR2_ALAW_AMI_MASK with value 0x55 has been added.	No effect.

	Change	Effect
1	The constant OR2_CONTINUE_DNIS_REQUEST with value 1 has been added.	No effect.

	Change	Effect
1	The constant OR2_IO_OOB_EVENT with value (1 << 2) has been added.	No effect.

	Change	Effect
1	The constant OR2_IO_READ with value (1 << 0) has been added.	No effect.

	Change	Effect
1	The constant OR2_IO_WRITE with value (1 << 1) has been added.	No effect.

	Change	Effect
1	The constant OR2_NUM_CAS_SIGNALS with value 8 has been added.	No effect.

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

	Change	Effect
1	The constant OR2_INVALID_SOCKET with value -1 has been added.	No effect.

r2engine.h
[+] OR2_ALAW_AMI_MASK

r2proto.h
[+] OR2_CONTINUE_DNIS_REQUEST
[+] OR2_IO_OOB_EVENT
[+] OR2_IO_READ
[+] OR2_IO_WRITE
[+] OR2_NUM_CAS_SIGNALS
[+] OR2_STOP_DNIS_REQUEST

r2thread.h
[+] OR2_INVALID_SOCKET

to the top

Header Files (6)

openr2.h
r2chan.h
r2context.h
r2log.h
r2proto.h
r2utils.h

to the top

Shared Libraries (1)

libopenr2.so.3.1.2

to the top