AxBuild.exe for Parallel Compile on AOS of X++ to p-code [AX 2012]

Applies To: Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2
AxBuild.exe can accomplish a full compile of all X++ code, into AX p-code, many times faster than the traditional compile that you start from the MorphX client menu. AxBuild.exe is run on the Application Object Server (AOS) tier at acmd.exe command prompt. This topic explains what AxBuild.exe does and how to use it.
The AxBuild.exe utility program involves compiles to p-code only, and it does not go further by compiling to .NET Framework CIL.
AxBuild.exe became available in cumulative update 7 for Microsoft Dynamics AX 2012 R2.
Caution noteCaution
You should stop the AOS service before you start AxBuild.exe. Otherwise in certain scenarios, the AxBuild.exe service might provide outdated metadata or outdated p-code to the compile process.

A.  General Architecture

A.1  Compiling on the Server Tier

AxBuild.exe is installed in the same directory with ax32serv.exe, which is the program name for the AOS. Despite the 32 in its name, ax32serv.exe is a 64 bit program. As a 64 bit program, ax32serv.exe can address much more active memory than the 32 bit client ax32.exe can. The larger amount of active memory might be important for full X++ compiles that involve an extremely large amount of X++ source code.
AxBuild.exe starts several new but temporary instances of the AOS. From the Registry, each temporary AOS uses the same configuration information that is used by a permanent AOS that you identify with the /aos parameter. This is one reason why AxBuild.exe must be run by an account that has no less security authority than the account that runs the permanent AOS has.
Server config displays the AOS instance number
Server configuration displays the AOS instance number for the /aos parameter
AxBuild.exe coordinates the work of every temporary AOS that it starts. It tells each AOS which pieces of the full X++ compile to accomplish. It gathers the results from each AOS and reports them to the console and a log file.
X++ on the AOS tier with AxBuild.exe
Architecture of the X++ compile on the AOS tier
An earlier compile option involved new but temporary instances of ax32serv.exe to which you could pass a now obsolete parameter. The obsolete parameter is shown in the following command line:
 ax32serv.exe -startupcmd=CompileAll.

A.2  Contrast with Compiling on the Client

In the past to accomplish a full X++ compile you had to click a menu in the MorphX client, such as Build > Compile. This is a three tier operation which is burdened with transferring data between the client and the AOS. In contrast, the AxBuild.exe approach is only a two tier operation. One reason the AxBuild.exe approach is faster is that it eliminates the data transfers over the network, or over local RPCs, between the AOS and the client.
Compiling on the client does not provide any way to share the workload among several applications. In contrast, AxBuild.exe starts several AOS applications which all run concurrently, which all accomplish parts of the full compile.
As a matter of common practice, the AOS host computer hardware is often more powerful than client computers are. The AOS host typically has more active memory, and has more cores for parallel processing.
Architecture of X++ compile on the client tier
Architecture of the X++ compile on the client tier
The MorphX client you can quickly compile an individual X++ method. These partial compilations are extremely efficient for the developer who is adding and fixing a method through cycles of coding then testing. In contrast,AxBuild.exe cannot compile any mere subset of the X++ code on the system.
The MorphX client remains the only option for compiling AX p-code to .NET CIL.

B.  Performance Gain

In this section we present performance data for AxBuild.exe. Every environment is different, and the performance speeds we see in our tests probably differ from what you see.
In our performance test of AxBuild.exe, we measured a 92% reduction in the wall clock time that was necessary to complete a full X++ compilation. Stated another way, AxBuild.exe completed the compilation 13 times faster than the MorphX client did on the same hardware. The software and hardware specifications for our test were as follows:
  • One server computer that had both AX client and AOS installed, and had SQL installed:
    • Microsoft Dynamics AX 2012 R2 with cumulative update 7.
    • Microsoft SQL Server 2012 SP1 Enterprise (no limit on memory).
    • Microsoft Windows Server 2012.
  • The computer hardware had the following specifications:
    • 4 processor cores, at 3.7 gigahertz.
    • Hyper-threading enabled, which logically doubles the number of cores.
    • 32 gigabytes of active memory.
    • 6.0 gigabits SATA controller.
    • Virtual page caching disabled.
Given the hardware available, AxBuild.exe decided to start 9 temporary AOS workers.
The wall clock time for AxBuild.exe was compared to the time for a legacy client-side full X++ compile. The results were as follows:
  • AxBuild.exe:    10.7 minutes.
  • MorphX client:    146.0 minutes.
  • 146.0  /  10.7  =  13.6
From another measurement we took, a single AOS worker runs 28% faster for not having to transfer information to the MorphX client and back during the full compile.

C.  How to Run AxBuild.exe

Preparations
The following preparations are necessary before you can run AxBuild.exe:
  • You must have completed the installation of cumulative update 7 for Microsoft Dynamics AX 2012 R2. This must include a re-initialization of the model store database that you run manually, by using either axutil.exe schemaor the newer PowerShell equivalent. For more information, see Apply updates to database, AOS, and clients or How to: Create, Drop, or Reinitialize a Model Store.
  • You must ensure that the account which will run AxBuild.exe has no less authority than has the account that runs the permanent AOS.
  • You must ensure that the option for the hot-swapping of .NET assemblies is turned off in the AOS configuration you choose to use. See the /aos parameter on AxBuild.exe.
  • You must establish and populate the directory that will be referred to by the /altbin parameter.
Example Command Line
Here is an example command line for AxBuild.exe that might match the command line you need in your particular environment. The line is artificially wrapped here for better display.
axbuild.exe  xppcompileall  /s=01
     /altbin="C:\Program Files (x86)\Microsoft Dynamics AX\6.0\Client\Bin"

D.  Outputs from AxBuild.exe

D.1  Outputs to the Console

AxBuild.exe reports its progress to the console through the stdout handle. The stderr handle is not used.
Each AOT element is reported at the moment it is compiled. Some elements can be reported repeatedly at different times before they successfully compile. These repetitions are sometimes necessary because full metadata is not always available to satisfy all dependencies until later phases of the compilation.

D.2  Output Log Files

AxBuild.exe generates two log files. You can control where the log files are written by using the /log parameter. By default the files are written to the Server\...\Log\ subdirectory under the installation directory of the AOS. Here is a common example of what the specific default path might be:

 C:\Program Files\Microsoft Dynamics AX\60\Server\MicrosoftDynamicsAX\Log\
The following table describes the two log files.
File name
Description
AxCompileAll.html
Contains the final list of compile errors in XML format.
You can import the file into the MorphX development environment by following these steps:
  1. In the AOT, right-click any method node under a class, and click Compile.
    This displays the Compiler output pane.
  2. Click the >> icon on the Compiler output pane.
    The icon is located near the upper-right on the pane. The icon might be hidden if your pane size is too narrow.
  3. Click Import.
    This displays the Import compile log dialog.
  4. Navigate to the Server\...\Log\ directory to find the log file, and then click Open.
After the log file is imported, you can examine and fix each compile error just as if the errors had been logged by the compiler on the client tier.
AOTCompile.log
Contains information that partly duplicates the information that is written to the console.

D.3  Temporary Files

AxBuild.exe writes temporary files to the %TEMP% directory. These files include many details about the process. By default these files are deleted by AxBuild.exe shortly before it ends. However, you can keep the files by using the/nocleanup parameter.

E.  Parameters for AxBuild.exe

The parameter names are not case-sensitive.
In all cases where the parameter name takes an accompanying value, an = sign is used to join them together, as for example /aos=01.
AxBuild.exe always returns 0.

E.1  Description of Each Parameter

The following table describes the parameters that you can or must pass into AxBuild.exe.
Name
Alias
Required?
Description
xppcompileall
No short alias.
Required.
Tells the program do a full compile on all X++ code, which creates all new p-code to be stored in the model store database.
This parameter name has no accompanying value, and no leading '/'.
This parameter is a command to tell the program the type of action to perform. So far it is the only command parameter.
/altbin
/a
Optional.
Path to the folder on the local AOS host computer that has the DLL files which are installed with an ax32.exe client. AxBuild.exe verifies thatax32.exe is in the directory before it proceeds with the compile action.
A good path to use might be the path that the client install would typically create. You must confirm the exact correct path for your particular environment:

 C:\Program Files(x86)\Microsoft Dynamics AX\6.0\Client\Bin\
One way to create and populate such a directory path is to install the client onto the AOS host computer, even though maybe no person would use the client on that host.
Thereafter, any developers who add a third party DLL to their own client directory must ensure that the DLL is manually copied to this corresponding directory on each AOS where this program might be run.
If the ax32.exe client is not installed onto the AOS host computer, this manually created directory must be initially populated manually with all the DLL files from a client installation on another computer.
If you omit this parameter, AxBuild.exe examines the Microsoft Dynamics AX client configuration information in the Windows Registry in an attempt to find the correct path.
/aos
/s
Often optional.
Instance number of an AOS that is installed on the same computer where this program runs.
If you omit this parameter, AxBuild.exe examines the Microsoft Dynamics AX server configuration information in the Windows Registry. If the Registry contains information about exactly one AOS instance, that information is used as the default value for this parameter.
The temporary instances of the AOS all use the same configuration specifications that this AOS instance number uses.
To see a list of all available instance numbers, run the Microsoft Dynamics AX Server Configuration Utility, AxSrvCfg.exe. At the top of its window is a drop-down list that is labeled Application Object Server Instance. Perhaps the most commonly used value is 01, as in /aos=01.
The parameters /dbserver and /modelstore are available in case you need to override those parts of the AOS instance configuration information.
/compiler
/c
Sometimes required.
This /c parameter might be absent from the report that is generated by the /help parameter, but /c is fully supported.
You need this parameter only when the current directory is not the directory where ax32serv.exe resides. In this case the value of the parameter must be the name ax32serv.exe preceded by its directory path. A realistic example might be the following value:

 /compiler="C:\Program Files\Microsoft Dynamics AX\6.0\Server\bin\ax32serv.exe"
Full compiles that are started by automation might be relatively likely to need this parameter.
/dbserver
/d
Optional.
The name of the Microsoft SQL Server instance that manages the AX model store database.
Typically this parameter is not used. Instead the program is allowed to obtain this information from the configuration it obtains from the AOS instance that is referenced by the /aos parameter.
/help
/h or /?
Optional.
Writes brief descriptions about all parameters to the stdout handle of the console.
This parameter name has no accompanying value.
This parameter is implied if no parameters are supplied.
If there are any discrepancies between this topic and the /help output, this topic is correct.
/log
/l
Optional.
Specifies the directory path to which the two log files are written.
The default path is the Server\...\Log\ directory under the installation location of the AOS. More exactly, the default value is stored in the Registry at the following location:
 HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\services\
 Dynamics Server\6.0\01\Original (installed configuration) , in logdir.
The /log parameter does not specify the name of a file. It specifies a path.
The /verbose parameter affects how much information is written to this log file.
/modelstore
/m
Optional.
Name of the model store database.
Typically this parameter is not used. Instead the program is allowed to use the value it obtains from the configuration as directed by the /aos parameter.
/nocleanup
/n
Optional.
Tells the program to keep the temporary files it writes under the %TEMP% directory.
This parameter name has no accompanying value.
Without this parameter, the default behavior is for the program to delete the temporary files immediately before it ends its run.
/verbose
/v
Optional.
Tells the program to write all the tracing and diagnostic information that it has to stdout, and to the AOTComp.log file. Without this parameter, less information is written.
This parameter name has no accompanying value.
Usually the program writes only the subset of information that a person typically might want to watch scroll by on the screen in the cmd.exewindow.
/workers
/w
Optional.
Number of parallel or concurrent AOS workers for the compilation and build processes.
The program calculates a sensible integer value based on the number of available processor cores. But you might want to fine tune this value. A rough approximation might be 1.4 workers per core.

F.  Constraints of Compiling on the AOS

F.1  .NET Objects Cannot be Instantiated

When the X++ compiler starts, it performs special compiles on a few special classes. These classes include Application, Infolog, and ClassFactory. When these special classes are compiled during a compile on the AOS tier, they fail if any custom code has been added to them that makes interop calls to the .NET Framework.
We generally recommend that you not customize the methods in these special classes.

F.2  Calls to COM Objects Cannot be Chained

In X++ you can sometimes chain together a series of method calls by using the following syntax:

 myThing.method8().method9();

This chaining syntax is valid only if the return type from method8 has a method named method9.
When you compile by using AxBuild.exe, the syntax of method chaining cannot be used with COM objects. The compiler cannot ascertain whether the COM object that is returned by method8 has a method named method9.
The simple solution is to use another common syntax that explicitly gives the compiler the type information it needs to validate the call to method9. The situation is explained in the following table.
Outcome
Explanation
Code example
Example that Fails
This X++ code example syntactically chains the method2 call to the end of the method1 call. The server compiler reports an error for the method2call.
Underlying Details: Often COM objects that are called by X++ code are installed only on the client tier, and are not installed on the server tier. In the preceding code example, the underlying problem is that the server compiler cannot know the return type from method1. Its return type could be another COM object or just an integer. If the return type from method1 were an integer, the chained call to method2 would certainly be invalid. The compiler issues an error because it cannot prove that method1 returns another COM object.
X++
void methodXpp()
{
    COM comInstanceA = new COM("MyCOMType_A");
    comInstanceA.method1().method2();
}
Example thatSucceeds
This X++ code example eliminates the chain, and succeeds.
Underlying Details: In the preceding code example, the server compiler is told by an explicit type declaration that variable comInstanceB is a COM object. This gives the compiler justification to insert a call to the dispatch method for method2.
X++
void methodXpp()
{
    COM comInstanceA = new COM("MyCOMType_A");
    COM comInstanceB;
    comInstanceB = comInstanceA.method1();
    comInstanceB.method2();
}

G.  Screenshots during Execution of AxBuild.exe

This section contains screenshots that were taken during a test run of AxBuild.exe. The run was to test for correct functional behavior on a minimal virtual machine that has only one processor. For the test we specified /workers=2 to tell AxBuild.exe to start two temporary AOS workers. Therefore, for this test we expected the compilation to take a long time.
The following screenshot shows the cmd.exe console in which AxBuild.exe was started, including its output which mentions each phase.
Console for AxBuild.exe
The next screenshot shows the cmd.exe console that was started for a temporary AOS worker.
Console for a temporary AOS, for AxBuild.exe
The next screenshot shows the AxBuild.exe and temporary AOS processes in Task Manager.
Task Manager displaying two temporary AOS's
The next screenshot shows the browser that displays the contents of the AxCompileAll.html log file, which reported two warnings.
Display of AxCompileAll.html log file
The next screenshot shows a list of the temporary files that AxBuild.exe created in the %TEMP% directory. These *.tmp files were kept only because the /nocleanup parameter was specified.
Files in the %TEMP% dir kept by /nocleanup

H.  MorphX Client Menus for Compiling

AxBuild.exe adds one more mechanism that you can use to compile X++ code. In the MorphX client there are several menus that you can use to compile X++. The following table describes these menus.
Menu path
Description
Save button on the X++ code editor
Incremental compile of the X++ source code that is in the editor pane. The compile is to AX p-code.
However, no compile occurs if the source code has not changed after it was most recently compiled.
AOT > Classes > YourClass > YourMethod. Right-click YourMethod, and then click Compile.
Incremental compile of the targeted X++ source code to AX p-code.
The compile does occur even if the code has not changed after it was most recently compiled.
Menu Build > Compile, or press F7.
Full compile of X++ to AX p-code.
The full compile occurs regardless of whether the X++ source code has changed after it was most recently compiled.
This is the client option that is most similar to AxBuild.exe.
Right-click AOT, and then click Compile.
Same as menu Build > Compile.
Right-click AOT, and then click Add-Ins, and finally click either of the following:
  • Full CIL generation from X++
  • Incremental CIL generation from X++
The CIL generation takes as input the AX p-code, not any X++ source code.
These CIL generations occur even if the p-code has not changed after the p-code was most recently compiled from X++.

Announcements: To see known issues and recent fixes, use Issue search in Microsoft Dynamics Lifecycle Services (LCS).

Community Additions

ADD

Location of default client binaries

The default location for client binaries appears to be (not 6.0):

altbin="C:\Program Files (x86)\Microsoft Dynamics AX\60\Client\Bin"
Paul A. Noakes
2/11/2014

AXBuild compile errors

If you import AxAllCompile.HTML in the AX compiler output form, you can not use the "Recompile all" function as it stops after compiling a few forms. Instead use the function "Create project", which creates a private project of the elements, and then just compile the project.
Claus Ø. Thomsen
1/15/2014

Tested with CU6 App and wokrs just as well

Excellent addition to AX, and also worked by updating just the binaries whilst leaving the code from CU6

I got 21 minutes compiles before updating the ModelStore schema and 12 minute compiles after issuing the Initialize-AXModelStore powershell command, on a Virtual 4 core 3.4GHz, 24GB memory machine running on an SSD drive.



AAngelides
11/19/2013

Mistake in the article

In the section's MorphX Client Menus for Compiling  table, second row lists the folowing


AOT
 >
Classes
 >
YourClass
 >
YourMethod
. Right-click
YourMethod
, and then click
Compile Incremental
.


It should be Compile. There are no Compile Incremental option.
Evaldas L
11/15/2013

Compiler Not Found

Hi Corey

There are two options you can use to run the AXBuild.exe tool command:

1) Execute the AXBuild.exe tool from the same location where your Ax32Serv.exe is placed by the setup.  The setup install the AXBuild.exe and the Ax32Serv.exe in the same path.

2) However for build automation 1) may not be an option. If that is the case, you need to use the /c argument to specify the path and name of the compiler as follows:

              > <path where the server binaries are installed>\AXBuild.exe   ...  /c=<path where the server binaries are installed>\Ax32Serv.exe

Note: you have the specify the name of the server binary Ax32Serv.exe as part of the value to the argument /c

"..." in the the sample means the rest of the arguments you need to provide.
Marcos Calderon M
11/13/2013

Tried it on CU6 application (Kernel @ CU7)

It spins 3 workers out but looks like each worker processed all objects anyway.

Having said that, it still seems to have halved the compile time.
Dolee
11/8/2013

Cumulative Update 7 (cu7) is required.

Yes, the AXBuild.exe tool is only available in cu7 and future cumulative updates for Ax 2012 R2.
axtools
11/6/2013

CU7 required?

Hi, is CU7 a mandatory requirement for this utility or can it be separated out from the CU7 install package and executed against an earlier version of AX 2012 R2?
/Tomas
Tomas Viklund
11/6/2013

This is awesome !!!

Very good job microsoft!
Haris Kulaglic
11/6/2013

Good job

Very good Job with this tool. I reduced the compile time in my workstation (not a server) by 10 times, compiling with 9 workers (6 processors).
José A. Estevan
11/5/2013

Nice improvement

Compiled on a four core 2.2GHz CPU and we got 27 minutes. A nice improvement. :-)
Arnór
11/4/2013

No comments:

Post a Comment

Note: Only a member of this blog may post a comment.

Subscribe to: Post Comments (Atom)