Jose's Blog

Mixing .Net and Assembly Language in a standalone 64-bit exe


The technique of building a standalone .Net executable when there is a mix of managed and unmanaged code has been first explained by Steve Teixeira in http://blogs.msdn.com/b/texblog/archive/2007/04/05/linking-native-c-into-c-applications.aspx, which you are strongly recommended to read if this is new for you.

Our article uses that technique, but we will be building a 64-bit only program. The reason is that we are going to statically link compiled 64-bit Assembly Language (or ASM) which is CPU dependent. You will have to take that into account when configuring the platform target on your .Net projects.

Using the code:
1) Assembly Language
I developed two ASM routines that will be called from .Net. One performs a small Math calculation using SSE2 instructions. The other is a very fast encryption/decryption routine using the XXTEA alghorithm (http://en.wikipedia.org/wiki/XXTEA). The XXTEA alghorithm is a very strong encryption alghorithm, but not to be used when the security of a nation depends on it because a small number of people appear to know how to attack it. Anyway, we are not going to discuss cryptography here.
The routine that performs the Math calculation sin(val1^2 / val2) is shown below, just small like this:

; Calculates sin(val1^2 / val2)
;double AsmMathCalc (double val1, LONGLONG val2);
AsmMathCalc proc FRAME val1:MMWORD, val2:SQWORD
	mulsd xmm0, xmm0 ; val1^2
	cvtsi2sd xmm1, rdx
	divsd xmm0,xmm1
	call sin
	ret ; result is returned in xmm0
AsmMathCalc endp

The routine that performs the encryption/decryption is not shown here due to its length, you need to download to see it. It opens the file to be encrypted (or decrypted) and creates a file for the encrypted (decrypted) output. Then reads and encrypts (or decrypts) in chunks and writes to the new file. Encrypted files are saved with the extension “.enc” added to the full file name, decrypted files add the extension “.dec”. Note that XXTEA works with 32-bit words, if the file length in bytes is not divisible by 4, we have to send more “filesize modulo 4” bytes to make up for the difference.
2) C++/CLR code to interop with the ASM
My approach was to create a classe library C++ project. Then I placed the parts dealing with the managed code and unmanaged code in separate source code files.
Managed code:

// CInterop.h

#pragma once
#include "native.h"

using namespace System;

namespace CInterop {

	//public ref class ASMCallingClass
	ref class ASMCallingClass
	{
		public :
		static double ASMMathCalc(double val1, LONGLONG val2)
		{
			return runAsmCalc(val1, val2);
		}
		static int ASMXXTea(LPWSTR fileName, LPDWORD Key, BOOL encode)
		{
			return runAsmXXTea(fileName, Key, encode);
		}
	};
}

Unmanaged code:

#include "Stdafx.h"

	extern "C"
	{
		//int  publicVariable = -2000;
		double AsmMathCalc (double val1, LONGLONG val2);
		int AsmXXTEAEncDec(LPWSTR val1, LPDWORD val2, BOOL val3);
	}

	double runAsmCalc(double val1, LONGLONG val2)
	{
		return AsmMathCalc(val1, val2);
	}
	int runAsmXXTea(LPWSTR fileName, LPDWORD Key, BOOL encode)
	{
		return AsmXXTEAEncDec(fileName, Key, encode);
	}

Just for testing purposes you can add the ASM compiled object file to Properties\Linker\INput\Additional Dependencies, but this will not be used in the final building process because we will build all from the command line.
3) C# Windows Forms Application
In this project add a “using” clause for the C++/CLR namespace. If you have built the C++/CLR class library, you can test now if all is working. If it does not, make public the class ASMCallingClass in the interop project and rebuild the library.

Building
You have three projects in total: The ASM project, the C++/CLR interop project and the C# project.
To be able to build a single executable, you need to compile in dependency order. Native code first, second the interop code and finally the 100% managed code.
Open a console Window with the environment set for Visual Studio x64 compilations, (in the Start menu you may find Visual Studio x64 Win 64 Command Prompt, which is what we need).

1) Compile the ASM with with the JWasm compiler:
<path>\jwasm -c -win64 -Zp8 asmrotines.asm
Note: There are a number of programs able to compile source code Assembly Language, they are called Assemblers. The most popular is MASM from Microsoft. I have not used ML64 (64-bit MASM) though, because it does not support the “invoke” directive in 64-bit mode (and “invoke” speeds up the coding process quite a bit) but JWasm is backward compatible with MASM, so it is easy to make this code compile with ML64 by replacing the “invoke” directives.
You must test the ASM rotines while you code them, because it is very easy to insert bugs in ASM. There are various ways of doing that. For my demo program, I just linked the asmrotines.obj with a test program written in C, under Visual Studio. The reason is that Visual Studio C++ IDE has a built-in disassembler and you can single step the ASM instructions.
2) Copy the compiled ASM file, asmrotines.obj, to the folder where are the source files of your C++/CLR interop project and change your console window to that folder.
3) Compile the native code source file, which has the “native.cpp” name in our project. The command line is:
cl /c /MD native.cpp
The C/C++ compiler will generate the object file “native.obj”
4) Now, compile the managed file, “CInterop.cpp” in our project with the following command line:
cl /clr /LN /MD CInterop.cpp native.obj asmrotines.obj
The /clr switch generates mixed mode code, /LN creates a .netmodule and /MD links with MSVCRT.LIB. Because this module contains a reference to the native code, we also need to pass native.obj and asmrotines.obj so that this file can be passed through to the link line when the compiler invokes the linker to produce the .netmodule. This is basically the explanation given by Mr. Steve Teixeira.
5) Now, copy to the folder where the C# files are, asmrotines.obj, CInterop.obj, native.obj, and CInterop.netmodule and change the console window to that folder.
6) Run the C# compiler with the following command line:
csc /target:module /unsafe /addmodule:cinterop.netmodule Program.cs Form1.cs Form1.Designer.cs  Properties\AssemblyInfo.cs
7) Finally, run the Microsoft Linker to link together all the parts we have been building along the way.
link /LTCG /CLRIMAGETYPE:IJW /ENTRY:Charp.Program.Main /SUBSYSTEM:WINDOWS /ASSEMBLYMODULE:cinterop.netmodule /OUT:NetAndAsm.exe cinterop.obj native.obj asmrotines.obj program.netmodule
And that’s all about it!

Download file Download the full source code

Download fileDownload the .exe file only!

Advertisements

1 Comment »

  1. […] tricks to create the illusion that it is what it is not not. Let’s read my page about “Mixing .Net and Assembly Language in a standalone 64-bit exe” and see how this can be done and in 64-bit (of course can be done in 32-bit as well) […]

    Pingback by Mixing .Net and Assembly Language in a standalone 64-bit exe « Jose's Blog — October 11, 2011 @ 1:44 pm


RSS feed for comments on this post. TrackBack URI

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Blog at WordPress.com.

%d bloggers like this: