Binary compatibility report for the libwebsockets.so object between 2.4.2 and 3.0.0 versions on x86_64

Test Info

Module Name	libwebsockets
Version #1	2.4.2
Version #2	3.0.0
Arch	x86_64
GCC Version	8.0.1

Test Results

Total Header Files	1
Total Source Files	21
Total Objects	1
Total Symbols / Types	162 / 60
Compatibility	93.2%

Problem Summary

	Severity	Count
Added Symbols	-	33
Removed Symbols	High	8
Problems with Data Types	High	0
	Medium	12
	Low	31
Problems with Symbols	High	0
	Medium	0
	Low	5
Problems with Constants	Low	0
Other Changes in Data Types	-	15

Added Symbols 33

libwebsockets.h, libwebsockets.so.13
lws_add_http_common_headers ( struct lws* wsi, unsigned int code, char const* content_type, lws_filepos_t content_len, unsigned char** p, unsigned char* end )
lws_b64_decode_string_len ( char const* in, int in_len, char* out, int out_size )
lws_b64_encode_string_url ( char const* in, int in_len, char* out, int out_size )
lws_buflist_append_segment ( struct lws_buflist** head, uint8_t const* buf, size_t len )
lws_buflist_destroy_all_segments ( struct lws_buflist** head )
lws_buflist_next_segment_len ( struct lws_buflist** head, uint8_t** buf )
lws_buflist_use_segment ( struct lws_buflist** head, size_t len )
lws_callback_vhost_protocols_vhost ( struct lws_vhost* vh, int reason, void* in, size_t len )
lws_cmdline_option ( int argc, char const** argv, char const* val )
lws_compare_time_t ( struct lws_context* context, time_t t1, time_t t2 )
lws_create_adopt_udp ( struct lws_vhost* vhost, int port, int flags, char const* protocol_name, struct lws* parent_wsi )
lws_dll_add_front ( struct lws_dll* d, struct lws_dll* phead )
lws_dll_remove ( struct lws_dll* d )
lws_filename_purify_inplace ( char* filename )
lws_finalize_write_http_header ( struct lws* wsi, unsigned char* start, unsigned char** pp, unsigned char* end )
lws_get_udp ( struct lws const* wsi )
lws_get_vhost_iface ( struct lws_vhost* vhost )
lws_get_vhost_listen_port ( struct lws_vhost* vhost )
lws_get_vhost_name ( struct lws_vhost* vhost )
lws_get_vhost_port ( struct lws_vhost* vhost )
lws_get_vhost_user ( struct lws_vhost* vhost )
lws_plat_read_file ( char const* filename, void* buf, int len )
lws_plat_recommended_rsa_bits ( )
lws_plat_write_cert ( struct lws_vhost* vhost, int is_key, int fd, void* buf, int len )
lws_plat_write_file ( char const* filename, void* buf, int len )
lws_pvo_search ( struct lws_protocol_vhost_options const* pvo, char const* name )
lws_ring_dump ( struct lws_ring* ring, uint32_t* tail )
lws_set_timer_usecs ( struct lws* wsi, lws_usec_t usecs )
lws_strncpy ( char* dest, char const* src, size_t size )
lws_timed_callback_vh_protocol ( struct lws_vhost* vh, struct lws_protocols const* prot, int reason, int secs )
lws_tls_cert_updated ( struct lws_context* context, char const* certpath, char const* keypath, char const* mem_cert, size_t len_mem_cert, char const* mem_privkey, size_t len_mem_privkey )
lws_tls_peer_cert_info ( struct lws* wsi, enum lws_tls_cert_info type, union lws_tls_cert_info_results* buf, size_t len )
lws_tls_vhost_cert_info ( struct lws_vhost* vhost, enum lws_tls_cert_info type, union lws_tls_cert_info_results* buf, size_t len )

to the top

Removed Symbols 8

libwebsockets.h, libwebsockets.so.12
lws_alloc_vfs_file ( struct lws_context* context, char const* filename, uint8_t** buf, lws_filepos_t* amount )
lws_context_destroy2 ( struct lws_context* context )
lws_ext_parse_options ( struct lws_extension const* ext, struct lws* wsi, void* ext_user, struct lws_ext_options const* opts, char const* in, int len )
lws_genhash_destroy ( struct lws_genhash_ctx* ctx, void* result )
lws_genhash_init ( struct lws_genhash_ctx* ctx, int type )
lws_genhash_size ( int type )
lws_genhash_update ( struct lws_genhash_ctx* ctx, void const* in, size_t len )
lws_read ( struct lws* wsi, unsigned char* buf, lws_filepos_t len )

to the top

Problems with Data Types, Medium Severity 12

	Change	Effect
1	Value of member WSI_INIT_TOKEN_MUXURL has been changed from 96 to 100.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
2	Value of member WSI_PARSING_COMPLETE has been changed from 95 to 99.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
3	Value of member WSI_TOKEN_NAME_PART has been changed from 92 to 96.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
4	Value of member WSI_TOKEN_SKIPPING has been changed from 93 to 97.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
5	Value of member WSI_TOKEN_SKIPPING_SAW_CR has been changed from 94 to 98.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
6	Value of member _WSI_TOKEN_CLIENT_HOST has been changed from 87 to 90.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
7	Value of member _WSI_TOKEN_CLIENT_IFACE has been changed from 90 to 93.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
8	Value of member _WSI_TOKEN_CLIENT_METHOD has been changed from 89 to 92.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
9	Value of member _WSI_TOKEN_CLIENT_ORIGIN has been changed from 88 to 91.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
10	Value of member _WSI_TOKEN_CLIENT_PEER_ADDRESS has been changed from 85 to 88.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
11	Value of member _WSI_TOKEN_CLIENT_SENT_PROTOCOLS has been changed from 84 to 87.	Applications may execute a wrong branch of code in the library and therefore change the behavior.
12	Value of member _WSI_TOKEN_CLIENT_URI has been changed from 86 to 89.	Applications may execute a wrong branch of code in the library and therefore change the behavior.

libwebsockets.h
[+] enum lws_token_indexes 12

to the top

Problems with Data Types, Low Severity 31

	Change	Effect
1	The member LWS_EXT_CB_1HZ has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
2	The member LWS_EXT_CB_ANY_WSI_ESTABLISHED has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
3	The member LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
4	The member LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
5	The member LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
6	The member LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
7	The member LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
8	The member LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
9	The member LWS_EXT_CB_EXTENDED_PAYLOAD_RX has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
10	The member LWS_EXT_CB_FLUSH_PENDING_TX has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
11	The member LWS_EXT_CB_HANDSHAKE_REPLY_TX has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
12	The member LWS_EXT_CB_IS_WRITEABLE has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
13	The member LWS_EXT_CB_PACKET_RX_PREPARSE has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
14	The member LWS_EXT_CB_PACKET_TX_DO_SEND has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
15	The member LWS_EXT_CB_REQUEST_ON_WRITEABLE has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
16	The member LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT has been removed.	This may result in crash or incorrect behavior of applications because the library may not handle removed member anymore.
17	The member LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT 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	Value of member WSI_TOKEN_COUNT has been changed from 91 to 95.	Applications may execute a wrong branch of code in the library and therefore change the behavior.

	Change	Effect
1	Name of member with value 7 has been changed from PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE to PENDING_TIMEOUT_UNUSED1.	Applications may execute a wrong branch of code in the library and therefore change the behavior.

	Change	Effect
1	Field alpn 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	Field local_protocol_name 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.
3	Size of this type has been changed from 168 bytes to 184 bytes.	The fields or parameters of such data type may be incorrectly initialized or accessed by old client applications.

	Change	Effect
1	Field alpn 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	Field error_document_404 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.
3	Field foreign_loops 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.
4	Field pcontext 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.
5	Field signal_cb 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.
6	Size of this type has been changed from 448 bytes to 456 bytes.	The fields or parameters of such data type may be incorrectly initialized or accessed by old client applications.

	Change	Effect
1	Field chunked has been added to this type.	This field will not be initialized by old clients. NOTE: this field should be accessed only from the new library functions, otherwise it may result in crash or incorrect behavior of applications.

	Change	Effect
1	Size of this type has been changed from 182 bytes to 190 bytes.	The fields or parameters of such data type may be incorrectly initialized or accessed by old client applications.
2	Type of field token_limit has been changed from unsigned short[91] to unsigned short[95].	Replacement of the field data type may indicate a change in the semantic meaning of the field.

libwebsockets.h
[+] enum lws_extension_callback_reasons 17
[+] enum lws_token_indexes 1
[+] enum pending_timeout 1
[+] struct lws_client_connect_info 3
[+] struct lws_context_creation_info 6
[+] struct lws_process_html_args 1
[+] struct lws_token_limits 2

to the top

Problems with Symbols, Low Severity 5

	Change	Effect
1	Type of 1st parameter info has been changed from struct lws_context_creation_info* to struct lws_context_creation_info const*.	Replacement of parameter data type may indicate a change in its semantic meaning.

	Change	Effect
1	Type of 2nd parameter info has been changed from struct lws_context_creation_info* to struct lws_context_creation_info const*.	Replacement of parameter data type may indicate a change in its semantic meaning.

	Change	Effect
1	Type of return value has been changed from size_t to lws_fileofs_t.	Replacement of return type may indicate a change in its semantic meaning.

	Change	Effect
1	Type of return value has been changed from int to lws_sockfd_type.	Replacement of return type may indicate a change in its semantic meaning.

	Change	Effect
1	Type of return value has been changed from SSL* to lws_tls_conn*.	Replacement of return type may indicate a change in its semantic meaning.

libwebsockets.h, libwebsockets.so.12
[+] lws_create_context ( struct lws_context_creation_info* info ) 1
[+] lws_create_vhost ( struct lws_context* context, struct lws_context_creation_info* info ) 1
[+] lws_get_peer_write_allowance ( struct lws* wsi ) 1
[+] lws_get_socket_fd ( struct lws* wsi ) 1
[+] lws_get_ssl ( struct lws* wsi ) 1

to the top

Other Changes in Data Types 15

	Change	Effect
1	The member LWS_ADOPT_FLAG_UDP with value 16 has been added.	No effect.
2	The member LWS_ADOPT_RAW_SOCKET_UDP with value 18 has been added.	No effect.

	Change	Effect
1	The member LWS_CALLBACK_CLIENT_CLOSED with value 75 has been added.	No effect.
2	The member LWS_CALLBACK_EVENT_WAIT_CANCELLED with value 71 has been added.	No effect.
3	The member LWS_CALLBACK_TIMER with value 73 has been added.	No effect.
4	The member LWS_CALLBACK_VHOST_CERT_AGING with value 72 has been added.	No effect.
5	The member LWS_CALLBACK_VHOST_CERT_UPDATE with value 74 has been added.	No effect.

	Change	Effect
1	The member LWS_CLOSE_STATUS_CLIENT_TRANSACTION_DONE with value 2000 has been added.	No effect.

	Change	Effect
1	The member WSI_TOKEN_COLON_PROTOCOL with value 85 has been added.	No effect.
2	The member WSI_TOKEN_REPLAY_NONCE with value 84 has been added.	No effect.
3	The member WSI_TOKEN_X_AUTH_TOKEN with value 86 has been added.	No effect.
4	The member _WSI_TOKEN_CLIENT_ALPN with value 94 has been added.	No effect.

	Change	Effect
1	The member PENDING_TIMEOUT_CLIENT_CONN_IDLE with value 27 has been added.	No effect.
2	The member PENDING_TIMEOUT_LAGGING with value 28 has been added.	No effect.
3	The member PENDING_TIMEOUT_UDP_IDLE with value 26 has been added.	No effect.

libwebsockets.h
[+] enum lws_adoption_type 2
[+] enum lws_callback_reasons 5
[+] enum lws_close_status 1
[+] enum lws_token_indexes 4
[+] enum pending_timeout 3

to the top

Header Files 1

libwebsockets.h

to the top

Source Files 21

alloc.c
base64-decode.c
client-handshake.c
client.c
context.c
extension-permessage-deflate.c
extension.c
handshake.c
header.c
libwebsockets.c
lws-genhash.c
lws-plat-unix.c
lws-ring.c
lws-spa.c
output.c
parsers.c
pollfd.c
server.c
service.c
sha-1.c
ssl.c

to the top

Objects 1

libwebsockets.so.12

to the top