ABI 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. ABI - Application Binary Interface
  2. ==================================
  3. "ABI" describes the low-level interface between an application program and a
  4. library. Calling conventions, function arguments, return values, struct
  5. sizes/defines and more.
  6. [Wikipedia has a longer description](https://en.wikipedia.org/wiki/Application_binary_interface)
  7. Upgrades
  8. --------
  9. In the vast majority of all cases, a typical libcurl upgrade does not break
  10. the ABI at all. Your application can remain using libcurl just as before,
  11. only with less bugs and possibly with added new features. You need to read
  12. the release notes, and if they mention an ABI break/soname bump, you may have
  13. to verify that your application still builds fine and uses libcurl as it now
  14. is defined to work.
  15. Version Numbers
  16. ---------------
  17. In libcurl land, you really can't tell by the libcurl version number if that
  18. libcurl is binary compatible or not with another libcurl version.
  19. Soname Bumps
  20. ------------
  21. Whenever there are changes done to the library that will cause an ABI
  22. breakage, that may require your application to get attention or possibly be
  23. changed to adhere to new things, we will bump the soname. Then the library
  24. will get a different output name and thus can in fact be installed in
  25. parallel with an older installed lib (on most systems). Thus, old
  26. applications built against the previous ABI version will remain working and
  27. using the older lib, while newer applications build and use the newer one.
  28. During the first seven years of libcurl releases, there have only been four
  29. ABI breakages.
  30. We are determined to bump the SONAME as rarely as possible. Ideally, we
  31. never do it again.
  32. Downgrades
  33. ----------
  34. Going to an older libcurl version from one you're currently using can be a
  35. tricky thing. Mostly we add features and options to newer libcurls as that
  36. won't break ABI or hamper existing applications. This has the implication
  37. that going backwards may get you in a situation where you pick a libcurl that
  38. doesn't support the options your application needs. Or possibly you even
  39. downgrade so far so you cross an ABI break border and thus a different
  40. soname, and then your application may need to adapt to the modified ABI.
  41. History
  42. -------
  43. The previous major library soname number bumps (breaking backwards
  44. compatibility) have happened the following times:
  45. 0 - libcurl 7.1, August 2000
  46. 1 - libcurl 7.5 December 2000
  47. 2 - libcurl 7.7 March 2001
  48. 3 - libcurl 7.12.0 June 2004
  49. 4 - libcurl 7.16.0 October 2006