abidiff(1)

Absolut — det som “blir fel” här är att texten har **hårda radbrytningar mitt i meningar** (från HTML/terminal-wrap). Nedan får du en version där jag:

• tar bort “wrap-radbrytningar” i brödtext (varje stycke blir ett sammanhängande stycke)
• gör **en ren rad per flagga** och låter beskrivningen följa på egna rader utan konstiga brytningar
• lägger **exempel i `

  `** (där radbrytningar ska bevaras)

* använder tomrad mellan stycken/alternativ för bättre läsbarhet i MediaWiki Kopiera/klistra in som den är: --- == NAMN == '''abidiff''' – jämför ABI:er för ELF-filer '''abidiff''' jämför *Application Binary Interface* (ABI) för två delade bibliotek i ELF-format (*Executable and Linkable Format*). Den genererar en meningsfull rapport som beskriver skillnaderna mellan de två ABI:erna. Verktyget kan också jämföra textuella representationer av ABI:t för två ELF-binärer (som genereras av '''abidw'''), eller jämföra en ELF-binär mot en textuell representation av en annan ELF-binär. För en omfattande ABI-ändringsrapport mellan två inmatade delade bibliotek som inkluderar ändringar i funktioners och variablers undertyper använder '''abidiff''' som standard felsökningsinformation i DWARF-format, om sådan finns. Annars jämför den gränssnitt med felsökningsinformation i CTF- eller BTF-format, om sådan finns. Om ingen felsökningsinformation i dessa format hittas beaktas endast ELF-symboler och rapporten handlar då om att symboler lagts till eller tagits bort. Verktyget använder biblioteket '''libabigail''' för att analysera binären samt dess tillhörande felsökningsinformation. Här är det generella arbetssättet. När verktyget instrueras att göra det läses en binär och dess felsökningsinformation in och analyseras. För detta analyserar libabigail som standard beskrivningarna av de typer som är nåbara från gränssnitt (funktioner och variabler) som är synliga utanför sin översättningsenhet. När analysen är klar konstrueras en ABI-korpus genom att endast beakta den delmängd av typer som är nåbara från gränssnitt kopplade till ELF-symboler som är definierade och exporterade av binären. Det är denna slutliga ABI-korpus som libabigail betraktar som representerande ABI:t för den analyserade binären. Libabigail har sedan möjlighet att generera textuella representationer av ABI-korpusar, jämföra dem, analysera deras förändringar och rapportera om dem. == ANROP == '''abidiff''' [*alternativ*] <första-delade-bibliotek> <andra-delade-bibliotek> == MILJÖ == '''abidiff''' laddar två standardfiler med *undertryckningsspecifikationer* (*suppression specification files*), slår samman deras innehåll och använder det för att filtrera bort ABI-ändringsrapporter som kan uppfattas som falska positiva. '''Standardfil för systemomfattande undertryckningsspecifikation''' Den hittas via den valfria miljövariabeln '''LIBABIGAIL_DEFAULT_SYSTEM_SUPPRESSION_FILE'''. Om den inte är satt försöker abidiff läsa filen '''$libdir/libabigail/libabigail-default.abignore'''. Om filen inte finns laddas ingen systemomfattande standardfil. '''Standardfil för användarundertryckningsspecifikation''' Den hittas via den valfria miljövariabeln '''LIBABIGAIL_DEFAULT_USER_SUPPRESSION_FILE'''. Om den inte är satt försöker abidiff läsa filen '''$HOME/.abignore'''. Om filen inte finns laddas ingen användarstandardfil. == ALTERNATIV == '''--add-binaries1''' <bin1,bin2,bin3,..> För varje kommaseparerad binär som anges: om binären hittas i katalogen som anges med '''--added-binaries-dir1''' så läser '''abidiff''' in ABI-korpusen för binären och lägger till den i en uppsättning korpusar (en *ABI Corpus Group*) som inkluderar första argumentet till '''abidiff'''. Denna ABI-korpusgrupp jämförs sedan mot den andra korpusgruppen som anges som argument till '''abidiff'''. '''--add-binaries2''' <bin1,bin2,bin3,..> Som '''--add-binaries1''', men lägger till binärer i gruppen som inkluderar andra argumentet till '''abidiff'''. Denna grupp jämförs sedan mot den första gruppen. '''--added-binaries-dir1''', '''--abd1''' <katalog-1> Används tillsammans med '''--add-binaries1''', '''--follow-dependencies''' och '''--list-dependencies'''. Binärer som refereras av dessa alternativ och som hittas i katalog-1 läses in som ABI-korpus och läggs till i första ABI-korpusgruppen. '''--added-binaries-dir2''', '''--abd2''' <katalog-2> Som '''--added-binaries-dir1''', men för andra ABI-korpusgruppen. '''--added-fns''' Visa endast globalt definierade funktioner som lades till i <andra-delade-bibliotek>. '''--added-vars''' Visa endast globala variabler som lades till (definierades) i <andra-delade-bibliotek>. '''--allow-non-exported-interfaces''' När verktyget analyserar felsökningsinformation analyseras typer nåbara från gränssnitt synliga utanför sin översättningsenhet. Därefter byggs en ABI-korpus av typer nåbara från gränssnitt kopplade till definierade och exporterade ELF-symboler, och det är dessa ABI-korpusar som jämförs. Detta kan bli mycket data (och långsamt) för applikationer, t.ex. Linux-kärnan. För “normalstora” binärer kan man ofta analysera alla synliga gränssnitt genom att använda detta alternativ. Observera att detta alternativ är aktiverat som standard, utom när Linux-kärnan analyseras. '''--btf''' Vid jämförelse av binärer: extrahera ABI-information från BTF-felsökningsinformation, om sådan finns. '''--changed-fns''' Visa endast ändringar i undertyper för globalt definierade funktioner i <första-delade-bibliotek>. '''--changed-vars''' Visa endast ändringar i undertyper för globalt definierade variabler i <första-delade-bibliotek>. '''--ctf''' Vid jämförelse av binärer: extrahera ABI-information från CTF-felsökningsinformation, om sådan finns. '''--debug-info-dir1''', '''--d1''' <di-sökväg1> Om felsökningsinformation för <första-delade-bibliotek> ligger i en separat fil anger detta var abidiff ska hitta den filen. di-sökväg måste peka på rotkatalogen under vilken felsökningsinformationen ligger i en trädstruktur (på Red Hat-baserade system ofta <root>/usr/lib/debug). Alternativet kan anges flera gånger med olika rotkataloger; då letar abidiff i alla dessa. '''--debug-info-dir2''', '''--d2''' <di-sökväg2> Som '''--debug-info-dir1''', men för <andra-delade-bibliotek>. '''--debug-self-comparison''' Felsökningsläge som kan abortera körningen om avvikelser upptäcks när en binär jämförs med sig själv. Avsett för felsökning i debugger. Kräver att libabigail byggts med --enable-debug-self-comparison. '''--debug-tc''' Felsökningsläge som granskar typkanonisering: varje typjämförelse görs både strukturellt och kanoniskt och resultaten måste matcha, annars aborteras körningen. Kräver --enable-debug-type-canonicalization. '''--deleted-fns''' Visa endast globalt definierade funktioner som togs bort från <första-delade-bibliotek>. '''--deleted-vars''' Visa endast globalt definierade variabler som togs bort från <första-delade-bibliotek>. '''--drop''' <regex> Vid inläsning av ELF-filerna: uteslut globalt definierade funktioner och variabler vars namn matchar regex. Då rapporteras inga ändringar som involverar dessa. '''--drop-fn''' <regex> Som '''--drop''', men endast funktioner. '''--drop-var''' <regex> Som '''--drop''', men endast variabler. '''--drop-private-types''' Används med '''--headers-dir1''', '''--headers-dir2''', '''--header-file1''' och '''--header-file2'''. Med detta alternativ tas typer som INTE är definierade i publika headers bort helt ur libabigails interna ABI-representation, så de behöver inte filtreras bort senare. Detta kan minska minnesåtgången. '''--dump-diff-tree''' Efter diff-rapporten: skriv en textuell representation av diff-nodträdet (felsökningssyfte) till felutmatningen. Relevant endast för funktioner/variabler som har undertypsändringar. '''--exported-interfaces-only''' För att minska mängden data kan detta alternativ begränsa analysen till typer som är nåbara från gränssnitt kopplade till definierade och exporterade ELF-symboler. Detta är aktiverat som standard för Linux-kärnan, annars avstängt som standard. '''--fail-no-debug-info''' Om ingen felsökningsinformation hittas: avsluta med fel. Utan detta alternativ försöker programmet jämföra icke-debug-relaterade egenskaper (t.ex. rena ELF-egenskaper). '''--follow-dependencies''', '''--fdeps''' Konstruera ABI-korpusar även för beroenden som hittas via '''--added-binaries-dir1''' respektive '''--added-binaries-dir2''', och jämför sedan de två uppsättningarna (inmatning + beroenden). '''--harmless''' Visa endast ofarliga (*harmless*) ändringar. Som standard filtreras ofarliga ändringar bort för att göra rapporten mindre rörig. '''--headers-dir1''', '''--hd1''' <headers-katalog-1> Anger var publika headers för första biblioteket finns. ABI-ändringar för typer som inte definieras i publika headers filtreras bort. Kan anges flera gånger. <pre> $ abidiff --headers-dir1 /some/path \ --headers-dir1 /some/other/path \ binary-version-1 binary-version-2

--headers-dir2, --hd2 <headers-katalog-2> Som --headers-dir1, men för andra biblioteket. Kan anges flera gånger.

--header-file1, --hf1 <header-fil-1> Anger en publik headerfil för första biblioteket.

--header-file2, --hf2 <header-fil-2> Anger en publik headerfil för andra biblioteket.

--help, -h Visa kort hjälp och avsluta.

--ignore-soname Ignorera skillnader i SONAME.

--impacted-interfaces Vid visning av leaf-ändringar: visa lista över påverkade gränssnitt. Används tillsammans med --leaf-changes-only, annars ignoreras det.

--keep <regex> Behåll endast globalt definierade funktioner/variabler vars namn matchar regex. Alla andra utesluts och syns inte i rapporten.

--keep-fn <regex> Som --keep, men endast funktioner.

--keep-var <regex> Som --keep, men endast variabler.

--kmi-whitelist, -w <vitlista> Vid analys av Linux-kärnans binär: vitlista ELF-symbolnamn för funktioner/variabler vars gränssnitt ska beaktas (KMI). Om ingen vitlista anges beaktas hela KMI:t.

--leaf-changes-only, -l Visa endast leaf-ändringar (ingen konsekvens-/påverkansanalys). Detta alternativ implicerar --redundant.

Typisk utdata:

$ abidiff libtest-v0.so libtest-v1.so
Functions changes summary: 0 Removed, 1 Changed, 0 Added function
Variables changes summary: 0 Removed, 0 Changed, 0 Added variable

1 function with some indirect sub-type change:

  [C]'function void fn(C&)' at test-v1.cc:13:1 has some indirect sub-type changes:
    parameter 1 of type 'C&' has sub-type changes:
      in referenced type 'struct C' at test-v1.cc:7:1:
        type size hasn't changed
        1 data member change:
         type of 'leaf* C::m0' changed:
           in pointed to type 'struct leaf' at test-v1.cc:1:1:
             type size changed from 32 to 64 bits
             1 data member insertion:
               'char leaf::m1', at offset 32 (in bits) at test-v1.cc:4:1
$

Med leaf-läge:

$ abidiff -l libtest-v0.so libtest-v1.so
'struct leaf' changed:
  type size changed from 32 to 64 bits
  1 data member insertion:
    'char leaf::m1', at offset 32 (in bits) at test-v1.cc:4:1

  one impacted interface:
    function void fn(C&)
$

--list-dependencies, --ldeps Lista alla beroenden till indataargumenten som hittas i katalogerna angivna med --added-binaries-dir1 och --added-binaries-dir2.

--no-added-syms Visa inte tillagda funktioner/variabler och inte heller deras ELF-symboler. Andra ändringar visas om de inte stoppas av andra alternativ.

--no-assume-odr-for-cplusplus Inaktivera antagandet om *One Definition Rule* (ODR) vid analys av C++ med DWARF; libabigail jämför då faktiskt typer med samma namn istället för att anta att de är lika.

--no-architecture Ta inte hänsyn till arkitektur vid ABI-jämförelse.

--no-change-categorization, -x Inaktivera kategorisering (harmless/harmful). Eftersom kategorisering krävs för filtrering stänger detta även av filtrering. Användbart för stora ändringsgrafer och tillsammans med --leaf-changes-only.

--no-corpus-path Skriv inte ut path-attributet för ABI-korpusen.

--no-default-suppression Ladda inte standardfilerna för undertryckningar.

--no-harmful Visa inte skadliga (*harmful*) ändringar. Som standard visas annars endast skadliga ändringar.

--no-leverage-dwarf-factorization Inaktivera optimeringar som används när DWARF har faktoriserats med DWZ.

--no-linkage-name Visa inte länk-namn (*linkage names*) för tillagda/borttagna/ändrade symboler.

--no-linux-kernel-mode Behandla Linux-kärnans binärer som vanliga ELF-binärer och använd ELF-exportlogik istället för __ksymtab/__ksymtab_gpl.

--no-redundant Visa INTE redundanta ändringar (aktiverat som standard).

--no-show-locs Visa inte var i det andra biblioteket respektive typ ändrades.

--no-show-relative-offset-changes Visa inte hur många bitar en offset flyttats (visa bara gamla och nya offset).

--no-unreferenced-symbols Visa inte ändringar för symboler som inte refereras av någon felsökningsinformation (för dessa visas annars endast tillägg/borttagning).

--non-reachable-types, -t Analysera och rapportera även typer som inte är nåbara från globala funktioner/variabler. Kan påverka prestanda kraftigt, men kan begränsas med headers/suppressions.

--redundant Visa redundanta ändringar.

--show-bits Visa storlekar och offset i bitar (standard).

--show-bytes Visa storlekar och offset i byte.

--show-dec Visa i decimal form (standard).

--show-hex Visa i hexadecimal form.

--stat Visa endast sammanfattande statistik istället för detaljerad diff.

--stats Skriv ut intern statistik.

--suppressions, --suppr <suppressions-fil> Använd undertryckningsfil. Kan anges flera gånger; då används alla. Om detta inte anges laddas standardfiler.

--symtabs Visa endast symboltabellerna för första och andra biblioteket.

--verbose Skriv ut utförliga loggar.

--version, -v Visa programversion och avsluta.

RETURVÄRDEN

Returkoden är 0 om ABI:erna är lika, annars icke-noll om de skiljer sig eller om ett fel inträffade.

Vid icke-noll är returkoden ett 8-bitars bitfält där varje bit har en betydelse:

• 1 – ABIDIFF_ERROR – ett fel inträffade
• 2 – ABIDIFF_USAGE_ERROR – fel i hur kommandot anropades (okänd flagga, fel antal argument, osv.); om denna bit är satt måste även ABIDIFF_ERROR vara satt
• 4 – ABIDIFF_ABI_CHANGE – ABI:erna skiljer sig
• 8 – ABIDIFF_ABI_INCOMPATIBLE_CHANGE – ABI:erna skiljer sig på ett inkompatibelt sätt; om denna bit är satt måste även ABIDIFF_ABI_CHANGE vara satt

För närvarande finns bara några få typer av ABI-ändringar som alltid sätter ABIDIFF_ABI_INCOMPATIBLE_CHANGE:

• borttagning av symbol för en funktion/variabel som varit definierad och exporterad
• ändring av index för en medlem i en virtuell funktionstabell (C++)

Övriga bitar används inte för närvarande.

EXEMPEL

1. Upptäcka ABI-ändring i en undertyp till en funktion:

$ cat -n test-v0.cc
         1      // Compile this with:
         2      //   g++ -g -Wall -shared -o libtest-v0.so test-v0.cc
         3
         4      struct S0
         5      {
         6        int m0;
         7      };
         8
         9      void
        10      foo(S0* /*parameter_name*/)
        11      {
        12        // do something with parameter_name.
        13      }
$
$ cat -n test-v1.cc
         1      // Compile this with:
         2      //   g++ -g -Wall -shared -o libtest-v1.so test-v1.cc
         3
         4      struct type_base
         5      {
         6        int inserted;
         7      };
         8
         9      struct S0 : public type_base
        10      {
        11        int m0;
        12      };
        13
        14      void
        15      foo(S0* /*parameter_name*/)
        16      {
        17        // do something with parameter_name.
        18      }
$
$ g++ -g -Wall -shared -o libtest-v0.so test-v0.cc
$ g++ -g -Wall -shared -o libtest-v1.so test-v1.cc
$
$ abidiff libtest-v0.so libtest-v1.so; echo "exit code: $?"
Functions changes summary: 0 Removed, 1 Changed, 0 Added function
Variables changes summary: 0 Removed, 0 Changed, 0 Added variable

1 function with some indirect sub-type change:

  [C]'function void foo(S0*)' has some indirect sub-type changes:
        parameter 0 of type 'S0*' has sub-type changes:
          in pointed to type 'struct S0':
            size changed from 32 to 64 bits
            1 base class insertion:
              struct type_base
            1 data member change:
             'int S0::m0' offset changed from 0 to 32
exit code: 4
$

Observera att returkoden 4 betyder att tredje biten (ABIDIFF_ABI_CHANGE, värde 4) är satt. Detta betyder att verktyget kategoriserar ändringen som skadlig (*harmful*) och att användargranskning krävs.

2. Upptäcka inkompatibel ABI-ändring i typ för en funktion:

$ cat -n test-v0.cc
     1  // Compile this with:
     2  //   g++ -g -Wall -shared -o libtest-v0.so test-v0.cc
     3
     4  struct S0
     5  {
     6    int m0;
     7  };
     8
     9  S0
    10  foo()
    11  {
    12    S0 s = {};
    13    return s;
    14  }
$
$ cat -n test-v1.cc
     1  // Compile this with:
     2  //   g++ -g -Wall -shared -o libtest-v1.so test-v1.cc
     3
     4  struct type_base
     5  {
     6    int inserted;
     7  };
     8
     9  struct S0 : public type_base
    10  {
    11    int m0;
    12  };
    13
    14  S0
    15  foo()
    16  {
    17    S0 s = {};
    18    return s;
    19  }
$
$ g++ -g -Wall -shared -o libtest-v0.so test-v0.cc
$ g++ -g -Wall -shared -o libtest-v1.so test-v1.cc
$
$ abidiff libtest-v0.so libtest-v1.so; echo "exit code: $?"
Functions changes summary: 0 Removed, 1 Changed, 0 Added function
Variables changes summary: 0 Removed, 0 Changed, 0 Added variable

1 function with incompatible sub-type changes:

  [C] 'function S0 foo(void)' at test-v0.cc:10:1 has some sub-type changes:
    return type changed:
      type size changed from 32 to 64 (in bits)
      1 base class insertion:
        struct type_base at test-v1.cc:4:1
      1 data member change:
        'int m0' offset changed from 0 to 32 (in bits) (by +32 bits)

exit code: 12
$

Observera att returkoden 12 betyder att både bit 4 (ABIDIFF_ABI_CHANGE) och bit 8 (ABIDIFF_ABI_INCOMPATIBLE_CHANGE) är satta. Detta innebär ett ABI-brott.

3. Upptäcka en annan ändring i en undertyp:

$ cat -n test-v0.cc
         1      // Compile this with:
         2      //   g++ -g -Wall -shared -o libtest-v0.so test-v0.cc
         3
         4      struct S0
         5      {
         6        int m0;
         7      };
         8
         9      void
        10      foo(S0& /*parameter_name*/)
        11      {
        12        // do something with parameter_name.
        13      }
$
$ cat -n test-v1.cc
         1      // Compile this with:
         2      //   g++ -g -Wall -shared -o libtest-v1.so test-v1.cc
         3
         4      struct S0
         5      {
         6        char inserted_member;
         7        int m0;
         8      };
         9
        10      void
        11      foo(S0& /*parameter_name*/)
        12      {
        13        // do something with parameter_name.
        14      }
$
$ g++ -g -Wall -shared -o libtest-v0.so test-v0.cc
$ g++ -g -Wall -shared -o libtest-v1.so test-v1.cc
$
$ abidiff libtest-v0.so libtest-v1.so; echo "exit code: $?"
Functions changes summary: 0 Removed, 1 Changed, 0 Added function
Variables changes summary: 0 Removed, 0 Changed, 0 Added variable

1 function with some indirect sub-type change:

  [C]'function void foo(S0&)' has some indirect sub-type changes:
        parameter 0 of type 'S0&' has sub-type changes:
          in referenced type 'struct S0':
            size changed from 32 to 64 bits
            1 data member insertion:
              'char S0::inserted_member', at offset 0 (in bits)
            1 data member change:
             'int S0::m0' offset changed from 0 to 32

exit code: 4
$

4. Upptäcka borttagna och tillagda funktioner:

$ cat -n test-v0.cc
         1      // Compile this with:
         2      //   g++ -g -Wall -shared -o libtest-v0.so test-v0.cc
         3
         4      struct S0
         5      {
         6        int m0;
         7      };
         8
         9      void
        10      foo(S0& /*parameter_name*/)
        11      {
        12        // do something with parameter_name.
        13      }
$
$ cat -n test-v1.cc
         1      // Compile this with:
         2      //   g++ -g -Wall -shared -o libtest-v1.so test-v1.cc
         3
         4      struct S0
         5      {
         6        char inserted_member;
         7        int m0;
         8      };
         9
        10      void
        11      bar(S0& /*parameter_name*/)
        12      {
        13        // do something with parameter_name.
        14      }
$
$ g++ -g -Wall -shared -o libtest-v0.so test-v0.cc
$ g++ -g -Wall -shared -o libtest-v1.so test-v1.cc
$
$ abidiff libtest-v0.so libtest-v1.so; echo "exit code: $?"
Functions changes summary: 1 Removed, 0 Changed, 1 Added functions
Variables changes summary: 0 Removed, 0 Changed, 0 Added variable

1 Removed function:
  'function void foo(S0&)'    {_Z3fooR2S0}

1 Added function:
  'function void bar(S0&)'    {_Z3barR2S0}

exit code: 12
$

5. Jämföra två uppsättningar binärer som anges på kommandoraden:

$ abidiff --add-binaries1=file2-v1              \
          --add-binaries2=file2-v2,file2-v1     \
          --added-binaries-dir1 dir1            \
          --added-binaries-dir2 dir2            \
          file1-v1 file1-v2

Observera att filerna file2-v1 och file2-v2 ska finnas i dir1 respektive dir2 eller i aktuell katalog.

6. Jämföra två bibliotek och deras beroenden:

$ abidiff --follow-dependencies                      \
          --added-binaries-dir1 /some/where          \
          --added-binaries-dir2 /some/where/else     \
          foo bar

Detta jämför uppsättningen binärer som består av foo och dess beroenden mot uppsättningen binärer som består av bar och dess beroenden.

UPPHOV

Dodji Seketeli

COPYRIGHT

2014–2025, Red Hat, Inc.

COLOFON

Denna sida är en del av projektet libabigail (*ABI Generic Analysis and Instrumentation Library*). Information om projektet finns på [1](https://sourceware.org/libabigail/).

Felrapporter för denna manualsida hänvisas till [2](https://sourceware.org/bugzilla/enter_bug.cgi?product=libabigail).

Sidan hämtades från projektets upstream Git-förråd (git://sourceware.org/git/libabigail.git) den 11 augusti 2025. Vid den tidpunkten var datumet för den senaste committen som hittades i förrådet 28 juli 2025.

Om du upptäcker renderingsproblem i HTML-versionen, om du anser att det finns en bättre eller mer uppdaterad källa, eller om du har korrigeringar/förbättringar för denna COLOFON (som inte är del av originalmanualen), skicka e-post till [man-pages@man7.org](mailto:man-pages@man7.org).