libwiretap: 2.1.8 to 3.0.0 compatibility report

Test Info

Library Name	libwiretap
Version #1	2.1.8
Version #2	3.0.0
CPU Type	x86_64
GCC Version	4.6
Subject	Binary Compatibility

Test Results

Total Header Files	56
Total Shared Libraries	1
Total Symbols / Types	75 / 106
Verdict	Incompatible (22%)

Problem Summary

	Severity	Count
Added Symbols	-	3
Removed Symbols	High	3
Problems with Data Types	High	0
	Medium	3
	Low	7
Problems with Symbols	High	3
	Medium	1
	Low	4
Problems with Constants	Low	2

Added Symbols (3)

pcap-encap.h, libwiretap.so.3.0.0
wtap_encap_requires_phdr ( int encap )

wtap.h, libwiretap.so.3.0.0
wtap_dump_can_write ( GArray const* file_encaps, guint32 required_comment_types )
wtap_dump_supports_comment_types ( int filetype, guint32 comment_types )

to the top

Removed Symbols (3)

wtap.h, libwiretap.so.2.1.8
wtap_dump_can_write_encap ( int filetype, int encap )
wtap_dump_can_write_encaps ( int ft, GArray const* file_encaps )
wtap_pseudoheader ( wtap* wth )

to the top

Problems with Symbols, High Severity (3)

	Change	Effect
1	3rd parameter p3 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	Middle parameter p4 of type guint8 const* 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	3rd middle parameter pseudo_header 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.

wtap.h, libwiretap.so.2.1.8
[+] wtap_dump ( wtap_dumper* p1, wtap_pkthdr const* p2, wtap_pseudo_header const* pseudo_header, guint8 const* p4, int* err ) (3)

to the top

Problems with Data Types, Medium Severity (3)

	Change	Effect
1	Size of field phdr has been changed from 64 bytes to 208 bytes.	Previous accesses of applications and library functions to this field may be broken.
2	Field pseudo_header has been removed from this type.	Applications will access incorrect memory when attempting to access this field.

	Change	Effect
1	Field supported_comment_types 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.

wtap-int.h
[+] struct wtap (2)

wtap.h
[+] struct file_type_info (1)

to the top

Problems with Symbols, Medium Severity (1)

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

wtap.h, libwiretap.so.2.1.8
[+] wtap_get_savable_file_types ( int file_type, GArray const* file_encaps ) (1)

to the top

Problems with Data Types, Low Severity (7)

	Change	Effect
1	Base type has been changed from *gboolean()(wtap,gint64,wtap_pseudo_header,guint8,int,int,char) to *gboolean()(wtap,gint64,wtap_pkthdr,guint8,int,int,char).	Possible incorrect initialization of parameters by applications.

	Change	Effect
1	Base type has been changed from gboolean()(wtap_dumper,wtap_pkthdr const,wtap_pseudo_header const,guint8 const,int) to gboolean()(wtap_dumper,wtap_pkthdr const,guint8 const,int*).	Possible incorrect initialization of parameters by applications.

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

	Change	Effect
1	Field pseudo_header has been added to this type.	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 208 bytes.	The fields or parameters of such data type may be incorrectly initialized or accessed by old client applications.

	Change	Effect
1	Field shb_user_appl became const.	The value of this field expected to be const in new library version, but can be modified by old applications.
2	Type of field shb_user_appl has been changed from gchar* to gchar const*.	Replacement of the field data type may indicate a change in the semantic meaning of the field.

wtap-int.h
[+] typedef subtype_seek_read_func (1)
[+] typedef subtype_write_func (1)

wtap.h
[+] struct file_type_info (1)
[+] struct wtap_pkthdr (2)
[+] struct wtapng_section_s (2)

to the top

Problems with Symbols, Low Severity (4)

	Change	Effect
1	Type of 1st parameter name has been changed from char* to char const*.	Replacement of parameter data type may indicate a change in its semantic meaning.
2	Type of 2nd parameter short_name has been changed from char* to char const*.	Replacement of parameter data type may indicate a change in its semantic meaning.

	Change	Effect
1	3rd parameter pseudo_header has been renamed to phdr.	Renaming of a parameter may indicate a change in its semantic meaning.
2	Base type of 3rd parameter pseudo_header has been changed from wtap_pseudo_header (144 bytes) to wtap_pkthdr (208 bytes).	Memory stored by pointer may be incorrectly initialized by applications.

wtap.h, libwiretap.so.2.1.8
[+] wtap_register_encap_type ( char* name, char* short_name ) (2)
[+] wtap_seek_read ( wtap* wth, gint64 seek_off, wtap_pseudo_header* pseudo_header, guint8* pd, int len, int* err, gchar** err_info ) (2)

to the top

Problems with Constants (2)

	Change	Effect
1	The value of constant WTAP_ERR_DECOMPRESS has been changed from -21 to -22.	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 WTAP_ERR_INTERNAL has been changed from -22 to -23.	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.

wtap.h
[+] WTAP_ERR_DECOMPRESS
[+] WTAP_ERR_INTERNAL

to the top

Header Files (56)

5views.h
aethra.h
airopeek9.h
ascend-int.h
ascend.h
ascend_scanner_lex.h
ascendtext.h
atm.h
ber.h
btsnoop.h
buffer.h
catapult_dct2000.h
commview.h
cosine.h
csids.h
daintree-sna.h
dbs-etherwatch.h
dct3trace.h
erf.h
etherpeek.h
eyesdn.h
file_wrappers.h
hcidump.h
i4b_trace.h
i4btrace.h
ipfix.h
iptrace.h
iseries.h
k12.h
k12text_lex.h
lanalyzer.h
libpcap.h
mime_file.h
mp2t.h
mpeg.h
netmon.h
netscaler.h
netscreen.h
nettl.h
network_instruments.h
netxray.h
ngsniffer.h
packetlogger.h
pcap-common.h
pcap-encap.h
pcapng.h
pppdump.h
radcom.h
snoop.h
tnef.h
toshiba.h
visual.h
vms.h
vwr.h
wtap-int.h
wtap.h

to the top

Shared Libraries (1)

libwiretap.so.2.1.8

to the top

Test Info

Library Name	libwiretap
Version #1	2.1.8
Version #2	3.0.0
CPU Type	x86_64
GCC Version	4.6
Subject	Source Compatibility

Test Results

Total Header Files	56
Total Shared Libraries	1
Total Symbols / Types	196 / 149
Verdict	Incompatible (49%)

Problem Summary

	Severity	Count
Added Symbols	-	7
Removed Symbols	High	6
Problems with Data Types	High	1
	Medium	1
	Low	2
Problems with Symbols	High	3
	Medium	3
	Low	4
Problems with Constants	Low	2
Other Changes in Data Types	-	7
Other Changes in Symbols	-	2

Added Symbols (7)

camins.h
camins_open ( wtap* wth, int* err, gchar** err_info )

pcap-encap.h
wtap_encap_requires_phdr ( int encap )

peekclassic.h
peekclassic_open ( wtap* wth, int* err, gchar** err_info )

peektagged.h
peektagged_open ( wtap* wth, int* err, gchar** err_info )

wtap-int.h
wtap_dump_file_tell ( wtap_dumper* wdh, int* err )

wtap.h
wtap_dump_can_write ( GArray const* file_encaps, guint32 required_comment_types )
wtap_dump_supports_comment_types ( int filetype, guint32 comment_types )

to the top

Removed Symbols (6)

airopeek9.h
airopeek9_open ( wtap* wth, int* err, gchar** err_info )

etherpeek.h
etherpeek_open ( wtap* wth, int* err, gchar** err_info )

wtap-int.h
wtap_dump_file_tell ( wtap_dumper* wdh )

wtap.h
wtap_dump_can_write_encap ( int filetype, int encap )
wtap_dump_can_write_encaps ( int ft, GArray const* file_encaps )
wtap_pseudoheader ( wtap* wth )

to the top

Problems with Data Types, High Severity (1)

	Change	Effect
1	Field pseudo_header has been removed from this type.	Recompilation of a client program may be broken with the error message: 'struct wtap' has no member named 'pseudo_header'.

wtap-int.h
[+] struct wtap (1)

to the top

Problems with Symbols, High Severity (3)

	Change	Effect
1	3rd parameter p3 has been added to the calling stack at the middle position.	Recompilation of a client program may be broken.
2	Middle parameter p4 of type guint8 const* has been removed from the calling stack.	Recompilation of a client program may be broken.
3	3rd middle parameter pseudo_header has been removed from the calling stack.	Recompilation of a client program may be broken.

wtap.h
[+] wtap_dump ( wtap_dumper* p1, wtap_pkthdr const* p2, wtap_pseudo_header const* pseudo_header, guint8 const* p4, int* err ) (3)

to the top

Problems with Data Types, Medium Severity (1)

	Change	Effect
1	Field shb_user_appl became const.	Recompilation of a client program may be broken with the error message: assignment of read-only member/location 'wtapng_section_s::shb_user_appl'.

wtap.h
[+] struct wtapng_section_s (1)

to the top

Problems with Symbols, Medium Severity (3)

	Change	Effect
1	Parameters list has been changed.	Recompilation of a client program may be broken.

	Change	Effect
1	Parameter required_comment_types of type guint32 has been added to the calling stack.	Recompilation of a client program may be broken.

	Change	Effect
1	Base type of parameter pseudo_header has been changed from wtap_pseudo_header to wtap_pkthdr of different format.	Recompilation of a client program may be broken.

wtap-int.h
[+] wtap_dump_file_tell ( wtap_dumper* wdh ) (1)

wtap.h
[+] wtap_get_savable_file_types ( int file_type, GArray const* file_encaps ) (1)
[+] wtap_seek_read ( wtap* wth, gint64 seek_off, wtap_pseudo_header* pseudo_header, guint8* pd, int len, int* err, gchar** err_info ) (1)

to the top

Problems with Data Types, Low Severity (2)

	Change	Effect
1	Base type has been changed from *gboolean()(wtap,gint64,wtap_pseudo_header,guint8,int,int,char) to *gboolean()(wtap,gint64,wtap_pkthdr,guint8,int,int,char).	Recompilation of a client program may be broken.

	Change	Effect
1	Base type has been changed from gboolean()(wtap_dumper,wtap_pkthdr const,wtap_pseudo_header const,guint8 const,int) to gboolean()(wtap_dumper,wtap_pkthdr const,guint8 const,int*).	Recompilation of a client program may be broken.

wtap-int.h
[+] typedef subtype_seek_read_func (1)
[+] typedef subtype_write_func (1)

to the top

Problems with Symbols, Low Severity (4)

	Change	Effect
1	Type of 3rd parameter len has been changed from unsigned int to guint.	Recompilation of a client program may be broken.
2	Type of return value has been changed from unsigned int to guint.	Recompilation of a client program may be broken.

	Change	Effect
1	Type of 1st parameter name has been changed from char* to char const*.	Recompilation of a client program may be broken.
2	Type of 2nd parameter short_name has been changed from char* to char const*.	Recompilation of a client program may be broken.

file_wrappers.h
[+] gzwfile_write ( GZWFILE_T state, void const* buf, unsigned int len ) (2)

wtap.h
[+] wtap_register_encap_type ( char* name, char* short_name ) (2)

to the top

Problems with Constants (2)

	Change	Effect
1	The value of constant WTAP_ERR_DECOMPRESS has been changed from -21 to -22.	Recompilation of a client program may be broken.

	Change	Effect
1	The value of constant WTAP_ERR_INTERNAL has been changed from -22 to -23.	Recompilation of a client program may be broken.

wtap.h
[+] WTAP_ERR_DECOMPRESS
[+] WTAP_ERR_INTERNAL

to the top

Other Changes in Data Types (7)

	Change	Effect
1	Field supported_comment_types has been added to this type.	No effect.

	Change	Effect
1	Field decrypted has been added to this type.	No effect.

	Change	Effect
1	Field data_offset has been added to this type.	No effect.
2	Field dst_vmname_len_offset has been added to this type.	No effect.
3	Field src_vmname_len_offset has been added to this type.	No effect.

	Change	Effect
1	Field pseudo_header has been added to this type.	No effect.

	Change	Effect
1	Field nokia has been added to this type.	No effect.

wtap.h
[+] struct file_type_info (1)
[+] struct ieee_802_11_phdr (1)
[+] struct nstr_phdr (3)
[+] struct wtap_pkthdr (1)
[+] union wtap_pseudo_header (1)

to the top

Other Changes in Symbols (2)

	Change	Effect
1	2nd parameter random has been renamed to random_flag.	No effect.

	Change	Effect
1	3rd parameter pseudo_header has been renamed to phdr.	No effect.

file_wrappers.h
[+] file_set_random_access ( FILE_T stream, gboolean random, GPtrArray* seek ) (1)

wtap.h
[+] wtap_seek_read ( wtap* wth, gint64 seek_off, wtap_pseudo_header* pseudo_header, guint8* pd, int len, int* err, gchar** err_info ) (1)

to the top

Header Files (56)

to the top

Shared Libraries (1)

libwiretap.so.2.1.8

to the top

API compatibility report for the libwiretap library between 2.1.8 and 3.0.0 versions on x86_64

Test Info

Test Results

Problem Summary

Added Symbols (3)

Removed Symbols (3)

Problems with Symbols, High Severity (3)

Problems with Data Types, Medium Severity (3)

Problems with Symbols, Medium Severity (1)

Problems with Data Types, Low Severity (7)

Problems with Symbols, Low Severity (4)

Problems with Constants (2)

Header Files (56)

Shared Libraries (1)

Test Info

Test Results

Problem Summary

Added Symbols (7)

Removed Symbols (6)

Problems with Data Types, High Severity (1)

Problems with Symbols, High Severity (3)

Problems with Data Types, Medium Severity (1)

Problems with Symbols, Medium Severity (3)

Problems with Data Types, Low Severity (2)

Problems with Symbols, Low Severity (4)

Problems with Constants (2)

Other Changes in Data Types (7)

Other Changes in Symbols (2)

Header Files (56)

Shared Libraries (1)