RAU6 Dokuwiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Ćwiczenie 2: Instalacja środowiska Visual Studio Community 2019 i konfiguracja do tworzenia bibliotek dll napisanych w MASM. ======
===== Instalacja =====

Rozpoczynamy od ściągnięcia instalatora ze strony [[https://visualstudio.microsoft.com/vs/community|Microsoft]].

{{ :pl:edu:zmitac:n1z:ja:install_step0.jpg?800 |}}

Po uruchomieniu instalatora wybieramy opcje .NET desktop development oraz Desktop development with C++ i rozpoczynamy instalację.

{{ :pl:edu:zmitac:n1z:ja:install_step1.jpg?800 |}}

Instalacja przebiegnie automatycznie.

{{ :pl:edu:zmitac:n1z:ja:install_step2.jpg?800 |}}

Po zainstalowaniu, przy pierwszym uruchomieniu środowiska, można ustawić jego wygląd.

{{ :pl:edu:zmitac:n1z:ja:install_step3.jpg?600 |}}

===== Utworzenie projektu z asemblerową biblioteką DLL =====

Po zainstalowaniu możemy utworzyć projekt, w którym główny program będzie napisany w języku wysokiego poziomu (np. C#, C++), a biblioteka dołączana dynamicznie (dll) będzie napisana w asemblerze. 
<note tip>Tworzenie bibliotek w asemblerze, wywoływanych z programów stworzonych w wybranym języku wysokiego poziomu (HLL) jest obecnie najczęstszym wykorzystaniem języka asemblerowego.</note>
<note>Przedstawiony w dalszej części proces konfiguracji przebiega identycznie dla programu głównego napisanego w C++ jak i C#. Wykorzystane zrzuty ekranu pochodzą z konfiguracji bibliotek DLL dla obu języków programowania, jednak zwykle różnice są drugoplanowe i nie mają wpływu na proces konfiguracji środowiska.</note>
==== Utworzenie nowego projektu ====
W tym ćwiczeniu zajmiemy się dołączeniem biblioteki dll do programu napisanego w C++.
Konfigurację rozpoczynamy od utworzenia nowego projektu w języku C++. 

{{ :pl:edu:zmitac:n1z:ja:create_step1.jpg?800 |}}

Utworzymy aplikację konsolową, napisaną w języku C++, przeznaczoną do uruchomienia pod kontrolą systemu operacyjnego Windows.

{{ :pl:edu:zmitac:n1z:ja:create_1.jpg?800 |}}

Aby utworzyć projekt należy go nazwać. Dla tego projektu proponujemy nazwę "Lab2_dll_cpp". Ścieżki pozostawiamy domyślne.

{{ :pl:edu:zmitac:n1z:ja:create_2.jpg?800 |}}

<note tip>Na tym etapie zostanie utworzone rozwiązanie zawierające projekt z szablonem programu C++. Rozwiązanie jest często zwane solucją (z ang. solution).</note>

==== Dodanie do rozwiązania części asemblerowej ====

Aby w naszym rozwiązaniu dodać bibliotekę napisaną w asemblerze, dodajemy do solucji nowy projekt. Klikając prawym klawiszem myszy na rozwiązaniu wybieramy dodaj (add) nowy projekt (new project).

{{ :pl:edu:zmitac:n1z:ja:add_asm_1.jpg?800 |}}

{{ :pl:edu:zmitac:n1z:ja:add_asm_2.jpg?800 |}}

Nasz nowy projekt asemblerowy tworzymy jako projekt biblioteki (library) zgodny z C++, pracujący pod kontrolą systemu operacyjnego Windows. Z listy dostępnych opcji wybieramy bibliotekę dołączaną dynamicznie Dynamic-Link Library (DLL).

{{ :pl:edu:zmitac:n1z:ja:add_step3.jpg?800 |}}

Nazywamy pojekt np. "JaAsm" i tworzymy go pozostawiając domyślną ścieżkę.

{{ :pl:edu:zmitac:n1z:ja:add_step4.jpg?800 |}}

<note tip>Obie części naszego rozwiązania będą umieszczone jako podfoldery w jednym folderze o nazwie zgodniej z nazwą rozwiązania, w naszym przypadku "Lab2_dll_cpp". Każdy z tych podfolderów przyjmie nazwę odpowiednich projektów, czyli "Lab2_dll_cpp" dla części napisanej w C++ i "JaAsm" dla części napisanej w asemblerze.</note>

==== Ustawienie zależności w rozwiązaniu ====
Następnym krokiem jest ustawienie zależności projektu w taki sposób, aby kompilacja aplikacji konsolowej w C++ wymuszała automatycznie kompilację biblioteki asemblerowej. W tym celu należy kliknąć prawym klawiszem myszy na projekt konsolowy C++, wybrać menu „Zależności kompilacji” (Build dependencies), a następnie „Zależności projektu” (Project dependencies).

{{ :pl:edu:zmitac:n1z:ja:lab2_dependencies_1.jpg?800 |}}

{{ :pl:edu:zmitac:n1z:ja:lab2_dependencies_2.jpg?800 |}}

W nowo otwartym oknie zaznaczamy naszą bibliotekę "JaAsm" i klikamy „OK”

{{ :pl:edu:zmitac:n1z:ja:lab2_dependencies_3.jpg?800 |}}

<note tip>Po ustawieniu tej zależności, przy kompialcji projektu lub programu napisanego w C++ automatycznie zostanie także przekompilowany plik asemblerowy.</note>

==== Zamiana biblioteki z C++ na asemblerową ====
Najpierw należy usunąć automatycznie utworzone pliki projektu zgodnego z C++. W tym celu wystarczy zaznaczyć wskazane pliki nagłówkowe i źródłowe, a następnie prawy klawisz myszy i wybrać „Usuń” bądź też kliknąć Delete.

{{ :pl:edu:zmitac:n1z:ja:prepare_step1.jpg?800 |}}

Dla biblioteki konieczne jest dostosowanie kompilacji jako plik asemblerowy MASM. W tym celu klikamy projekt biblioteki prawym klawiszem myszy i z listy wybieramy „Zależności kompilacji” (Build dependencies), a następnie „Dostosowanie kompilacji” (Build customization).

{{ :pl:edu:zmitac:n1z:ja:prepare_step2.jpg?800 |}}

{{ :pl:edu:zmitac:n1z:ja:prepare_step3.jpg?800 |}}

W nowo otwartym oknie zaznaczamy „masm” i potwierdzamy nasz wybór „OK”.

{{ :pl:edu:zmitac:n1z:ja:prepare_step4.jpg?800 |}}

Kolejnym krokiem jest dodanie do biblioteki plików źródłowego w asemblerze oraz pliku definicji. Aby to zrobić ponownie klikamy prawym przyciskiem myszy na bibliotekę "JaAsm", a następnie wybieramy „Dodaj” (Add) oraz „Nowy element” (New item).

{{ :pl:edu:zmitac:n1z:ja:prepare_step5.jpg?800 |}}

Czynność tę powtarzamy dwukrotnie wybierając za każdym razem "Narzędzie" (Utility) i typ pliku tekstowy, podając nazwy: "JaDll.asm" oraz "JaDll.def".

{{ :pl:edu:zmitac:n1z:ja:prepare_step6.jpg?800 |}}

<note tip>Przy wykonaniu czynności zgodnie z podaną uprzednio kolejnością, z dużym prawdopodobieństwem krok przedstawiony na kolejnym rysunku nie będzie konieczny.</note>

Aby kompilator wiedział, że stworzony plik asemblerowy jest skojarzony z MASM, należy wskazać jego typ. Krok ten jest niezbędny gdy wykorzystujemy plik źródłowy C++ i zmieniamy jedynie jego rozszerzenie na *.asm. Klikając pracym klawiszem na pliku *.asm wybieramy properties i ustawiamy typ pliku na Microsoft Macro Assembler.

{{ :pl:edu:zmitac:n1z:ja:file_type1.jpg?800 |}}


==== Ustawienie trybu kompilacji ====

Kompilacja powinna przebiegać w trybie 64-bitowym (X64). W tym celu należy ustawić taki tryb w opcjach rozwiązania.
Klikamy prawym przyciskiem myszy na nasze rozwiązanie i wybieramy „Właściwości” (Properties).

{{ :pl:edu:zmitac:n1z:ja:x64_step1.jpg?800 |}}

{{ :pl:edu:zmitac:n1z:ja:x64_step2.jpg?800 |}}

W nowo otwartym oknie przechodzimy na zakładkę „Właściwości konfiguracji” -> „Konfiguracja” (Configuration properties -> Configuration) na następnie klikamy w „Menedżer konfiguracji” (Configuration manager).

{{ :pl:edu:zmitac:n1z:ja:x64_step3.jpg?800 |}}

W nowym oknie wskazujemy wszędzie platformę x64 (gdyby dana opcja była niedostępna z dostępnej listy wybieramy pozycję „Nowy” (New), a następnie tworzymy platformę x64 poprzez kopiowanie ustawień z Any CPU). Należy także przy obu częściach solucji włączyć kompilację (Build).

{{ :pl:edu:zmitac:n1z:ja:x64_step4.jpg?800 |}}

{{ :pl:edu:zmitac:n1z:ja:x64_step5.jpg?800 |}}

{{ :pl:edu:zmitac:n1z:ja:x64_step6.jpg?800 |}}

Po wszystkim upewniamy się raz jeszcze, że wszędzie wskazana platforma to x64 i zamykamy okno.
W głównym pasku menu Visual Studio powinna automatycznie ustawić się opcja "x64", niemniej warto to sprawdzić i w razie potrzeby zmodyfikować.

{{ :pl:edu:zmitac:n1z:ja:x64_step7.jpg?800 |}}

==== Końcowa konfiguracja biblioteki asemblerowej ====

Przystępujemy do konfiguracji biblioteki. W tym celu klikamy prawym przycskiem myszy na bibliotece i wybieramy „Właściwości” (Properties).

{{ :pl:edu:zmitac:n1z:ja:config_dll_step1.jpg?800 |}}

{{ :pl:edu:zmitac:n1z:ja:config_dll_step2.jpg?800 |}}

W otwartym nowo oknie przechodzimy do „Konsolidator” -> „Dane wejściowe” (Linker -> Input) i w polu „Plik definicji modułu” (Module definition file) wpisujemy nazwę naszego pliku „*.def”. W naszym przypadku "JaDll.def". Wpis potwierdzamy.

{{ :pl:edu:zmitac:n1z:ja:config_dll_step3.jpg?800 |}}

Końcowym krokiem konfiguracji jest wyłączenie punktu wejścia do biblioteki. W tym celu w zakładce "Konsolidator" (Linker) przechodzimy do opcji "Zaawansowane" (Advanced) i w polu „Brak punktu wejścia” (No entry point) wybieramy opcję „Tak (/NOENTRY)”. Zapisujemy wprowadzone ustawienia i zamykamy okno.

{{ :pl:edu:zmitac:n1z:ja:config_dll_step4.jpg?800 |}}

<note tip>Biblioteka dll, w przeciwieństwie do programu głównego, nie ma punktu (adresu) startowego, który wykorzystuje system operacyjny do uruchomienia programu. Udostępnia jedynie zestaw funkcji dla innych programów.</note>

===== Wykorzystanie biblioteki dll napisanej w asemblerze =====
==== Biblioteka asemblerowa dll ====
Biblioteka dll zawiera funkcje, które można użyć w innych programach. Pierwsza wersja naszej biblioteki będzie udostępniała jedną funkcję, zwracającą stałą wartość. Wartość tę następnie odczytamy w pliku C++. Przykładowa zawartość pliku asemblerowego (JaDll.asm) może wyglądać następująco.

<code>
.code
MyProc proc
mov RAX, 2021
ret
MyProc endp
end
</code>

Z plikiem kodu programu nierozerwalnie związany jest plik definicji (JaDll.def). Plik taki musi zawierać nazwę biblioteki DLL jako agrument dyrektywy LIBRARY, oraz listę nazw funkcji dostępnych dla innych modułów poprzedzonych dyrektywą EXPORTS. Aby nasza funkcja MyProc była widziana przez program C++ musimy ją zadeklarować jako eksportowaną. Plik JaDll.def w naszym projekcie może wyglądać następująco.

<code>
LIBRARY JaAsm
EXPORTS MyProc
</code>

Często chcemy wykorzystać przekazane do funkcji parametry. Przypomnijmy, że w 64-bitowej konwencji wywołań pierwsze cztery parametry są umieszczane bezpośrednio w rejestrach procesora. Szczegóły są opisane w  [[pl:edu:zmitac:n1z:ja:lab1#powtorka_z_teoriifunkcje_i_ich_wywolywanie_z_poziomu_assemblera|instrukcji do pierwszego ćwiczenia]]. I tak, dwa parametry typu całkowitego są umieszczone w rejestrach RCX i RDX. Funkcja, któa zwraca sumę dwóch argmentów całkowitych wyglądałaby w następujący sposób.

<code>
...
MyProc proc
mov RAX, RCX
add RAX, RDX
ret
MyProc endp
...
</code>

Argumenty typu zmiennoprzecinkowego należy przekazać przez rejestry XMM0 i XMM1, a wynik zwrócić przez XMM0. Oczywiście należy użyć instrukcji rozszerzeń MMX/SSE.

<code>
...
FloatProc PROC
addsd xmm0, xmm1
ret
FloatProc ENDP
...
</code>
==== Odwołanie do biblioteki dll z programu C++ ====

Aby program napisany w C++ mógł wykorzystać funkcję z biblioteki należy wykonać kilka kroków.
  - Przygotować typ funkcji zgodny z jej późniejszym wywołaniem,
  - Załadować bibliotekę funkcją LoadLibrary uzyskując jednocześnie jej uchwyt,
  - Odczytać aktualny adres interesującej nas funkcji wywołując GetProcAddress,
  - Użyć funkcji odwołując się do jej adresu.
Przykładowy kod mógłby wyglądać tak:

<code>
#include <windows.h>
#include <iostream>
typedef int(_stdcall* MyProc)();
HINSTANCE dllHandle = NULL;

int main()
{
    dllHandle = LoadLibrary(TEXT("JaAsm.dll"));
    MyProc procedura = (MyProc)GetProcAddress(dllHandle, "MyProc");
    std::cout << procedura();
}
</code>

Użycie funkcji z parametrami wymaga nieco zmodyfikowanych definicji typu. Należy także zwrócić uwagę na typ wartości zwracanej przez funkcję. Pamiętać należy, że w przypadku liczb zmiennoprzecinkowych, rozmiar rejestrów XMM0, XMM1 to 64 bity. Odpowiada to wartości zmiennoprzecinkowej podwójnej precyzji, czyli w języku C++ typowi "double".

<code>
...
typedef int(_stdcall* MyProc)(int, int);
typedef double(_stdcall* FloatProc)(double, double);
...
</code>

==== Zadanie do zrealizowania w ramach laboratorium ====
Należy napisać bibliotekę DLL w asemblerze i program w C++ demonstrujący działanie tej biblioteki.\\
**Biblioteka DLL** ma udostępniać funkcje wykonujące i zwracające wynik podstawowych obliczeń arytmetycznych (dodawanie, odejmowanie, mnożenie i dzielenie) na parach liczb przekazanych jako parametry ich wywołania. Funkcje powinny mieć wersję stało- i zmiennoprzecinkową (w sumie osiem funkcji).\\
**Program w C++** ma wywoływać wszystkie funkcje przekazując przykładowe wartości parametrów i wyświetlić wyniki na ekranie. Nie jest wymagany interfejs użytkownika - wartości do obliczeń mogą być umieszczone w kodzie programu.