From 407cc21c32f1a867ca31beef45c51bf032328789 Mon Sep 17 00:00:00 2001
From: Kevin Enderby <enderby@apple.com>
Date: Thu, 17 Jul 2014 22:47:16 +0000
Subject: [PATCH] Add printing of Mach-O stabs in llvm-nm.

llvm-svn: 213327
---
 llvm/include/llvm/Support/MachO.h                  |   4 +-
 llvm/test/Object/Inputs/macho-hello-g.macho-x86_64 | Bin 0 -> 8680 bytes
 llvm/test/Object/nm-trivial-object.test            |  15 ++++
 llvm/tools/llvm-nm/llvm-nm.cpp                     |  86 ++++++++++++++++++++-
 4 files changed, 103 insertions(+), 2 deletions(-)
 create mode 100755 llvm/test/Object/Inputs/macho-hello-g.macho-x86_64

diff --git a/llvm/include/llvm/Support/MachO.h b/llvm/include/llvm/Support/MachO.h
index bd4dc2f..57d7dff 100644
--- a/llvm/include/llvm/Support/MachO.h
+++ b/llvm/include/llvm/Support/MachO.h
@@ -386,13 +386,15 @@ namespace llvm {
 
     enum StabType {
       // Constant values for the "n_type" field in llvm::MachO::nlist and
-      // llvm::MachO::nlist_64 when "(n_type & NlistMaskStab) != 0"
+      // llvm::MachO::nlist_64 when "(n_type & N_STAB) != 0"
       N_GSYM    = 0x20u,
       N_FNAME   = 0x22u,
       N_FUN     = 0x24u,
       N_STSYM   = 0x26u,
       N_LCSYM   = 0x28u,
       N_BNSYM   = 0x2Eu,
+      N_PC      = 0x30u,
+      N_AST     = 0x32u,
       N_OPT     = 0x3Cu,
       N_RSYM    = 0x40u,
       N_SLINE   = 0x44u,
diff --git a/llvm/test/Object/Inputs/macho-hello-g.macho-x86_64 b/llvm/test/Object/Inputs/macho-hello-g.macho-x86_64
new file mode 100755
index 0000000000000000000000000000000000000000..41be03a0e2af2b39ede668c9860d8d70ee67b182
GIT binary patch
literal 8680
zcmeHNO=uHA6rQzetF1N#5B{?iD^;QCK|#<%S{mG9(bl#iLK%~0YXY03BpXfDLZN!d
zq1wCP#fulgt2aTx-aLvIPbv`<JW3Jc_ibj|Nm{*&^WbInd+*JgH{Z@evM+B}zx`?z
z!fFv>VT%wVLft0BePQEDh<#88D&^?F`S`W?<x8|Siq!}=Ma<KS1*DvaU!7<S3FdQQ
zT@*%b0_BM9$|t4omi_g>=6wB~*bLlfRS5Cc^>Bg(9ZFgBOUdGzsX3pg@`dY%IGoU?
z@`e6-KACpCS+{_o=6t@&w_hb7Chu#qp}y&&U&!QcsDS2t4^+Ng%1^9ILvA>vEah%x
zaw(a~&Ex~zct0Mge7xrr;=hTMZd%S15?Qw%)m&dy<=d;05aX=<QFu<OP$`E7CI+-H
zoQH;U5}p_BoG@>=Unz5*EY4+<c~8#zg+JyC)9~Qyb@6@%>!}i?^b&u|7r}hSx2bqy
zJs;1pj@O^7k>QIM;zPsXGhsLF6PQv}#W0Uv*AYCo{S2_{Yqwzxxem<0C`I&RWE}aS
z|0!?>#&Wk1vl!c<qfiR>KxOPsHDcIQ(wN`ye5t727;Pxmh?a_lsFz7bQ*&Mlm~sHh
zIv(Er+&%iP|H<Obmv{EQe=&CyHr6Y4U}flu5Yq<f#eO-D&$TXG=M0oS)@@nOP?oj6
zHr5}XEBbD>Z?F$_WReJi9D{Pb>vnz5#}!TkQ%*wZCyrq>Vi+(C7zPXjh5^HXVZbo(
ze=#uWR6aS2Uu|b;+a>J$P5dYKUzz{mR7&5S%4F54ym>CFT`;}~Jn@f}6=(6aJ@sn2
z*7KMqF|u@M3B$m6t!EzNa+=03pKG<6<9c4+zLhU{shz>s{DX8s^pRh0`Ste{Mk;@j
zQh3du7#)}y31-u(F7^c1K({Xos~oW+9j$H4mNII?JtW)2tVNhh!+>GHFkl!k3>XFs
z1BL;^fMLKeU>GnA7zX||2D*+!##nP#jLo^A87`CP52JZKRuIdg5b27^Su~*i86b!y
z(U0FEvuWv;-RY9=qSu{Zcy~6D$%!7mooEry4>J}LUaWrTU>pA&G<?0V2R4SFr5D)P
za^>uHtyKqDZ=2E)_6}*}`wSiP1<6c{C6;0<<MeZpK754#2RIFURKxVM*BJg!fcPRl
zbey753GJO$(3uQ!^W{$`{9*n{V8FE*Q%#tCRQ6aQF<#pudL{3bvTiXtp2(#J^W~_(
dp9Z{q-}FXL-H{hEpjd7~zVfIWwc%C@@f!p<?XUm<

literal 0
HcmV?d00001

diff --git a/llvm/test/Object/nm-trivial-object.test b/llvm/test/Object/nm-trivial-object.test
index 98bf9f9..49c7683 100644
--- a/llvm/test/Object/nm-trivial-object.test
+++ b/llvm/test/Object/nm-trivial-object.test
@@ -26,6 +26,8 @@ RUN: llvm-nm %p/Inputs/macho-text-data-bss.macho-x86_64 -s __DATA __data \
 RUN:         | FileCheck %s -check-prefix macho-s
 RUN: llvm-nm -x %p/Inputs/macho-text-data-bss.macho-x86_64 \
 RUN:         | FileCheck %s -check-prefix macho-x
+RUN: llvm-nm -p -a %p/Inputs/macho-hello-g.macho-x86_64 \
+RUN:         | FileCheck %s -check-prefix macho-pa
 RUN: llvm-nm %p/Inputs/common.coff-i386 \
 RUN:         | FileCheck %s -check-prefix COFF-COMMON
 RUN: llvm-nm %p/Inputs/relocatable-with-section-address.elf-x86-64 \
@@ -115,6 +117,19 @@ macho-x: 000000000000000c 0f 02 0000 00000004 _d
 macho-x: 0000000000000000 0f 01 0000 00000001 _t
 macho-x: 0000000000000048 0f 05 0000 00000007 _t.eh
 
+macho-pa: 0000000000000000 - 00 0000    SO /Volumes/SandBox/
+macho-pa: 0000000000000000 - 00 0000    SO hello.c
+macho-pa: 0000000053c8408d - 03 0001   OSO /Volumes/SandBox/hello.o
+macho-pa: 0000000100000f30 - 01 0000 BNSYM 
+macho-pa: 0000000100000f30 - 01 0000   FUN _main
+macho-pa: 000000000000003b - 00 0000   FUN 
+macho-pa: 000000000000003b - 01 0000 ENSYM 
+macho-pa: 0000000000000000 - 01 0000    SO 
+macho-pa: 0000000100000000 T __mh_execute_header
+macho-pa: 0000000100000f30 T _main
+macho-pa:                  U _printf
+macho-pa:                  U dyld_stub_binder
+
 Test that nm uses addresses even with ELF .o files.
 ELF-SEC-ADDR64:      0000000000000058 D a
 ELF-SEC-ADDR64-NEXT: 000000000000005c D b
diff --git a/llvm/tools/llvm-nm/llvm-nm.cpp b/llvm/tools/llvm-nm/llvm-nm.cpp
index d3d4f99..b0336d3 100644
--- a/llvm/tools/llvm-nm/llvm-nm.cpp
+++ b/llvm/tools/llvm-nm/llvm-nm.cpp
@@ -457,6 +457,84 @@ static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
   outs() << "\n";
 }
 
+// Table that maps Darwin's Mach-O stab constants to strings to allow printing.
+struct DarwinStabName {
+  uint8_t NType;
+  const char *Name;
+};
+static const struct DarwinStabName DarwinStabNames[] = {
+    {MachO::N_GSYM, "GSYM"},
+    {MachO::N_FNAME, "FNAME"},
+    {MachO::N_FUN, "FUN"},
+    {MachO::N_STSYM, "STSYM"},
+    {MachO::N_LCSYM, "LCSYM"},
+    {MachO::N_BNSYM, "BNSYM"},
+    {MachO::N_PC, "PC"},
+    {MachO::N_AST, "AST"},
+    {MachO::N_OPT, "OPT"},
+    {MachO::N_RSYM, "RSYM"},
+    {MachO::N_SLINE, "SLINE"},
+    {MachO::N_ENSYM, "ENSYM"},
+    {MachO::N_SSYM, "SSYM"},
+    {MachO::N_SO, "SO"},
+    {MachO::N_OSO, "OSO"},
+    {MachO::N_LSYM, "LSYM"},
+    {MachO::N_BINCL, "BINCL"},
+    {MachO::N_SOL, "SOL"},
+    {MachO::N_PARAMS, "PARAM"},
+    {MachO::N_VERSION, "VERS"},
+    {MachO::N_OLEVEL, "OLEV"},
+    {MachO::N_PSYM, "PSYM"},
+    {MachO::N_EINCL, "EINCL"},
+    {MachO::N_ENTRY, "ENTRY"},
+    {MachO::N_LBRAC, "LBRAC"},
+    {MachO::N_EXCL, "EXCL"},
+    {MachO::N_RBRAC, "RBRAC"},
+    {MachO::N_BCOMM, "BCOMM"},
+    {MachO::N_ECOMM, "ECOMM"},
+    {MachO::N_ECOML, "ECOML"},
+    {MachO::N_LENG, "LENG"},
+    {0, 0}};
+static const char *getDarwinStabString(uint8_t NType) {
+  for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
+    if (DarwinStabNames[i].NType == NType)
+      return DarwinStabNames[i].Name;
+  }
+  return 0;
+}
+
+// darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
+// a stab n_type value in a Mach-O file.
+static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
+  MachO::nlist_64 STE_64;
+  MachO::nlist STE;
+  uint8_t NType;
+  uint8_t NSect;
+  uint16_t NDesc;
+  if (MachO->is64Bit()) {
+    STE_64 = MachO->getSymbol64TableEntry(I->Symb);
+    NType = STE_64.n_type;
+    NSect = STE_64.n_sect;
+    NDesc = STE_64.n_desc;
+  } else {
+    STE = MachO->getSymbolTableEntry(I->Symb);
+    NType = STE.n_type;
+    NSect = STE.n_sect;
+    NDesc = STE.n_desc;
+  }
+
+  char Str[18] = "";
+  format("%02x", NSect).print(Str, sizeof(Str));
+  outs() << ' ' << Str << ' ';
+  format("%04x", NDesc).print(Str, sizeof(Str));
+  outs() << Str << ' ';
+  if (const char *stabString = getDarwinStabString(NType))
+    format("%5.5s", stabString).print(Str, sizeof(Str));
+  else
+    format("   %02x", NType).print(Str, sizeof(Str));
+  outs() << Str;
+}
+
 static void sortAndPrintSymbolList(SymbolicFile *Obj, bool printName) {
   if (!NoSort) {
     if (NumericSort)
@@ -532,7 +610,10 @@ static void sortAndPrintSymbolList(SymbolicFile *Obj, bool printName) {
         if (I->Size != UnknownAddressOrSize)
           outs() << ' ';
       }
-      outs() << I->TypeChar << " " << I->Name << "\n";
+      outs() << I->TypeChar;
+      if (I->TypeChar == '-' && MachO)
+        darwinPrintStab(MachO, I);
+      outs() << " " << I->Name << "\n";
     } else if (OutputFormat == sysv) {
       std::string PaddedName(I->Name);
       while (PaddedName.length() < 20)
@@ -657,6 +738,9 @@ static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
   DataRefImpl Symb = I->getRawDataRefImpl();
   uint8_t NType = getNType(Obj, Symb);
 
+  if (NType & MachO::N_STAB)
+    return '-';
+
   switch (NType & MachO::N_TYPE) {
   case MachO::N_ABS:
     return 's';
-- 
2.7.4