{"id":48,"date":"2009-11-09T15:51:33","date_gmt":"2009-11-09T14:51:33","guid":{"rendered":"http:\/\/blog.kalmbach-software.de\/de\/2009\/11\/09\/source-indexing-tfs-und-smbols-store\/"},"modified":"2009-11-09T16:59:28","modified_gmt":"2009-11-09T15:59:28","slug":"source-indexing-tfs-und-smbols-store","status":"publish","type":"post","link":"http:\/\/blog.kalmbach-software.de\/de\/2009\/11\/09\/source-indexing-tfs-und-smbols-store\/","title":{"rendered":"Source-Indexing (TFS) und Symbol-Store"},"content":{"rendered":"

Wer von Euch kennt das Problem: Der Kunde hat ein Absturz oder einen H\u00e4nger Deines Programmes. Das einzige was Du bekommst ist ein Dump-File (z.B. entweder via WER<\/a> oder durch eigenes schreiben von MiniDumpWriteDump<\/a>).
\nJetzt beginnt f\u00fcr Dich das Problem:<\/p>\n

    \n
  1. Welche Version hat der Kunde?\n
  2. Welche Source-Files brauche ich f\u00fcr diese Version?\n
  3. Wo zum teu.. sind nochmals die passenden PDBs und EXEn f\u00fcr diese Version?\n<\/ol>\n

    Mit diesem Fragen braucht man sich nicht besch\u00e4ftigen, wenn man bei seinem Build Prozess noch zus\u00e4tzlich zwei Dinge einbaut<\/p>\n

      \n
    1. Source-Indexing\n
    2. Symbols-Store\n<\/ol>\n

      Source-Indexing (mit dem TFS)<\/h3>\n

      Source-Indexing sorgt daf\u00fcr, dass in die Debug-Symole (PDB-Dateien) auch zus\u00e4tzlich noch ein verweis auf die richtige TFS-Version eingef\u00fcgt wird. Dadurch kann der Debugger (z.B. VS) man mit der PDB-Datei genau den passenden Source aus dem TFS holen, mit dem die DLL\/EXE gebuildet wurde.
      \nUm dies zu machen braucht man zwei Dinge: “      Debugging Tools For Windows<\/a>” und “ActivePerl<\/a>“). Das Source-Indexing findet sich bei den Debugging Tools im Unterverzeichnis “srcsrv” (also z.B. C:\\Program Files\\Debugging Tools for Windows\\srcsrv). Da die “Skripts” (leider) in Perl geschrieben sind, ist auch noch ActivePerl notwendig. Es reicht aber, wenn man die ZIP-Datei<\/a> runterl\u00e4dt und vor dem Aufruf einfach den Pfad auch noch auf das entpackte ActivePerl setzt.<\/p>\n

      Damit beim Source-Indexing auch der korrekte TFS-Server verwendet wird, muss man in der Datei “srcsrv.ini” die Zeile mit “MYSERVER” auf den richtigen TSF zeigen lassen.
      \nMYSERVER=http:\/\/my-tfs-machine:8080<\/code><\/p>\n

      Jetzt muss man nach einen Build nur noch das Source-Indexing aufrufen und angeben, wo denn der Workstore und die PDBs liegen. Ich gebe der Einfachheithalber immer den Root aller Projekte an, welche ich gebuildet habe. Die Natchdatei sieht dann z.B. so aus (es kann auch direkt als eigenes Task in msbuild laufen):
      \n
      \nrem Merke mit mal den aktuellen Pfad, was die Root meiner Projekte und Ausgabe ist
      \nset srvOrgDir=%CD%<\/p>\n

      rem Setze den pfad auch zu dem Perl Zeugs...
      \npath=%path%;\"%CD%\\Tools\\srcsrv\\ActivePerl-5.10.1.1006-MSWin32-x86-291086\\perl\\bin\"<\/p>\n

      rem Wechsle in das Verzeichnis wo die Source-Indexing Tools liegen (liegt bei mir auch im TFS)
      \ncd .\\Tools\\srcsrv<\/p>\n

      rem Rufe das Source-Indexing auf
      \ncall tfsindex.cmd -ALLROOT=\"%srvOrgDir%\"<\/p>\n

      rem Setze wieder den urspr\u00fcnglichen Pfad
      \ncd \/D %srvOrgDir%
      \n<\/code><\/p>\n

      Alternativ kann man nat\u00fcrlich auch das srcsrv-Verzeichnis im TFS ablegen (so hab ich es gemacht), dann muss man nicht sicherstellen, dass man auf dem Build-Rechner auch die Debugging-Tools installiert hat.<\/p>\n

      Jetzt sollten nach einem Build alle PDB-Dateien mit der korrekten TFS-Version indiziert worden sein (dies erkennt man daran, dass ziemlich weit hinten in der PDB-Datei Eintr\u00e4ge mit “MYSERVER” kommen…; kann man z.B. in Notepad anschauen).<\/p>\n

      Symbol-Store<\/h3>\n

      Oben haben wir jetzt die PDB-Dateien mit dem passenden Verweis auf den TFS ausgestattet. Jetzt m\u00fcssen wir nur noch sicherstellen, dass wir zu einem beliebigen sp\u00e4teren Zeitpunkt nicht mehr nach dieser PDB-Datei (und den dazugeh\u00f6rigen EXEn) suchen m\u00fcssen. Dies geschieht am einfachsten mit dem “symstore” aus den Debugging Tools for Windows. Dies speichert einfach alle PDBs\/EXEn in ein Verzeichnis (am besten ein Netzwerkverzeichnis, wenn es sp\u00e4ter mehrere Verwenden wollen).
      \nDas ablegen erfolgt dann ganz Simple durch:
      \n
      \n.\\Tools\\SymStore\\Symstore.exe add \/r \/f .\\*.* \/s G:\\MyProject\\SymbolStore\\Files \/t \"Project Name\"
      \n<\/code><\/p>\n

      Das war alles \ud83d\ude09<\/p>\n

      Einstellungen in VS<\/h3>\n

      Ok, fast… denn man will das ganze ja auch noch verwenden… dazu muss man in VS noch ein paar Einstellungen machen, da per default der “Source-Server” deaktiviert ist. Dies muss aktiviert werden:
      \n      <\/a><\/p>\n

      Jetzt muss man noch den Pfad zu den zuvor abgelegten Dateien eintragen:
      \n      <\/a><\/p>\n

      Bekommt man jetzt ein Dump oder will in dieser EXE\/DLL debuggen, so werden die Sourcen direkt vom TFS geholt (und in einem tempor\u00e4ren Verzeichnis gespeichert) und man kann dies dann direkt debuggen.<\/p>\n

      Ich hoffe, dass hilft dem ein oder anderen.<\/p>\n

      PS: Beide Verfahren werden \u00fcbrigens auch intern von Microsoft schon sehr lange eingesetzt (deswegen auch das Source-Indexing in Perl; PowerShell gab es damals noch nicht). Die gesamten Windows Sourcen sind so indiziert und (der wer darf \ud83d\ude09 ) k\u00f6nnen dann via CCP die passenden indizierten PDB-Dateien abgefragt werden, welche dann z.B: in VS\/WinDbg die passenden Source runterl\u00e4dt.<\/p>\n

      PPS: Wer das ganze noch f\u00fcr SubVersion haben will, kann es bei Stefan nachlesen:
      \n      Source Server und Symbol Server Setup mit Subversion<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

      Wer von Euch kennt das Problem: Der Kunde hat ein Absturz oder einen H\u00e4nger Deines Programmes. Das einzige was Du bekommst ist ein Dump-File (z.B. entweder via WER oder durch eigenes schreiben von MiniDumpWriteDump). Jetzt beginnt f\u00fcr Dich das Problem: Welche Version hat der Kunde? Welche Source-Files brauche ich f\u00fcr diese Version? Wo zum teu.. […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4,3,5],"tags":[],"class_list":["post-48","post","type-post","status-publish","format-standard","hentry","category-alles-uber-dotnet-programmierung","category-alles-uber-die-echte-windowsprogrammierung","category-wpf"],"_links":{"self":[{"href":"http:\/\/blog.kalmbach-software.de\/de\/wp-json\/wp\/v2\/posts\/48","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/blog.kalmbach-software.de\/de\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/blog.kalmbach-software.de\/de\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/blog.kalmbach-software.de\/de\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/blog.kalmbach-software.de\/de\/wp-json\/wp\/v2\/comments?post=48"}],"version-history":[{"count":0,"href":"http:\/\/blog.kalmbach-software.de\/de\/wp-json\/wp\/v2\/posts\/48\/revisions"}],"wp:attachment":[{"href":"http:\/\/blog.kalmbach-software.de\/de\/wp-json\/wp\/v2\/media?parent=48"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/blog.kalmbach-software.de\/de\/wp-json\/wp\/v2\/categories?post=48"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/blog.kalmbach-software.de\/de\/wp-json\/wp\/v2\/tags?post=48"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}