How To: compile Dolphin with Intel C++ Composer XE on Windows

[Lectrode]

[]

How to compile with Intel C++ Composer XE on Windows

Last Updated: 2012-04-04

Difficulty level: Moderate
Time to complete: ~2-5 hours. Completion time depends highly on install time of the software, which can take a while.

Required knowledge:
-Must know how to install programs
-Must know how to edit files in a plain text editor (like notepad)
-Must know general "lingo" of the Dolphin Emulator
To make it easy, if you can compile Dolphin the regular way (with VS2010), you probably will be able to compile it with ICC XE.



Legend:
[Win32/x64] -------------> Whatever you're compiling, choose "Win32" OR "x64" and remove square brackets

[x86/x64] -------------> Whatever you're compiling, choose "x86" OR "x64" and remove square brackets

NOTE: If you don't know what the above terms are, go with Win32 and x86



General Requirements:
- WindowsXP SP3 or higher
- Nothing less than 2.1 GHz core2duo CPU
- No less than 3GB RAM
- No less than 10GB free on your Hard Drive.
- About $600 available to buy software.

NOTE: If you can't afford it, you can get the builds for free from my website. You support me and save time and money.



Step 1: Get the Software
A) Visual Studio 2010 Pro
-- yes PRO. There's no known workaround for Express
-- ~$300 to buy
-- According to this site, you can get it from Microsoft DreamSpark for free if you're a student
-- According to this you can get it for free from BizSpark if you're not a student (other requirements apply)

B) Intel C++ Composer (~$250.00 to buy, free to try)

C) msysgit

D) TortoiseGIT

E) Latest DirectX SDK (currently June 2010)

F) Windows SDK *Should be installed by default* (get version that's appropriate for your Operating System if it's not)

G) Latest .NET Framework (Should also be available through Windows Update)



Step 2: Installation
A) Install the latest version of the .NET Framework.

B) Install Windows SDK and DirectX SDK

C) Install msysgit and TortoiseGIT
-- i) Run the msysgit installer
-- ii) When you get to the "Adjusting your PATH environment" step, select the 2nd or 3rd option (2nd recommended)
-- iii) Once you've finished installing that, run the installer for TortoiseGIT


D) Install Visual Studio 2010
-Full Installation
-You may or may not need MSDN Library. I chose to install it.

E) Install Intel C++ Composer
-Full Installation (if IA-64 is disabled in the install, that's ok)





Step 3: Checkout
A) Make a new folder and name it whatever. We'll refer to it as the "Clone Folder."

B) Right-click the folder and select "GIT Clone..."

C) The URL of repository is "https://code.google.com/p/dolphin-emu" without quotes.

D) Once you've entered the url of the repository, Click OK

NOTE: If you got an error concerning the location of a file when you try step 3B, you did not install msysgit correctly.




Step 4: Code Fixes for ICC XE

None right now
-(Go onto the next step)





Step 5: Patches & Hacks (Optional)
A) Right-click your Checkout Folder and go to "TortoiseGit" -> "Git Review patch..."

B) Browse to the .patch file you want to use and click "Open" If a window pops up that says something about wrong directory would you like to use this other one say yes.

C) In the little window titled "File patches [file names...]" right-click one of the file names listed and select "Patch all"

NOTE: if the file names that you want to patch are red that means that the patch code conflicts with the code in those files. You'll have to either manually edit those or get an updated patch. Many patches are obsolete and cannot be used with the latest revisions.

NOTE: You can find a list of hacks and patches as well as what revisions they work with on my site under "Hacks and Patches." This is not a complete list and the newest ones will be under the Code Patches forum.



Step 6: Visual Studio 2010 Settings
A) VC++ Directories:

-- i) Open CloneFolder\Source\Dolphin_2010.sln in VS 2010.

-- ii) Go to View->Property Manger (May be under "Other Windows")

-- iii) Expand Dolphin -> Release | [Win32/x64]

-- iv) Right-click Microsoft.Cpp.[Win32/x64].user and select Properties

-- v) Select Common Properties->VC++ Directories

-- vi) Under Excecutable Directories add "$(DXSDK_DIR)\Utilities\bin\[x86/x64]"

-- vii) Under Include Directories add "$(DXSDK_DIR)\Include"

-- viii) Under Library Directories add "$(DXSDK_DIR)\Lib\[x86/x64]"

-- ix) Click OK

-- x) Right-click Microsoft.Cpp.[Win32/x64].user and select Save Microsoft.Cpp.[Win32/x64].user

B) Right-click Solution 'Dolphin' and select Intel Parallel Composer 2011 -> Use Intel C++

C) Click OK for the pop-up window.

D) Select "Release" and either Win32 or x64.


NOTE: semi-colons are used to separate directory values.

NOTE: Language and SCMRevGen will not update. This is normal.

NOTE: OpenGL performance is killed when compiled with ICC. You'll have to right-click "VideoOGL" and select "Use Visual C++"



Step 7: Project Fixes (Big thx to lannyboy)
A) nullptr:

-- i) Select all of the projects except Language and SCMRevGen

-- ii) Right-click them and select Properties

-- iii) Under Configuration Properties -> C/C++ -> Command Line add the following:

Code:

/Qstd=c++0x /D "nullptr=0"

and click OK

B) psapi.lib:

-- i) Go to your DSPTool and Dolphin project file and right click.

-- ii) Select Properties.

-- iii) Go to Configuration Properties -> Linker -> Input .

-- iv) At Addditional Dependencies column, APPEND "psapi.lib;" infront of the line.

C) Precompiled Headers (Only needed for if the build fails and you get "Backend Signal" errors):

-- i) Go to your Dolphin project file and right click.

-- ii) Select Properties.

-- iii) Under C/C++ go to Precompiled Beaders

-- iv) Set Precompiled Header to Not Using Precompiled Header





Step 8: Adding SSE Switches (Optional)
A) Select all Projects in the Solution Explorer except Language and SCMRevGen, right-click them, and select click "Properties"

B) Under C++ -> Code Generation, you can set the Instruction Set used (ie SSE2, SSE3, SSSE3, SSE4.1, or SSE4.2).
-For Intel processors only: Set "Intel Processor-Specific Optimization"
-For all processors that support SSE instructions: Set "Add Processor-Optimized Code Path"

C) Click OK to apply settings.


Step 9: Compile
A) Right-click "Solution 'Dolphin_2010'" and select "Rebuild"


You should end up with XX Succeeded, 0 failed, and X skipped.
If you do not, one of 3 things may be the case:
1) you missed one or more instructions in this tutorial
2) their are specific settings needed for the revision you are trying to compile
3) That particular revision is broken and cannot be built


Common Errors:
If you are not using an English OS and get error #13000, go here.
If you get "out of memory" errors read this


Step 10: Have Fun!
A) Where's my build?!
- It's under CloneFolder\Binary\[Win32\x64]\
-Just run "Dolphin[].exe" (the [] stands for various things that may be appended, such as "FS" or "D" or nothing)

NOTE: Now that you know how to do this, you can find out what additional optimizations work for you! You can test your builds against mine to see if yours has a faster, slower, or about the same frame rate (remember to test the same rvsn number builds!)

Final words: (can anyone guess what they are lol) Free builds at my website! Go there, support me! yada yada yada... What better purpose for a tutorial than to advertise one's work lol

[admin89]

Very useful post ,that sure help me alot,thanks
*5 star*

[Lectrode]

(06-17-2010, 07:25 PM)admin89 Wrote: Very useful post ,that sure help me alot,thanks
*5 star*

Lol thanks. Glad to help.

[blackJade]

Actually, Window SDK is optional...
with or without I think is ok....
And for 2) "VCEnd" fix (R5637 and later)
Here is a simpile way:
Open the solution in Visual Studio->Make sure you are choosing Release Mode->
Right click the "Common" or "Dolphin" project->choose Properties->
Select build event and edit the Command line->you will have this:

set outfile="$(ProjectDir)..\Common\Src\svnrev.h"
"$(ProjectDir)..\Common\SubWCRev.exe" "$(SolutionDir)\." "$(ProjectDir)..\Common\Src\svnrev_template.h" %outfile%
if errorlevel 1 (goto checkhg) else (goto VCEnd)
:checkhg
for /f "usebackq tokens=1,* skip=3" %%i in (`hg svn info`) do (
echo Hg: Working copy at SVN revision %%j
echo #define SVN_REV %%j > %outfile%
echo #define SVN_REV_STR "%%j" >> %outfile%
goto VCEnd
)

change (goto VCEnd) into (goto finish) and goto VCEnd into :finish, so it will become this:

set outfile="$(ProjectDir)..\Common\Src\svnrev.h"
"$(ProjectDir)..\Common\SubWCRev.exe" "$(SolutionDir)\." "$(ProjectDir)..\Common\Src\svnrev_template.h" %outfile%
if errorlevel 1 (goto checkhg) else (goto finish)
:checkhg
for /f "usebackq tokens=1,* skip=3" %%i in (`hg svn info`) do (
echo Hg: Working copy at SVN revision %%j
echo #define SVN_REV %%j > %outfile%
echo #define SVN_REV_STR "%%j" >> %outfile%
:finish
)

You need to do 2 times, 1 for "Common" and 1 for "Dolphin" project

BTW, for non-English OS user who getting the warning #13000: could not open message catalog file: diagscUI.dll,
here is the solution(remove or not will not affect the build):
1. Go to Settings->Control Panel->Regional and Language Options, see "Regional Options" tab.
2. Determine which language is selected inside "Standards and formats" group. Probably not English (United States).
3. Determine which decimal value (Locale ID) corresponds to selected language. E.g. Russian is 1049; Ukrainian is 1058. How to determine Locale ID? An MSDN article named "Locale ID (LCID) Chart" could help http://msdn.microsoft.com/en-us/library/0h88fahh(VS.85).aspx
4. Locate C:\Program Files\Intel\Compiler\11.1\065\ia32 (for 32-bit) and \intel64 folder (for 64-bit), you will see there a folder named "1033" - there are files localized for English (United States).
5. Make a copy of this folder, then rename it with Locale ID found in step 3.
Now warning #13000 should disappear!

[darkshadw]

Good guides here!

[Lectrode]

(06-17-2010, 08:38 PM)blackJade Wrote: {Insert info here}

First, the VCEnd fix:
Thx for the info! Always good to have multiple ways of doing something.

Second: Non-English speaking fix:
Very nice! I would never have known that because I only use English. Thx!

(06-17-2010, 09:19 PM)darkshadw Wrote: Good guides here!

Thanks!

[thaCASHdude]

pretty cool guide there!

[Lectrode]

(06-18-2010, 09:36 AM)thaCASHdude Wrote: pretty cool guide there!

thx!

[disraelie]

I tried, but fail to build with ssex
I give up !
thanks lol~

[Lectrode]

(06-18-2010, 05:56 PM)disraelie Wrote: I tried, but fail to build with ssex
I give up !
thanks lol~

"I give up !"

There are always people here who are willing to help if you choose to try again!