Microsoft MVP성태의 닷넷 이야기
.NET Framework: 873. C# - 코드를 통해 PDB 심벌 파일 다운로드 방법 [링크 복사], [링크+제목 복사]
조회: 583
글쓴 사람
홈페이지
첨부 파일
 

C# - 코드를 통해 PDB 심벌 파일 다운로드 방법

물론 symchk.exe를 이용하면 쉽게 다운로드할 수 있지만,

pdb 파일을 다운로드하기 위한 symchk.exe 실행에 필요한 최소 파일
; https://www.sysnet.pe.kr/2/0/12091

관련 DLL들은 재배포 가능할 수 있어도 exe 파일에 대한 언급이 없습니다.

DbgHelp Versions
; https://docs.microsoft.com/en-us/windows/win32/debug/dbghelp-versions

The most current versions of DbgHelp.dll, SymSrv.dll, and SrcSrv.dll are available as a part of the Debugging Tools For Windows package. The redistribution policies for these included DLLs were specifically designed to make it as easy as possible for people to include these files in their own packages and releases.

The DbgHelp.dll file that ships in Windows is not redistributable.


그래서 ^^ 그냥 직접 다운로드하는 코드를 만들어 봤습니다.




기반 지식은 이미 다 정리가 되었습니다. 아래의 글에서 PDB 파일의 경로 구성을 알아봤고,

PDB 기호 파일의 경로 구성 방식
; https://www.sysnet.pe.kr/2/0/2925

위의 지식을 기반으로 PE 파일로부터 정보를 얻는 방법도 설명했습니다.

C# - PDB 파일 경로를 PE 파일로부터 얻는 방법
; https://www.sysnet.pe.kr/2/0/11237

또한, 마이크로소프트의 심벌 서버에서 다운로드하는 방법도 알았으니,

PDB 파일을 수동으로 다운로드하는 방법
; https://www.sysnet.pe.kr/2/0/11096

이제 이것들을 잘 조합하기만 하면 됩니다. 우선, PE 파일의 헤더로부터 Debug Directory를 가져오는 코드를 지난 글에 소개한 예제를 확장해 구현했습니다.

C# - 로딩된 Native DLL의 export 함수 목록 출력
; https://www.sysnet.pe.kr/2/0/12093

남은 작업은, 이렇게 구성한 PDB 파일 경로를 이용해 msdl.microsoft.com 심벌 서버로부터 다운로드하는 것인데 이에 대해서는 다음의 글에 소개한,

PDB Downloader
; https://blogs.msdn.microsoft.com/webtopics/2016/03/07/pdb-downloader/

PDB Downloader에서 힌트를 얻었습니다. 물론, 소스 코드를 직접 분석하기보다는 그냥 fiddler를 이용해 네트워크 패킷을 보는 것이 더 직관적일 수 있는데요, 우선, "HEAD" method 쿼리를 이용해,

HEAD http://msdl.microsoft.com/download/symbols/ntdll.pdb/0C2E19EA1901E9B82E4567D2D21E56D21/ntdll.pdb HTTP/1.1
User-Agent: Microsoft-Symbol-Server/10.0.10522.521
Host: msdl.microsoft.com
Connection: Keep-Alive

요청을 보내면 다음과 같이 "Location" 헤더에 실제 다운로드할 수 있는 URL이 담겨 옵니다.

HTTP/1.1 302 Found
Cache-Control: no-store, no-cache, max-age=0
Content-Length: 0
Location: https://vsblobprodscussu5shard62.blob.core.windows.net/b-4712e0edc5a240eabf23330d7df68e77/73D63042197DD1EE7B80F...[생략]...4cb6588
X-Cache: TCP_MISS
Server: Microsoft-HTTPAPI/2.0
X-MSEdge-Ref: Ref A: 6A044B29569A4FB582D54408AC47B3E5 Ref B: SLAEDGE0919 Ref C: 2019-12-25T03:49:24Z
Date: Wed, 25 Dec 2019 03:49:23 GMT

그렇군요, 그러니까 PDB 파일 다운로드는 HEAD + GET의 조합으로 가능하다는 것입니다. 아래의 소스 코드는 PEImage.cs의 코드를 이용해 PDB 파일을 다운로드하는 예제입니다.

// ...[생략]...

class Program
{
    static void Main(string[] args)
    {
        // DownloadPdbs(false);
        DownloadPdbs(true);
    }

    private static void DownloadPdbs(bool fromFile)
    {
        string rootPathToSave = Path.Combine(Environment.CurrentDirectory, "sym");
        if (Directory.Exists(rootPathToSave) == false)
        {
            Directory.CreateDirectory(rootPathToSave);
        }

        Process currentProcess = Process.GetCurrentProcess();
        foreach (ProcessModule pm in currentProcess.Modules)
        {
            Console.WriteLine($"[{pm.FileName}, 0x{pm.BaseAddress.ToString("x")}]");

            PEImage pe = null;

            if (fromFile == true)
            {
                pe = PEImage.ReadFromFile(pm.FileName);
            }
            else
            {
                pe = PEImage.ReadFromMemory(pm.BaseAddress, pm.ModuleMemorySize);
            }

            if (pe == null)
            {
                Console.WriteLine("Failed to read images");
                return;
            }

            string modulePath = pm.FileName;
            DownloadPdb(modulePath, rootPathToSave);

            Console.WriteLine();
        }
    }

    private static void DownloadPdb(string modulePath, string rootPathToSave)
    {
        if (File.Exists(modulePath) == false)
        {
            Console.WriteLine("NOT Found: " + modulePath);
            return;
        }

        PEImage pe = PEImage.ReadFromFile(modulePath);
        if (pe == null)
        {
            Console.WriteLine("Failed to read images");
            return;
        }

        Uri baseUri = new Uri("https://msdl.microsoft.com/download/symbols/");

        foreach (CodeViewRSDS codeView in pe.EnumerateCodeViewDebugInfo())
        {
            if (string.IsNullOrEmpty(codeView.PdbFileName) == true)
            {
                continue;
            }

            string pdbFileName = codeView.PdbFileName;
            if (Path.IsPathRooted(codeView.PdbFileName) == true)
            {
                pdbFileName = Path.GetFileName(codeView.PdbFileName);
            }

            Console.WriteLine("\tFileName: " + pdbFileName);
            Console.WriteLine("\tPdbFileName: " + codeView.PdbFileName);
            Console.WriteLine("\tLocal: " + codeView.PdbLocalPath);
            Console.WriteLine("\tUri: " + codeView.PdbUriPath);

            string localPath = Path.Combine(rootPathToSave, codeView.PdbLocalPath);
            string localFolder = Path.GetDirectoryName(localPath);

            if (Directory.Exists(localFolder) == false)
            {
                try
                {
                    Directory.CreateDirectory(localFolder);
                }
                catch (DirectoryNotFoundException)
                {
                    Console.WriteLine("NOT Found on local: " + codeView.PdbLocalPath);
                    continue;
                }
            }

            if (File.Exists(localPath) == true)
            {
                Console.WriteLine("Found on local: " + pdbFileName);
                continue;
            }

            if (CopyPdbFromLocal(modulePath, codeView.PdbFileName, localPath) == true)
            {
                Console.WriteLine("Found on local: " + pdbFileName);
                continue;
            }

            Uri target = new Uri(baseUri, codeView.PdbUriPath);
            Console.WriteLine(target);

            Uri pdbLocation = GetPdbLocation(target);

            if (pdbLocation == null)
            {
                string underscorePath = ProbeWithUnderscore(target.AbsoluteUri);
                pdbLocation = GetPdbLocation(new Uri(underscorePath));
            }

            if (pdbLocation != null)
            {
                DownloadPdbFile(pdbLocation, localPath);
            }
            else
            {
                Console.WriteLine("Not Found on symbol server: " + codeView.PdbFileName);
            }
        }

        Console.WriteLine();
    }

    private static bool CopyPdbFromLocal(string modulePath, string pdbFileName, string localTargetPath)
    {
        if (File.Exists(pdbFileName) == true)
        {
            File.Copy(pdbFileName, localTargetPath);
            return File.Exists(localTargetPath);
        }

        string fileName = Path.GetFileName(pdbFileName);
        string pdbPath = Path.Combine(Environment.CurrentDirectory, fileName);

        if (File.Exists(pdbPath) == true)
        {
            File.Copy(pdbPath, localTargetPath);
            return File.Exists(localTargetPath);
        }

        pdbPath = Path.ChangeExtension(modulePath, ".pdb");
        if (File.Exists(pdbPath) == true)
        {
            File.Copy(pdbPath, localTargetPath);
            return File.Exists(localTargetPath);
        }

        return false;
    }

    private static string ProbeWithUnderscore(string path)
    {
        path = path.Remove(path.Length - 1);
        path = path.Insert(path.Length, "_");
        return path;
    }

    private static void DownloadPdbFile(Uri target, string pathToSave)
    {
        System.Net.HttpWebRequest req = System.Net.WebRequest.Create(target) as System.Net.HttpWebRequest;

        using (System.Net.HttpWebResponse resp = req.GetResponse() as System.Net.HttpWebResponse)
        using (FileStream fs = new FileStream(pathToSave, FileMode.CreateNew, FileAccess.Write, FileShare.None))
        using (BinaryWriter bw = new BinaryWriter(fs))
        {
            BinaryReader reader = new BinaryReader(resp.GetResponseStream());
            long contentLength = resp.ContentLength;

            while (contentLength > 0)
            {
                byte[] buffer = new byte[4096];
                int readBytes = reader.Read(buffer, 0, buffer.Length);
                bw.Write(buffer, 0, readBytes);

                contentLength -= readBytes;
            }
        }
    }

    private static Uri GetPdbLocation(Uri target)
    {
        System.Net.HttpWebRequest req = System.Net.WebRequest.Create(target) as System.Net.HttpWebRequest;
        req.Method = "HEAD";

        try
        {
            using (System.Net.HttpWebResponse resp = req.GetResponse() as System.Net.HttpWebResponse)
            {
                return resp.ResponseUri;
            }
        }
        catch (System.Net.WebException)
        {
            return null;
        }
    }

}

완전하게 동작하는 코드는 다음의 github에 공개되어 있습니다.

DotNetSamples/WinConsole/PEFormat/PEFormatSample/
; https://github.com/stjeong/DotNetSamples/tree/master/WinConsole/PEFormat/PEFormatSample

DotNetSamples/WinConsole/PEFormat/WindowsPE/
; https://github.com/stjeong/DotNetSamples/tree/master/WinConsole/PEFormat/WindowsPE




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]





[최초 등록일: ]
[최종 수정일: 12/26/2019 ]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer@outlook.com

비밀번호

댓글 쓴 사람
 




... [16]  17  18  19  20  21  22  23  24  25  26  27  28  29  30  ...
NoWriterDateCnt.TitleFile(s)
11890정성태5/8/20191129개발 환경 구성: 439. "Visual Studio Enterprise is required to execute the test." 메시지와 관련된 코드 기록
11889정성태5/8/20191260개발 환경 구성: 438. mstest, QTAgent의 로그 파일 설정 방법
11888정성태5/8/20192417.NET Framework: 830. C# - 비동기 호출을 취소하는 CancellationToken의 간단한 예제 코드파일 다운로드1
11887정성태5/8/20191585.NET Framework: 829. C# - yield 문을 사용할 수 있는 메서드의 조건
11886정성태5/8/20191598오류 유형: 534. mstest.exe 실행 시 "Visual Studio Enterprise is required to execute the test." 오류 [2]
11885정성태5/7/20191035오류 유형: 533. mstest.exe 실행 시 "File extension specified '.loadtest' is not a valid test extension." 오류 발생
11884정성태5/5/20191860.NET Framework: 828. C# DLL에서 Win32 C/C++처럼 dllexport 함수를 제공하는 방법 - 두 번째 이야기
11883정성태5/3/20192290.NET Framework: 827. C# - 인터넷 시간 서버로부터 받은 시간을 윈도우에 적용하는 방법파일 다운로드1
11882정성태5/9/20191228.NET Framework: 826. (번역글) .NET Internals Cookbook Part 11 - Various C# riddles파일 다운로드1
11881정성태4/28/20191826오류 유형: 532. .NET Core 프로젝트로 마이그레이션 시 "CS0579 Duplicate 'System.Reflection.AssemblyCompanyAttribute' attribute" 오류 발생
11880정성태4/25/20191116오류 유형: 531. 이벤트 로그 오류 - Task Scheduling Error: m->NextScheduledSPRetry 1547, m->NextScheduledEvent 1547
11879정성태1/27/20201548.NET Framework: 825. (번역글) .NET Internals Cookbook Part 10 - Threads, Tasks, asynchronous code and others파일 다운로드2
11878정성태5/9/20191412.NET Framework: 824. (번역글) .NET Internals Cookbook Part 9 - Finalizers, queues, card tables and other GC stuff파일 다운로드1
11877정성태5/9/20191478.NET Framework: 823. (번역글) .NET Internals Cookbook Part 8 - C# gotchas파일 다운로드1
11876정성태5/9/20191241.NET Framework: 822. (번역글) .NET Internals Cookbook Part 7 - Word tearing, locking and others파일 다운로드1
11875정성태4/21/20191125오류 유형: 530. Visual Studo에서 .NET Core 프로젝트를 열 때 "One or more errors occurred." 오류 발생
11874정성태5/9/20191282.NET Framework: 821. (번역글) .NET Internals Cookbook Part 6 - Object internals파일 다운로드1
11873정성태7/9/20201095.NET Framework: 820. (번역글) .NET Internals Cookbook Part 5 - Methods, parameters, modifiers파일 다운로드1
11872정성태5/9/20191342.NET Framework: 819. (번역글) .NET Internals Cookbook Part 4 - Type members파일 다운로드1
11871정성태5/9/20191608.NET Framework: 818. (번역글) .NET Internals Cookbook Part 3 - Initialization tricks [3]파일 다운로드1
11870정성태4/16/20191289.NET Framework: 817. Process.Start로 실행한 콘솔 프로그램의 출력 결과를 얻는 방법파일 다운로드1
11869정성태5/9/20191359.NET Framework: 816. (번역글) .NET Internals Cookbook Part 2 - GC-related things파일 다운로드1
11868정성태4/15/20191169.NET Framework: 815. CER(Constrained Execution Region)이란?파일 다운로드1
11867정성태4/15/20191255.NET Framework: 814. Critical Finalizer와 SafeHandle의 사용 의미파일 다운로드1
11866정성태4/9/20192551Windows: 159. 네트워크 공유 폴더(net use)에 대한 인증 정보는 언제까지 유효할까요?
11865정성태4/9/20191242오류 유형: 529. 제어판 - C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Administrative Tools is not accessible.
... [16]  17  18  19  20  21  22  23  24  25  26  27  28  29  30  ...