# Optimizing Serial Code

##### Chris Rackauckas

##### September 3rd, 2019

## Youtube Video Link Part 1

## Youtube Video Link Part 2

At the center of any fast parallel code is a fast serial code. Parallelism is made to be a performance multiplier, so if you start from a bad position it won't ever get much better. Thus the first thing that we need to do is understand what makes code slow and how to avoid the pitfalls. This discussion of serial code optimization will also directly motivate why we will be using Julia throughout this course.

## Mental Model of a Memory

To start optimizing code you need a good mental model of a computer.

### High Level View

At the highest level you have a CPU's core memory which directly accesses a L1 cache. The L1 cache has the fastest access, so things which will be needed soon are kept there. However, it is filled from the L2 cache, which itself is filled from the L3 cache, which is filled from the main memory. This bring us to the first idea in optimizing code: using things that are already in a closer cache can help the code run faster because it doesn't have to be queried for and moved up this chain.

When something needs to be pulled directly from main memory this is known as a *cache miss*. To understand the cost of a cache miss vs standard calculations, take a look at this classic chart.

(Cache-aware and cache-oblivious algorithms are methods which change their indexing structure to optimize their use of the cache lines. We will return to this when talking about performance of linear algebra.)

### Cache Lines and Row/Column-Major

Many algorithms in numerical linear algebra are designed to minimize cache misses. Because of this chain, many modern CPUs try to guess what you will want next in your cache. When dealing with arrays, it will speculate ahead and grab what is known as a *cache line*: the next chunk in the array. Thus, your algorithms will be faster if you iterate along the values that it is grabbing.

The values that it grabs are the next values in the contiguous order of the stored array. There are two common conventions: row major and column major. Row major means that the linear array of memory is formed by stacking the rows one after another, while column major puts the column vectors one after another.

*Julia, MATLAB, and Fortran are column major*. Python's numpy is row-major.

A = rand(100,100) B = rand(100,100) C = rand(100,100) using BenchmarkTools function inner_rows!(C,A,B) for i in 1:100, j in 1:100 C[i,j] = A[i,j] + B[i,j] end end @btime inner_rows!(C,A,B)

13.700 μs (0 allocations: 0 bytes)

function inner_cols!(C,A,B) for j in 1:100, i in 1:100 C[i,j] = A[i,j] + B[i,j] end end @btime inner_cols!(C,A,B)

8.300 μs (0 allocations: 0 bytes)

### Lower Level View: The Stack and the Heap

Locally, the stack is composed of a *stack* and a *heap*. The stack requires a static allocation: it is ordered. Because it's ordered, it is very clear where things are in the stack, and therefore accesses are very quick (think instantaneous). However, because this is static, it requires that the size of the variables is known at compile time (to determine all of the variable locations). Since that is not possible with all variables, there exists the heap. The heap is essentially a stack of pointers to objects in memory. When heap variables are needed, their values are pulled up the cache chain and accessed.

### Heap Allocations and Speed

Heap allocations are costly because they involve this pointer indirection, so stack allocation should be done when sensible (it's not helpful for really large arrays, but for small values like scalars it's essential!)

function inner_alloc!(C,A,B) for j in 1:100, i in 1:100 val = [A[i,j] + B[i,j]] C[i,j] = val[1] end end @btime inner_alloc!(C,A,B)

289.597 μs (10000 allocations: 625.00 KiB)

function inner_noalloc!(C,A,B) for j in 1:100, i in 1:100 val = A[i,j] + B[i,j] C[i,j] = val[1] end end @btime inner_noalloc!(C,A,B)

6.880 μs (0 allocations: 0 bytes)

Why does the array here get heap-allocated? It isn't able to prove/guarantee at compile-time that the array's size will always be a given value, and thus it allocates it to the heap. `@btime`

tells us this allocation occurred and shows us the total heap memory that was taken. Meanwhile, the size of a Float64 number is known at compile-time (64-bits), and so this is stored onto the stack and given a specific location that the compiler will be able to directly address.

Note that one can use the StaticArrays.jl library to get statically-sized arrays and thus arrays which are stack-allocated:

using StaticArrays function static_inner_alloc!(C,A,B) for j in 1:100, i in 1:100 val = @SVector [A[i,j] + B[i,j]] C[i,j] = val[1] end end @btime static_inner_alloc!(C,A,B)

8.333 μs (0 allocations: 0 bytes)

### Mutation to Avoid Heap Allocations

Many times you do need to write into an array, so how can you write into an array without performing a heap allocation? The answer is mutation. Mutation is changing the values of an already existing array. In that case, no free memory has to be found to put the array (and no memory has to be freed by the garbage collector).

In Julia, functions which mutate the first value are conventionally noted by a `!`

. See the difference between these two equivalent functions:

function inner_noalloc!(C,A,B) for j in 1:100, i in 1:100 val = A[i,j] + B[i,j] C[i,j] = val[1] end end @btime inner_noalloc!(C,A,B)

6.900 μs (0 allocations: 0 bytes)

function inner_alloc(A,B) C = similar(A) for j in 1:100, i in 1:100 val = A[i,j] + B[i,j] C[i,j] = val[1] end end @btime inner_alloc(A,B)

10.700 μs (2 allocations: 78.17 KiB)

To use this algorithm effectively, the `!`

algorithm assumes that the caller already has allocated the output array to put as the output argument. If that is not true, then one would need to manually allocate. The goal of that interface is to give the caller control over the allocations to allow them to manually reduce the total number of heap allocations and thus increase the speed.

### Julia's Broadcasting Mechanism

Wouldn't it be nice to not have to write the loop there? In many high level languages this is simply called *vectorization*. In Julia, we will call it *array vectorization* to distinguish it from the *SIMD vectorization* which is common in lower level languages like C, Fortran, and Julia.

In Julia, if you use `.`

on an operator it will transform it to the broadcasted form. Broadcast is *lazy*: it will build up an entire `.`

'd expression and then call `broadcast!`

on composed expression. This is customizable and documented in detail. However, to a first approximation we can think of the broadcast mechanism as a mechanism for building *fused expressions*. For example, the Julia code:

A .+ B .+ C;

under the hood lowers to something like:

map((a,b,c)->a+b+c,A,B,C);

where `map`

is a function that just loops over the values element-wise.

**Take a quick second to think about why loop fusion may be an optimization.**

This about what would happen if you did not fuse the operations. We can write that out as:

tmp = A .+ B tmp .+ C;

Notice that if we did not fuse the expressions, we would need some place to put the result of `A .+ B`

, and that would have to be an array, which means it would cause a heap allocation. Thus broadcast fusion eliminates the *temporary variable* (colloquially called just a *temporary*).

function unfused(A,B,C) tmp = A .+ B tmp .+ C end @btime unfused(A,B,C);

12.400 μs (4 allocations: 156.34 KiB)

fused(A,B,C) = A .+ B .+ C @btime fused(A,B,C);

7.075 μs (2 allocations: 78.17 KiB)

Note that we can also fuse the output by using `.=`

. This is essentially the vectorized version of a `!`

function:

D = similar(A) fused!(D,A,B,C) = (D .= A .+ B .+ C) @btime fused!(D,A,B,C);

5.150 μs (0 allocations: 0 bytes)

### Note on Broadcasting Function Calls

Julia allows for broadcasting the call `()`

operator as well. `.()`

will call the function element-wise on all arguments, so `sin.(A)`

will be the elementwise sine function. This will fuse Julia like the other operators.

### Note on Vectorization and Speed

In articles on MATLAB, Python, R, etc., this is where you will be told to vectorize your code. Notice from above that this isn't a performance difference between writing loops and using vectorized broadcasts. This is not abnormal! The reason why you are told to vectorize code in these other languages is because they have a high per-operation overhead (which will be discussed further down). This means that every call, like `+`

, is costly in these languages. To get around this issue and make the language usable, someone wrote and compiled the loop for the C/Fortran function that does the broadcasted form (see numpy's Github repo). Thus `A .+ B`

's MATLAB/Python/R equivalents are calling a single C function to generally avoid the cost of function calls and thus are faster.

But this is not an intrinsic property of vectorization. Vectorization isn't "fast" in these languages, it's just close to the correct speed. The reason vectorization is recommended is because looping is slow in these languages. Because looping isn't slow in Julia (or C, C++, Fortran, etc.), loops and vectorization generally have the same speed. So use the one that works best for your code without a care about performance.

(As a small side effect, these high level languages tend to allocate a lot of temporary variables since the individual C kernels are written for specific numbers of inputs and thus don't naturally fuse. Julia's broadcast mechanism is just generating and JIT compiling Julia functions on the fly, and thus it can accommodate the combinatorial explosion in the amount of choices just by only compiling the combinations that are necessary for a specific code)

### Heap Allocations from Slicing

It's important to note that slices in Julia produce copies instead of views. Thus for example:

A[50,50]

0.10904749575236439

allocates a new output. This is for safety, since if it pointed to the same array then writing to it would change the original array. We can demonstrate this by asking for a *view* instead of a copy.

@show A[1] E = @view A[1:5,1:5] E[1] = 2.0 @show A[1]

A[1] = 0.4524148556459875 A[1] = 2.0 2.0

However, this means that `@view A[1:5,1:5]`

did not allocate an array (it does allocate a pointer if the escape analysis is unable to prove that it can be elided. This means that in small loops there will be no allocation, while if the view is returned from a function for example it will allocate the pointer, ~80 bytes, but not the memory of the array. This means that it is O(1) in cost but with a relatively small constant).

### Asymptotic Cost of Heap Allocations

Heap allocations have to locate and prepare a space in RAM that is proportional to the amount of memory that is calculated, which means that the cost of a heap allocation for an array is O(n), with a large constant. As RAM begins to fill up, this cost dramatically increases. If you run out of RAM, your computer may begin to use *swap*, which is essentially RAM simulated on your hard drive. Generally when you hit swap your performance is so dead that you may think that your computation froze, but if you check your resource use you will notice that it's actually just filled the RAM and starting to use the swap.

But think of it as O(n) with a large constant factor. This means that for operations which only touch the data once, heap allocations can dominate the computational cost:

using LinearAlgebra, BenchmarkTools function alloc_timer(n) A = rand(n,n) B = rand(n,n) C = rand(n,n) t1 = @belapsed $A .* $B t2 = @belapsed ($C .= $A .* $B) t1,t2 end ns = 2 .^ (2:11) res = [alloc_timer(n) for n in ns] alloc = [x[1] for x in res] noalloc = [x[2] for x in res] using Plots plot(ns,alloc,label="=",xscale=:log10,yscale=:log10,legend=:bottomright, title="Micro-optimizations matter for BLAS1") plot!(ns,noalloc,label=".=")

However, when the computation takes O(n^3), like in matrix multiplications, the high constant factor only comes into play when the matrices are sufficiently small:

using LinearAlgebra, BenchmarkTools function alloc_timer(n) A = rand(n,n) B = rand(n,n) C = rand(n,n) t1 = @belapsed $A*$B t2 = @belapsed mul!($C,$A,$B) t1,t2 end ns = 2 .^ (2:7) res = [alloc_timer(n) for n in ns] alloc = [x[1] for x in res] noalloc = [x[2] for x in res] using Plots plot(ns,alloc,label="*",xscale=:log10,yscale=:log10,legend=:bottomright, title="Micro-optimizations only matter for small matmuls") plot!(ns,noalloc,label="mul!")

Though using a mutating form is never bad and always is a little bit better.

### Optimizing Memory Use Summary

Avoid cache misses by reusing values

Iterate along columns

Avoid heap allocations in inner loops

Heap allocations occur when the size of things is not proven at compile-time

Use fused broadcasts (with mutated outputs) to avoid heap allocations

Array vectorization confers no special benefit in Julia because Julia loops are as fast as C or Fortran

Use views instead of slices when applicable

Avoiding heap allocations is most necessary for O(n) algorithms or algorithms with small arrays

Use StaticArrays.jl to avoid heap allocations of small arrays in inner loops

## Julia's Type Inference and the Compiler

Many people think Julia is fast because it is JIT compiled. That is simply not true (we've already shown examples where Julia code isn't fast, but it's always JIT compiled!). Instead, the reason why Julia is fast is because the combination of two ideas:

Type inference

Type specialization in functions

These two features naturally give rise to Julia's core design feature: multiple dispatch. Let's break down these pieces.

### Type Inference

At the core level of the computer, everything has a type. Some languages are more explicit about said types, while others try to hide the types from the user. A type tells the compiler how to to store and interpret the memory of a value. For example, if the compiled code knows that the value in the register is supposed to be interpreted as a 64-bit floating point number, then it understands that slab of memory like:

Importantly, it will know what to do for function calls. If the code tells it to add two floating point numbers, it will send them as inputs to the Floating Point Unit (FPU) which will give the output.

If the types are not known, then... ? So one cannot actually compute until the types are known, since otherwise it's impossible to interpret the memory. In languages like C, the programmer has to declare the types of variables in the program:

```
void add(double *a, double *b, double *c, size_t n){
size_t i;
for(i = 0; i < n; ++i) {
c[i] = a[i] + b[i];
}
}
```

The types are known at compile time because the programmer set it in stone. In many interpreted languages Python, types are checked at runtime. For example,

```
a = 2
b = 4
a + b
```

when the addition occurs, the Python interpreter will check the object holding the values and ask it for its types, and use those types to know how to compute the + function. For this reason, the add function in Python is rather complex since it needs to decode and have a version for all primitive types!

Not only is there runtime overhead checks in function calls due to to not being explicit about types, there is also a memory overhead since it is impossible to know how much memory a value with take since that's a property of its type. Thus the Python interpreter cannot statically guarantee exact unchanging values for the size that a value would take in the stack, meaning that the variables are not stack-allocated. This means that every number ends up heap-allocated, which hopefully begins to explain why this is not as fast as C.

The solution is Julia is somewhat of a hybrid. The Julia code looks like:

a = 2 b = 4 a + b

6

However, before JIT compilation, Julia runs a type inference algorithm which finds out that `A`

is an `Int`

, and `B`

is an `Int`

. You can then understand that if it can prove that `A+B`

is an `Int`

, then it can propagate all of the types through.

### Type Specialization in Functions

Julia is able to propagate type inference through functions because, even if a function is "untyped", Julia will interpret this as a *generic function* over possible *methods*, where every method has a concrete type. This means that in Julia, the function:

f(x,y) = x+y

f (generic function with 1 method)

is not what you may think of as a "single function", since given inputs of different types it will actually be a different function. We can see this by examining the *LLVM IR* (LLVM is Julia's compiler, the IR is the *Intermediate Representation*, i.e. a platform-independent representation of assembly that lives in LLVM that it knows how to convert into assembly per architecture):

using InteractiveUtils @code_llvm f(2,5)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `f` define i64 @julia_f_5497(i64 signext %0, i64 signext %1) #0 { top: ; ┌ @ int.jl:87 within `+` %2 = add i64 %1, %0 ; └ ret i64 %2 }

@code_llvm f(2.0,5.0)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `f` define double @julia_f_5499(double %0, double %1) #0 { top: ; ┌ @ float.jl:383 within `+` %2 = fadd double %0, %1 ; └ ret double %2 }

Notice that when `f`

is the function that takes in two `Int`

s, `Int`

s add to give an `Int`

and thus `f`

outputs an `Int`

. When `f`

is the function that takes two `Float64`

s, `f`

returns a `Float64`

. Thus in the code:

function g(x,y) a = 4 b = 2 c = f(x,a) d = f(b,c) f(d,y) end @code_llvm g(2,5)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `g` define i64 @julia_g_5501(i64 signext %0, i64 signext %1) #0 { top: ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 6 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ int.jl:87 within `+` %2 = add i64 %0, 6 ; └└ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 7 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ int.jl:87 within `+` %3 = add i64 %2, %1 ; └└ ret i64 %3 }

`g`

on two `Int`

inputs is a function that has `Int`

s at every step along the way and spits out an `Int`

. We can use the `@code_warntype`

macro to better see the inference along the steps of the function:

@code_warntype g(2,5)

MethodInstance for g(::Int64, ::Int64) from g(x, y) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lect ure02/optimizing.jmd:2 Arguments #self#::Core.Const(g) x::Int64 y::Int64 Locals d::Int64 c::Int64 b::Int64 a::Int64 Body::Int64 1 ─ (a = 4) │ (b = 2) │ (c = Main.f(x, a::Core.Const(4))) │ (d = Main.f(b::Core.Const(2), c)) │ %5 = Main.f(d, y)::Int64 └── return %5

What happens on mixtures?

@code_llvm f(2.0,5)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `f` define double @julia_f_6009(double %0, i64 signext %1) #0 { top: ; ┌ @ promotion.jl:388 within `+` ; │┌ @ promotion.jl:359 within `promote` ; ││┌ @ promotion.jl:336 within `_promote` ; │││┌ @ number.jl:7 within `convert` ; ││││┌ @ float.jl:146 within `Float64` %2 = sitofp i64 %1 to double ; │└└└└ ; │ @ promotion.jl:388 within `+` @ float.jl:383 %3 = fadd double %2, %0 ; └ ret double %3 }

When we add an `Int`

to a `Float64`

, we promote the `Int`

to a `Float64`

and then perform the `+`

between two `Float64`

s. When we go to the full function, we see that it can still infer:

@code_warntype g(2.0,5)

MethodInstance for g(::Float64, ::Int64) from g(x, y) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lect ure02/optimizing.jmd:2 Arguments #self#::Core.Const(g) x::Float64 y::Int64 Locals d::Float64 c::Float64 b::Int64 a::Int64 Body::Float64 1 ─ (a = 4) │ (b = 2) │ (c = Main.f(x, a::Core.Const(4))) │ (d = Main.f(b::Core.Const(2), c)) │ %5 = Main.f(d, y)::Float64 └── return %5

and it uses this to build a very efficient assembly code because it knows exactly what the types will be at every step:

@code_llvm g(2.0,5)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `g` define double @julia_g_6011(double %0, i64 signext %1) #0 { top: ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ promotion.jl:388 within `+` @ float.jl:383 %2 = fadd double %0, 4.000000e+00 ; └└ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 6 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ promotion.jl:388 within `+` @ float.jl:383 %3 = fadd double %2, 2.000000e+00 ; └└ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 7 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ promotion.jl:388 within `+` ; ││┌ @ promotion.jl:359 within `promote` ; │││┌ @ promotion.jl:336 within `_promote` ; ││││┌ @ number.jl:7 within `convert` ; │││││┌ @ float.jl:146 within `Float64` %4 = sitofp i64 %1 to double ; ││└└└└ ; ││ @ promotion.jl:388 within `+` @ float.jl:383 %5 = fadd double %3, %4 ; └└ ret double %5 }

(notice how it handles the constant *literals* 4 and 2: it converted them at compile time to reduce the algorithm to 3 floating point additions).

### Type Stability

Why is the inference algorithm able to infer all of the types of `g`

? It's because it knows the types coming out of `f`

at compile time. Given an `Int`

and a `Float64`

, `f`

will always output a `Float64`

, and thus it can continue with inference knowing that `c`

, `d`

, and eventually the output is `Float64`

. Thus in order for this to occur, we need that the type of the output on our function is directly inferred from the type of the input. This property is known as type-stability.

An example of breaking it is as follows:

function h(x,y) out = x + y rand() < 0.5 ? out : Float64(out) end

h (generic function with 1 method)

Here, on an integer input the output's type is randomly either Int or Float64, and thus the output is unknown:

@code_warntype h(2,5)

MethodInstance for h(::Int64, ::Int64) from h(x, y) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lect ure02/optimizing.jmd:2 Arguments #self#::Core.Const(h) x::Int64 y::Int64 Locals out::Int64 Body::UNION{FLOAT64, INT64} 1 ─ (out = x + y) │ %2 = Main.rand()::Float64 │ %3 = (%2 < 0.5)::Bool └── goto #3 if not %3 2 ─ return out 3 ─ %6 = Main.Float64(out)::Float64 └── return %6

This means that its output type is `Union{Int,Float64}`

(Julia uses union types to keep the types still somewhat constrained). Once there are multiple choices, those need to get propagate through the compiler, and all subsequent calculations are the result of either being an `Int`

or a `Float64`

.

(Note that Julia has small union optimizations, so if this union is of size 4 or less then Julia will still be able to optimize it quite a bit.)

### Multiple Dispatch

The `+`

function on numbers was implemented in Julia, so how were these rules all written down? The answer is multiple dispatch. In Julia, you can tell a function how to act differently on different types by using type assertions on the input values. For example, let's make a function that computes `2x + y`

on `Int`

and `x/y`

on `Float64`

:

ff(x::Int,y::Int) = 2x + y ff(x::Float64,y::Float64) = x/y @show ff(2,5) @show ff(2.0,5.0)

ff(2, 5) = 9 ff(2.0, 5.0) = 0.4 0.4

The `+`

function in Julia is just defined as `+(a,b)`

, and we can actually point to that code in the Julia distribution:

@which +(2.0,5)+(x::

**Number**, y::

**Number**) in Base at promotion.jl:388

To control at a higher level, Julia uses *abstract types*. For example, `Float64 <: AbstractFloat`

, meaning `Float64`

s are a subtype of `AbstractFloat`

. We also have that `Int <: Integer`

, while both `AbstractFloat <: Number`

and `Integer <: Number`

.

Julia allows the user to define dispatches at a higher level, and the version that is called is the most strict version that is correct. For example, right now with `ff`

we will get a `MethodError`

if we call it between a `Int`

and a `Float64`

because no such method exists:

ff(2.0,5)

ERROR: MethodError: no method matching ff(::Float64, ::Int64) Closest candidates are: ff(!Matched::Int64, ::Int64) at ~/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd:2 ff(::Float64, !Matched::Float64) at ~/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd:3

However, we can add a *fallback method* to the function `ff`

for two numbers:

ff(x::Number,y::Number) = x + y ff(2.0,5)

7.0

Notice that the fallback method still specializes on the inputs:

@code_llvm ff(2.0,5)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `ff` define double @julia_ff_6121(double %0, i64 signext %1) #0 { top: ; ┌ @ promotion.jl:388 within `+` ; │┌ @ promotion.jl:359 within `promote` ; ││┌ @ promotion.jl:336 within `_promote` ; │││┌ @ number.jl:7 within `convert` ; ││││┌ @ float.jl:146 within `Float64` %2 = sitofp i64 %1 to double ; │└└└└ ; │ @ promotion.jl:388 within `+` @ float.jl:383 %3 = fadd double %2, %0 ; └ ret double %3 }

It's essentially just a template for what functions to possibly try and create given the types that are seen. When it sees `Float64`

and `Int`

, it knows it should try and create the function that does `x+y`

, and once it knows it's `Float64`

plus a `Int`

, it knows it should create the function that converts the `Int`

to a `Float64`

and then does addition between two `Float64`

s, and that is precisely the generated LLVM IR on this pair of input types.

And that's essentially Julia's secret sauce: since it's always specializing its types on each function, if those functions themselves can infer the output, then the entire function can be inferred and generate optimal code, which is then optimized by the compiler and out comes an efficient function. If types can't be inferred, Julia falls back to a slower "Python" mode (though with optimizations in cases like small unions). Users then get control over this specialization process through multiple dispatch, which is then Julia's core feature since it allows adding new options without any runtime cost.

### Any Fallbacks

Note that `f(x,y) = x+y`

is equivalent to `f(x::Any,y::Any) = x+y`

, where `Any`

is the maximal supertype of every Julia type. Thus `f(x,y) = x+y`

is essentially a fallback for all possible input values, telling it what to do in the case that no other dispatches exist. However, note that this dispatch itself is not slow, since it will be specialized on the input types.

### Ambiguities

The version that is called is the most strict version that is correct. What happens if it's impossible to define "the most strict version"? For example,

ff(x::Float64,y::Number) = 5x + 2y ff(x::Number,y::Int) = x - y

ff (generic function with 5 methods)

What should it call on `f(2.0,5)`

now? `ff(x::Float64,y::Number)`

and `ff(x::Number,y::Int)`

are both more strict than `ff(x::Number,y::Number)`

, so one of them should be called, but neither are more strict than each other, and thus you will end up with an ambiguity error:

ff(2.0,5)

ERROR: MethodError: ff(::Float64, ::Int64) is ambiguous. Candidates: ff(x::Float64, y::Number) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd:2 ff(x::Number, y::Int64) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd:3 Possible fix, define ff(::Float64, ::Int64)

### Untyped Containers

One way to ruin inference is to use an untyped container. For example, the array constructors use type inference themselves to know what their container type will be. Therefore,

a = [1.0,2.0,3.0]

3-element Vector{Float64}: 1.0 2.0 3.0

uses type inference on its inputs to know that it should be something that holds `Float64`

values, and thus it is a 1-dimensional array of `Float64`

values, or `Array{Float64,1}`

. The accesses:

a[1]

1.0

are then inferred, since this is just the function `getindex(a::Array{T},i) where T`

which is a function that will produce something of type `T`

, the element type of the array. However, if we tell Julia to make an array with element type `Any`

:

b = ["1.0",2,2.0]

3-element Vector{Any}: "1.0" 2 2.0

(here, Julia falls back to `Any`

because it cannot promote the values to the same type), then the best inference can do on the output is to say it could have any type:

function bad_container(a) a[2] end @code_warntype bad_container(a)

MethodInstance for bad_container(::Vector{Float64}) from bad_container(a) in Main at /home/runner/work/SciMLBook/SciMLBook/_w eave/lecture02/optimizing.jmd:2 Arguments #self#::Core.Const(bad_container) a::Vector{Float64} Body::Float64 1 ─ %1 = Base.getindex(a, 2)::Float64 └── return %1

@code_warntype bad_container(b)

MethodInstance for bad_container(::Vector{Any}) from bad_container(a) in Main at /home/runner/work/SciMLBook/SciMLBook/_w eave/lecture02/optimizing.jmd:2 Arguments #self#::Core.Const(bad_container) a::Vector{Any} Body::ANY 1 ─ %1 = Base.getindex(a, 2)::ANY └── return %1

This is one common way that type inference can breakdown. For example, even if the array is all numbers, we can still break inference:

x = Number[1.0,3] function q(x) a = 4 b = 2 c = f(x[1],a) d = f(b,c) f(d,x[2]) end @code_warntype q(x)

MethodInstance for q(::Vector{Number}) from q(x) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lecture 02/optimizing.jmd:3 Arguments #self#::Core.Const(q) x::Vector{Number} Locals d::ANY c::ANY b::Int64 a::Int64 Body::ANY 1 ─ (a = 4) │ (b = 2) │ %3 = Base.getindex(x, 1)::NUMBER │ (c = Main.f(%3, a::Core.Const(4))) │ (d = Main.f(b::Core.Const(2), c)) │ %6 = d::ANY │ %7 = Base.getindex(x, 2)::NUMBER │ %8 = Main.f(%6, %7)::ANY └── return %8

Here the type inference algorithm quickly gives up and infers to `Any`

, losing all specialization and automatically switching to Python-style runtime type checking.

### Type definitions

### Value types and isbits

In Julia, types which can fully inferred and which are composed of primitive or `isbits`

types are value types. This means that, inside of an array, their values are the values of the type itself, and not a pointer to the values.

You can check if the type is a value type through `isbits`

:

isbits(1.0)

true

Note that a Julia `struct`

which holds i`sbits`

values is `isbits`

as well, if it's fully inferred:

struct MyComplex real::Float64 imag::Float64 end isbits(MyComplex(1.0,1.0))

true

We can see that the compiler knows how to use this efficiently since it knows that what comes out is always `Float64`

:

Base.:+(a::MyComplex,b::MyComplex) = MyComplex(a.real+b.real,a.imag+b.imag) Base.:+(a::MyComplex,b::Int) = MyComplex(a.real+b,a.imag) Base.:+(b::Int,a::MyComplex) = MyComplex(a.real+b,a.imag) g(MyComplex(1.0,1.0),MyComplex(1.0,1.0))

MyComplex(8.0, 2.0)

@code_warntype g(MyComplex(1.0,1.0),MyComplex(1.0,1.0))

MethodInstance for g(::MyComplex, ::MyComplex) from g(x, y) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lect ure02/optimizing.jmd:2 Arguments #self#::Core.Const(g) x::MyComplex y::MyComplex Locals d::MyComplex c::MyComplex b::Int64 a::Int64 Body::MyComplex 1 ─ (a = 4) │ (b = 2) │ (c = Main.f(x, a::Core.Const(4))) │ (d = Main.f(b::Core.Const(2), c)) │ %5 = Main.f(d, y)::MyComplex └── return %5

@code_llvm g(MyComplex(1.0,1.0),MyComplex(1.0,1.0))

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `g` define void @julia_g_6278([2 x double]* noalias nocapture sret([2 x double] ) %0, [2 x double]* nocapture nonnull readonly align 8 dereferenceable(16) %1, [2 x double]* nocapture nonnull readonly align 8 dereferenceable(16) %2 ) #0 { top: ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:3 within `+` ; ││┌ @ Base.jl:38 within `getproperty` %3 = getelementptr inbounds [2 x double], [2 x double]* %1, i64 0, i64 0 ; ││└ ; ││ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:3 within `+` @ promotion.jl:388 @ float.jl:383 %4 = load double, double* %3, align 8 %5 = fadd double %4, 4.000000e+00 ; ││ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:3 within `+` ; ││┌ @ Base.jl:38 within `getproperty` %6 = getelementptr inbounds [2 x double], [2 x double]* %1, i64 0, i64 1 ; └└└ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 6 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:4 within `+` @ promotion.jl:388 @ float.jl:383 %7 = fadd double %5, 2.000000e+00 ; └└ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 7 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:2 within `+` @ float.jl:383 %8 = load double, double* %6, align 8 %9 = bitcast [2 x double]* %2 to <2 x double>* %10 = load <2 x double>, <2 x double>* %9, align 8 %11 = insertelement <2 x double> poison, double %7, i32 0 %12 = insertelement <2 x double> %11, double %8, i32 1 %13 = fadd <2 x double> %10, %12 ; └└ %14 = bitcast [2 x double]* %0 to <2 x double>* store <2 x double> %13, <2 x double>* %14, align 8 ret void }

Note that the compiled code simply works directly on the `double`

pieces. We can also make this be concrete without pre-specifying that the values always have to be `Float64`

by using a type parameter.

struct MyParameterizedComplex{T} real::T imag::T end isbits(MyParameterizedComplex(1.0,1.0))

true

Note that `MyParameterizedComplex{T}`

is a concrete type for every `T`

: it is a shorthand form for defining a whole family of types.

Base.:+(a::MyParameterizedComplex,b::MyParameterizedComplex) = MyParameterizedComplex(a.real+b.real,a.imag+b.imag) Base.:+(a::MyParameterizedComplex,b::Int) = MyParameterizedComplex(a.real+b,a.imag) Base.:+(b::Int,a::MyParameterizedComplex) = MyParameterizedComplex(a.real+b,a.imag) g(MyParameterizedComplex(1.0,1.0),MyParameterizedComplex(1.0,1.0))

MyParameterizedComplex{Float64}(8.0, 2.0)

@code_warntype g(MyParameterizedComplex(1.0,1.0),MyParameterizedComplex(1.0,1.0))

MethodInstance for g(::MyParameterizedComplex{Float64}, ::MyParameterizedCo mplex{Float64}) from g(x, y) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lect ure02/optimizing.jmd:2 Arguments #self#::Core.Const(g) x::MyParameterizedComplex{Float64} y::MyParameterizedComplex{Float64} Locals d::MyParameterizedComplex{Float64} c::MyParameterizedComplex{Float64} b::Int64 a::Int64 Body::MyParameterizedComplex{Float64} 1 ─ (a = 4) │ (b = 2) │ (c = Main.f(x, a::Core.Const(4))) │ (d = Main.f(b::Core.Const(2), c)) │ %5 = Main.f(d, y)::MyParameterizedComplex{Float64} └── return %5

See that this code also automatically works and compiles efficiently for `Float32`

as well:

@code_warntype g(MyParameterizedComplex(1.0f0,1.0f0),MyParameterizedComplex(1.0f0,1.0f0))

MethodInstance for g(::MyParameterizedComplex{Float32}, ::MyParameterizedCo mplex{Float32}) from g(x, y) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lect ure02/optimizing.jmd:2 Arguments #self#::Core.Const(g) x::MyParameterizedComplex{Float32} y::MyParameterizedComplex{Float32} Locals d::MyParameterizedComplex{Float32} c::MyParameterizedComplex{Float32} b::Int64 a::Int64 Body::MyParameterizedComplex{Float32} 1 ─ (a = 4) │ (b = 2) │ (c = Main.f(x, a::Core.Const(4))) │ (d = Main.f(b::Core.Const(2), c)) │ %5 = Main.f(d, y)::MyParameterizedComplex{Float32} └── return %5

@code_llvm g(MyParameterizedComplex(1.0f0,1.0f0),MyParameterizedComplex(1.0f0,1.0f0))

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `g` define [2 x float] @julia_g_6290([2 x float]* nocapture nonnull readonly al ign 4 dereferenceable(8) %0, [2 x float]* nocapture nonnull readonly align 4 dereferenceable(8) %1) #0 { top: ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:3 within `+` ; ││┌ @ Base.jl:38 within `getproperty` %2 = getelementptr inbounds [2 x float], [2 x float]* %0, i64 0, i64 0 ; ││└ ; ││ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:3 within `+` @ promotion.jl:388 @ float.jl:383 %3 = load float, float* %2, align 4 %4 = fadd float %3, 4.000000e+00 ; ││ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:3 within `+` ; ││┌ @ Base.jl:38 within `getproperty` %5 = getelementptr inbounds [2 x float], [2 x float]* %0, i64 0, i64 1 ; └└└ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 6 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:4 within `+` @ promotion.jl:388 @ float.jl:383 %6 = fadd float %4, 2.000000e+00 ; └└ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 7 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` ; │┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:2 within `+` ; ││┌ @ Base.jl:38 within `getproperty` %7 = getelementptr inbounds [2 x float], [2 x float]* %1, i64 0, i64 0 ; ││└ ; ││ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:2 within `+` @ float.jl:383 %8 = load float, float* %7, align 4 %9 = fadd float %8, %6 ; ││ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:2 within `+` ; ││┌ @ Base.jl:38 within `getproperty` %10 = getelementptr inbounds [2 x float], [2 x float]* %1, i64 0, i64 1 ; ││└ ; ││ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jm d:2 within `+` @ float.jl:383 %11 = load float, float* %5, align 4 %12 = load float, float* %10, align 4 %13 = fadd float %11, %12 ; └└ %.fca.0.insert = insertvalue [2 x float] zeroinitializer, float %9, 0 %.fca.1.insert = insertvalue [2 x float] %.fca.0.insert, float %13, 1 ret [2 x float] %.fca.1.insert }

It is important to know that if there is any piece of a type which doesn't contain type information, then it cannot be isbits because then it would have to be compiled in such a way that the size is not known in advance. For example:

struct MySlowComplex real imag end isbits(MySlowComplex(1.0,1.0))

false

Base.:+(a::MySlowComplex,b::MySlowComplex) = MySlowComplex(a.real+b.real,a.imag+b.imag) Base.:+(a::MySlowComplex,b::Int) = MySlowComplex(a.real+b,a.imag) Base.:+(b::Int,a::MySlowComplex) = MySlowComplex(a.real+b,a.imag) g(MySlowComplex(1.0,1.0),MySlowComplex(1.0,1.0))

MySlowComplex(8.0, 2.0)

@code_warntype g(MySlowComplex(1.0,1.0),MySlowComplex(1.0,1.0))

MethodInstance for g(::MySlowComplex, ::MySlowComplex) from g(x, y) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lect ure02/optimizing.jmd:2 Arguments #self#::Core.Const(g) x::MySlowComplex y::MySlowComplex Locals d::MySlowComplex c::MySlowComplex b::Int64 a::Int64 Body::MySlowComplex 1 ─ (a = 4) │ (b = 2) │ (c = Main.f(x, a::Core.Const(4))) │ (d = Main.f(b::Core.Const(2), c)) │ %5 = Main.f(d, y)::MySlowComplex └── return %5

@code_llvm g(MySlowComplex(1.0,1.0),MySlowComplex(1.0,1.0))

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `g` define void @julia_g_6309([2 x {}*]* noalias nocapture sret([2 x {}*]) %0, [2 x {}*]* nocapture nonnull readonly align 8 dereferenceable(16) %1, [2 x {}*]* nocapture nonnull readonly align 8 dereferenceable(16) %2) #0 { top: %gcframe2 = alloca [8 x {}*], align 16 %gcframe2.sub = getelementptr inbounds [8 x {}*], [8 x {}*]* %gcframe2, i 64 0, i64 0 %3 = bitcast [8 x {}*]* %gcframe2 to i8* call void @llvm.memset.p0i8.i32(i8* noundef nonnull align 16 dereferencea ble(64) %3, i8 0, i32 64, i1 false) %4 = getelementptr inbounds [8 x {}*], [8 x {}*]* %gcframe2, i64 0, i64 6 %5 = bitcast {}** %4 to [2 x {}*]* %6 = getelementptr inbounds [8 x {}*], [8 x {}*]* %gcframe2, i64 0, i64 4 %7 = bitcast {}** %6 to [2 x {}*]* %8 = getelementptr inbounds [8 x {}*], [8 x {}*]* %gcframe2, i64 0, i64 2 %9 = bitcast {}** %8 to [2 x {}*]* %thread_ptr = call i8* asm "movq %fs:0, $0", "=r"() #5 %ppgcstack_i8 = getelementptr i8, i8* %thread_ptr, i64 -8 %ppgcstack = bitcast i8* %ppgcstack_i8 to {}**** %pgcstack = load {}***, {}**** %ppgcstack, align 8 ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` %10 = bitcast [8 x {}*]* %gcframe2 to i64* store i64 24, i64* %10, align 16 %11 = getelementptr inbounds [8 x {}*], [8 x {}*]* %gcframe2, i64 0, i64 1 %12 = bitcast {}** %11 to {}*** %13 = load {}**, {}*** %pgcstack, align 8 store {}** %13, {}*** %12, align 8 %14 = bitcast {}*** %pgcstack to {}*** store {}** %gcframe2.sub, {}*** %14, align 8 call void @"j_+_6311"([2 x {}*]* noalias nocapture nonnull sret([2 x {}* ]) %5, [2 x {}*]* nocapture nonnull readonly %1, i64 signext 4) #0 ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 6 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` call void @"j_+_6312"([2 x {}*]* noalias nocapture nonnull sret([2 x {}* ]) %7, i64 signext 2, [2 x {}*]* nocapture readonly %5) #0 ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 7 within `g` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :2 within `f` call void @"j_+_6313"([2 x {}*]* noalias nocapture nonnull sret([2 x {}* ]) %9, [2 x {}*]* nocapture readonly %7, [2 x {}*]* nocapture nonnull reado nly %2) #0 ; └ %15 = bitcast [2 x {}*]* %0 to i8* %16 = bitcast {}** %8 to i8* call void @llvm.memcpy.p0i8.p0i8.i64(i8* noundef nonnull align 8 derefere nceable(16) %15, i8* noundef nonnull align 16 dereferenceable(16) %16, i64 16, i1 false) %17 = load {}*, {}** %11, align 8 %18 = bitcast {}*** %pgcstack to {}** store {}* %17, {}** %18, align 8 ret void }

struct MySlowComplex2 real::AbstractFloat imag::AbstractFloat end isbits(MySlowComplex2(1.0,1.0))

false

Base.:+(a::MySlowComplex2,b::MySlowComplex2) = MySlowComplex2(a.real+b.real,a.imag+b.imag) Base.:+(a::MySlowComplex2,b::Int) = MySlowComplex2(a.real+b,a.imag) Base.:+(b::Int,a::MySlowComplex2) = MySlowComplex2(a.real+b,a.imag) g(MySlowComplex2(1.0,1.0),MySlowComplex2(1.0,1.0))

MySlowComplex2(8.0, 2.0)

Here's the timings:

a = MyComplex(1.0,1.0) b = MyComplex(2.0,1.0) @btime g(a,b)

23.092 ns (1 allocation: 32 bytes) MyComplex(9.0, 2.0)

a = MyParameterizedComplex(1.0,1.0) b = MyParameterizedComplex(2.0,1.0) @btime g(a,b)

22.691 ns (1 allocation: 32 bytes) MyParameterizedComplex{Float64}(9.0, 2.0)

a = MySlowComplex(1.0,1.0) b = MySlowComplex(2.0,1.0) @btime g(a,b)

117.614 ns (5 allocations: 96 bytes) MySlowComplex(9.0, 2.0)

a = MySlowComplex2(1.0,1.0) b = MySlowComplex2(2.0,1.0) @btime g(a,b)

692.804 ns (14 allocations: 288 bytes) MySlowComplex2(9.0, 2.0)

### Note on Julia

Note that, because of these type specialization, value types, etc. properties, the number types, even ones such as `Int`

, `Float64`

, and `Complex`

, are all themselves implemented in pure Julia! Thus even basic pieces can be implemented in Julia with full performance, given one uses the features correctly.

### Note on isbits

Note that a type which is `mutable struct`

will not be isbits. This means that mutable structs will be a pointer to a heap allocated object, unless it's shortlived and the compiler can erase its construction. Also, note that `isbits`

compiles down to bit operations from pure Julia, which means that these types can directly compile to GPU kernels through CUDAnative without modification.

### Function Barriers

Since functions automatically specialize on their input types in Julia, we can use this to our advantage in order to make an inner loop fully inferred. For example, take the code from above but with a loop:

function r(x) a = 4 b = 2 for i in 1:100 c = f(x[1],a) d = f(b,c) a = f(d,x[2]) end a end @btime r(x)

6.360 μs (300 allocations: 4.69 KiB) 604.0

In here, the loop variables are not inferred and thus this is really slow. However, we can force a function call in the middle to end up with specialization and in the inner loop be stable:

s(x) = _s(x[1],x[2]) function _s(x1,x2) a = 4 b = 2 for i in 1:100 c = f(x1,a) d = f(b,c) a = f(d,x2) end a end @btime s(x)

495.356 ns (1 allocation: 16 bytes) 604.0

Notice that this algorithm still doesn't infer:

@code_warntype s(x)

MethodInstance for s(::Vector{Number}) from s(x) in Main at /home/runner/work/SciMLBook/SciMLBook/_weave/lecture 02/optimizing.jmd:2 Arguments #self#::Core.Const(s) x::Vector{Number} Body::ANY 1 ─ %1 = Base.getindex(x, 1)::NUMBER │ %2 = Base.getindex(x, 2)::NUMBER │ %3 = Main._s(%1, %2)::ANY └── return %3

since the output of `_s`

isn't inferred, but while it's in `_s`

it will have specialized on the fact that `x[1]`

is a `Float64`

while `x[2]`

is a `Int`

, making that inner loop fast. In fact, it will only need to pay one *dynamic dispatch*, i.e. a multiple dispatch determination that happens at runtime. Notice that whenever functions are inferred, the dispatching is static since the choice of the dispatch is already made and compiled into the LLVM IR.

### Specialization at Compile Time

Julia code will specialize at compile time if it can prove something about the result. For example:

function fff(x) if x isa Int y = 2 else y = 4.0 end x + y end

fff (generic function with 1 method)

You might think this function has a branch, but in reality Julia can determine whether `x`

is an `Int`

or not at compile time, so it will actually compile it away and just turn it into the function `x+2`

or `x+4.0`

:

@code_llvm fff(5)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `fff` define i64 @julia_fff_6469(i64 signext %0) #0 { top: ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 8 within `fff` ; ┌ @ int.jl:87 within `+` %1 = add i64 %0, 2 ; └ ret i64 %1 }

@code_llvm fff(2.0)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `fff` define double @julia_fff_6471(double %0) #0 { top: ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 8 within `fff` ; ┌ @ float.jl:383 within `+` %1 = fadd double %0, 4.000000e+00 ; └ ret double %1 }

Thus one does not need to worry about over-optimizing since in the obvious cases the compiler will actually remove all of the extra pieces when it can!

### Global Scope and Optimizations

This discussion shows how Julia's optimizations all apply during function specialization times. Thus calling Julia functions is fast. But what about when doing something outside of the function, like directly in a module or in the REPL?

@btime for j in 1:100, i in 1:100 global A,B,C C[i,j] = A[i,j] + B[i,j] end

874.493 μs (30000 allocations: 468.75 KiB)

This is very slow because the types of `A`

, `B`

, and `C`

cannot be inferred. Why can't they be inferred? Well, at any time in the dynamic REPL scope I can do something like `C = "haha now a string!"`

, and thus it cannot specialize on the types currently existing in the REPL (since asynchronous changes could also occur), and therefore it defaults back to doing a type check at every single function which slows it down. Moral of the story, Julia functions are fast but its global scope is too dynamic to be optimized.

### Summary

Julia is not fast because of its JIT, it's fast because of function specialization and type inference

Type stable functions allow inference to fully occur

Multiple dispatch works within the function specialization mechanism to create overhead-free compile time controls

Julia will specialize the generic functions

Making sure values are concretely typed in inner loops is essential for performance

## Overheads of Individual Operations

Now let's dig even a little deeper. Everything the processor does has a cost. A great chart to keep in mind is this classic one. A few things should immediately jump out to you:

Simple arithmetic, like floating point additions, are super cheap. ~1 clock cycle, or a few nanoseconds.

Processors do

*branch prediction*on`if`

statements. If the code goes down the predicted route, the`if`

statement costs ~1-2 clock cycles. If it goes down the wrong route, then it will take ~10-20 clock cycles. This means that predictable branches, like ones with clear patterns or usually the same output, are much cheaper (almost free) than unpredictable branches.Function calls are expensive: 15-60 clock cycles!

RAM reads are very expensive, with lower caches less expensive.

### Bounds Checking

Let's check the LLVM IR on one of our earlier loops:

function inner_noalloc!(C,A,B) for j in 1:100, i in 1:100 val = A[i,j] + B[i,j] C[i,j] = val[1] end end @code_llvm inner_noalloc!(C,A,B)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `inner_noalloc!` define nonnull {}* @"japi1_inner_noalloc!_6509"({}* %0, {}** %1, i32 %2) #0 { top: %3 = alloca {}**, align 8 store volatile {}** %1, {}*** %3, align 8 %4 = load {}*, {}** %1, align 8 %5 = getelementptr inbounds {}*, {}** %1, i64 1 %6 = load {}*, {}** %5, align 8 %7 = getelementptr inbounds {}*, {}** %1, i64 2 %8 = load {}*, {}** %7, align 8 %9 = bitcast {}* %6 to {}** %10 = getelementptr inbounds {}*, {}** %9, i64 3 %11 = bitcast {}** %10 to i64* %12 = load i64, i64* %11, align 8 %13 = getelementptr inbounds {}*, {}** %9, i64 4 %14 = bitcast {}** %13 to i64* %15 = bitcast {}* %6 to double** %16 = bitcast {}* %8 to {}** %17 = getelementptr inbounds {}*, {}** %16, i64 3 %18 = bitcast {}** %17 to i64* %19 = getelementptr inbounds {}*, {}** %16, i64 4 %20 = bitcast {}** %19 to i64* %21 = bitcast {}* %8 to double** %22 = bitcast {}* %4 to {}** %23 = getelementptr inbounds {}*, {}** %22, i64 3 %24 = bitcast {}** %23 to i64* %25 = getelementptr inbounds {}*, {}** %22, i64 4 %26 = bitcast {}** %25 to i64* %27 = bitcast {}* %4 to double** ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 3 within `inner_noalloc!` br label %L2 L2: ; preds = %L27, %top %value_phi = phi i64 [ 1, %top ], [ %61, %L27 ] %28 = add nsw i64 %value_phi, -1 %29 = load i64, i64* %14, align 8 %30 = icmp ult i64 %28, %29 %31 = mul i64 %12, %28 %32 = load double*, double** %15, align 8 %33 = load i64, i64* %18, align 8 %34 = mul i64 %33, %28 %35 = load double*, double** %21, align 8 %36 = load i64, i64* %24, align 8 %37 = load i64, i64* %26, align 8 %38 = icmp ult i64 %28, %37 %39 = mul i64 %36, %28 %40 = load double*, double** %27, align 8 br i1 %30, label %L2.split.us, label %oob L2.split.us: ; preds = %L2 %41 = load i64, i64* %20, align 8 %42 = icmp ult i64 %28, %41 %smin61 = call i64 @llvm.smin.i64(i64 %33, i64 0) %43 = sub i64 %33, %smin61 %smax62 = call i64 @llvm.smax.i64(i64 %smin61, i64 -1) %44 = add nsw i64 %smax62, 1 %45 = mul nuw nsw i64 %43, %44 %umin63 = call i64 @llvm.umin.i64(i64 %12, i64 %45) %smin64 = call i64 @llvm.smin.i64(i64 %36, i64 0) %46 = sub i64 %36, %smin64 %smax65 = call i64 @llvm.smax.i64(i64 %smin64, i64 -1) %47 = add nsw i64 %smax65, 1 %48 = mul nuw nsw i64 %46, %47 %umin66 = call i64 @llvm.umin.i64(i64 %umin63, i64 %48) %exit.mainloop.at68 = call i64 @llvm.umin.i64(i64 %umin66, i64 100) %.not207 = icmp eq i64 %exit.mainloop.at68, 0 br i1 %42, label %L2.split.us.split.us, label %L2.split.us.L2.split.us.sp lit_crit_edge L2.split.us.L2.split.us.split_crit_edge: ; preds = %L2.split.us %.not205 = icmp eq i64 %12, 0 %or.cond = select i1 %.not207, i1 %.not205, i1 false br i1 %or.cond, label %oob, label %oob5 L2.split.us.split.us: ; preds = %L2.split.us br i1 %.not207, label %main.pseudo.exit71, label %ib7.us.us ib7.us.us: ; preds = %idxend9.us.us, %L2.split.us.split.us %value_phi2.us.us = phi i64 [ %59, %idxend9.us.us ], [ 1, %L2.split.us.sp lit.us ] ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 4 within `inner_noalloc!` ; ┌ @ array.jl:925 within `getindex` %49 = add i64 %value_phi2.us.us, -1 ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `inner_noalloc!` ; ┌ @ array.jl:968 within `setindex!` br i1 %38, label %idxend9.us.us, label %oob8 idxend9.us.us: ; preds = %ib7.us.us ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 4 within `inner_noalloc!` ; ┌ @ array.jl:925 within `getindex` %50 = add i64 %31, %49 %51 = getelementptr inbounds double, double* %32, i64 %50 %52 = load double, double* %51, align 8 %53 = add i64 %34, %49 %54 = getelementptr inbounds double, double* %35, i64 %53 %55 = load double, double* %54, align 8 ; └ ; ┌ @ float.jl:383 within `+` %56 = fadd double %52, %55 ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `inner_noalloc!` ; ┌ @ array.jl:968 within `setindex!` %57 = add i64 %39, %49 %58 = getelementptr inbounds double, double* %40, i64 %57 store double %56, double* %58, align 8 ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 6 within `inner_noalloc!` ; ┌ @ range.jl:883 within `iterate` %59 = add i64 %value_phi2.us.us, 1 ; └ %.not208 = icmp ult i64 %value_phi2.us.us, %exit.mainloop.at68 br i1 %.not208, label %ib7.us.us, label %main.exit.selector70 main.exit.selector70: ; preds = %idxend9.us.us %60 = icmp ult i64 %value_phi2.us.us, 100 br i1 %60, label %main.pseudo.exit71, label %L27 main.pseudo.exit71: ; preds = %main.exit.sele ctor70, %L2.split.us.split.us %value_phi2.us.us.copy = phi i64 [ 1, %L2.split.us.split.us ], [ %59, %ma in.exit.selector70 ] br label %L5.us.us.postloop L27: ; preds = %idxend9.us.us. postloop, %main.exit.selector70 ; ┌ @ range.jl:883 within `iterate` ; │┌ @ promotion.jl:477 within `==` %.not18 = icmp eq i64 %value_phi, 100 ; │└ %61 = add nuw nsw i64 %value_phi, 1 ; └ br i1 %.not18, label %L40, label %L2 L40: ; preds = %L27 ret {}* inttoptr (i64 139851186921480 to {}*) oob: ; preds = %L5.us.us.postl oop, %L2.split.us.L2.split.us.split_crit_edge, %L2 %value_phi2.lcssa = phi i64 [ 1, %L2.split.us.L2.split.us.split_crit_edge ], [ %value_phi2.us.us.postloop, %L5.us.us.postloop ], [ 1, %L2 ] ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 4 within `inner_noalloc!` ; ┌ @ array.jl:925 within `getindex` %62 = alloca [2 x i64], align 8 %.sub = getelementptr inbounds [2 x i64], [2 x i64]* %62, i64 0, i64 0 store i64 %value_phi2.lcssa, i64* %.sub, align 8 %63 = getelementptr inbounds [2 x i64], [2 x i64]* %62, i64 0, i64 1 store i64 %value_phi, i64* %63, align 8 call void @ijl_bounds_error_ints({}* %6, i64* nonnull %.sub, i64 2) unreachable oob5: ; preds = %idxend.us.us.p ostloop, %L2.split.us.L2.split.us.split_crit_edge %value_phi2.lcssa19 = phi i64 [ 1, %L2.split.us.L2.split.us.split_crit_e dge ], [ %value_phi2.us.us.postloop, %idxend.us.us.postloop ] %64 = alloca [2 x i64], align 8 %.sub16 = getelementptr inbounds [2 x i64], [2 x i64]* %64, i64 0, i64 0 store i64 %value_phi2.lcssa19, i64* %.sub16, align 8 %65 = getelementptr inbounds [2 x i64], [2 x i64]* %64, i64 0, i64 1 store i64 %value_phi, i64* %65, align 8 call void @ijl_bounds_error_ints({}* %8, i64* nonnull %.sub16, i64 2) unreachable oob8.loopexit: ; preds = %idxend6.us.us. postloop ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `inner_noalloc!` ; ┌ @ array.jl:968 within `setindex!` %value_phi2.us.us.postloop.mux = select i1 %71, i64 %value_phi2.us.us.po stloop, i64 %value_phi2.us.us.copy br label %oob8 oob8: ; preds = %oob8.loopexit, %ib7.us.us %value_phi2.lcssa20 = phi i64 [ %value_phi2.us.us.postloop.mux, %oob8.lo opexit ], [ 1, %ib7.us.us ] %66 = alloca [2 x i64], align 8 %.sub17 = getelementptr inbounds [2 x i64], [2 x i64]* %66, i64 0, i64 0 store i64 %value_phi2.lcssa20, i64* %.sub17, align 8 %67 = getelementptr inbounds [2 x i64], [2 x i64]* %66, i64 0, i64 1 store i64 %value_phi, i64* %67, align 8 call void @ijl_bounds_error_ints({}* %4, i64* nonnull %.sub17, i64 2) unreachable L5.us.us.postloop: ; preds = %idxend9.us.us. postloop, %main.pseudo.exit71 %value_phi2.us.us.postloop = phi i64 [ %value_phi2.us.us.copy, %main.pse udo.exit71 ], [ %81, %idxend9.us.us.postloop ] ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 4 within `inner_noalloc!` ; ┌ @ array.jl:925 within `getindex` %68 = add i64 %value_phi2.us.us.postloop, -1 %69 = icmp ult i64 %68, %12 br i1 %69, label %idxend.us.us.postloop, label %oob idxend.us.us.postloop: ; preds = %L5.us.us.postl oop %70 = icmp ult i64 %68, %33 br i1 %70, label %idxend6.us.us.postloop, label %oob5 idxend6.us.us.postloop: ; preds = %idxend.us.us.p ostloop ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `inner_noalloc!` ; ┌ @ array.jl:968 within `setindex!` %71 = icmp uge i64 %68, %36 %.not210 = xor i1 %38, true %brmerge = select i1 %71, i1 true, i1 %.not210 br i1 %brmerge, label %oob8.loopexit, label %idxend9.us.us.postloop idxend9.us.us.postloop: ; preds = %idxend6.us.us. postloop ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 4 within `inner_noalloc!` ; ┌ @ array.jl:925 within `getindex` %72 = add i64 %31, %68 %73 = getelementptr inbounds double, double* %32, i64 %72 %74 = load double, double* %73, align 8 %75 = add i64 %34, %68 %76 = getelementptr inbounds double, double* %35, i64 %75 %77 = load double, double* %76, align 8 ; └ ; ┌ @ float.jl:383 within `+` %78 = fadd double %74, %77 ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `inner_noalloc!` ; ┌ @ array.jl:968 within `setindex!` %79 = add i64 %39, %68 %80 = getelementptr inbounds double, double* %40, i64 %79 store double %78, double* %80, align 8 ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 6 within `inner_noalloc!` ; ┌ @ range.jl:883 within `iterate` ; │┌ @ promotion.jl:477 within `==` %.not.us.us.postloop = icmp eq i64 %value_phi2.us.us.postloop, 100 ; │└ %81 = add nuw nsw i64 %value_phi2.us.us.postloop, 1 ; └ br i1 %.not.us.us.postloop, label %L27, label %L5.us.us.postloop }

Notice that this `getelementptr inbounds`

stuff is bounds checking. Julia, like all other high level languages, enables bounds checking by default in order to not allow the user to index outside of an array. Indexing outside of an array is dangerous: it can quite easily segfault your system if you change some memory that is unknown beyond your actual array. Thus Julia throws an error:

A[101,1]

ERROR: BoundsError: attempt to access 100×100 Matrix{Float64} at index [101, 1]

In tight inner loops, we can remove this bounds checking process using the `@inbounds`

macro:

function inner_noalloc_ib!(C,A,B) @inbounds for j in 1:100, i in 1:100 val = A[i,j] + B[i,j] C[i,j] = val[1] end end @btime inner_noalloc!(C,A,B)

6.900 μs (0 allocations: 0 bytes)

@btime inner_noalloc_ib!(C,A,B)

2.967 μs (0 allocations: 0 bytes)

### SIMD

Now let's inspect the LLVM IR again:

@code_llvm inner_noalloc_ib!(C,A,B)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `inner_noalloc_ib!` define nonnull {}* @"japi1_inner_noalloc_ib!_6550"({}* %0, {}** %1, i32 %2) #0 { top: %3 = alloca {}**, align 8 store volatile {}** %1, {}*** %3, align 8 %4 = load {}*, {}** %1, align 8 %5 = getelementptr inbounds {}*, {}** %1, i64 1 %6 = load {}*, {}** %5, align 8 %7 = getelementptr inbounds {}*, {}** %1, i64 2 %8 = load {}*, {}** %7, align 8 %9 = bitcast {}* %6 to {}** %10 = getelementptr inbounds {}*, {}** %9, i64 3 %11 = bitcast {}** %10 to i64* %12 = load i64, i64* %11, align 8 %13 = bitcast {}* %6 to double** %14 = load double*, double** %13, align 8 %15 = bitcast {}* %8 to {}** %16 = getelementptr inbounds {}*, {}** %15, i64 3 %17 = bitcast {}** %16 to i64* %18 = load i64, i64* %17, align 8 %19 = bitcast {}* %8 to double** %20 = load double*, double** %19, align 8 %21 = bitcast {}* %4 to {}** %22 = getelementptr inbounds {}*, {}** %21, i64 3 %23 = bitcast {}** %22 to i64* %24 = load i64, i64* %23, align 8 %25 = bitcast {}* %4 to double** %26 = load double*, double** %25, align 8 ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 3 within `inner_noalloc_ib!` br label %L2 L2: ; preds = %L27, %top %indvar = phi i64 [ %indvar.next, %L27 ], [ 0, %top ] %value_phi = phi i64 [ %59, %L27 ], [ 1, %top ] %27 = mul i64 %24, %indvar %scevgep = getelementptr double, double* %26, i64 %27 %28 = add i64 %27, 100 %scevgep12 = getelementptr double, double* %26, i64 %28 %29 = mul i64 %12, %indvar %30 = mul i64 %18, %indvar %31 = add nsw i64 %value_phi, -1 %32 = mul i64 %12, %31 %33 = mul i64 %18, %31 %34 = mul i64 %24, %31 %35 = add i64 %30, 100 %scevgep20 = getelementptr double, double* %20, i64 %35 %scevgep18 = getelementptr double, double* %20, i64 %30 %36 = add i64 %29, 100 %scevgep16 = getelementptr double, double* %14, i64 %36 %scevgep14 = getelementptr double, double* %14, i64 %29 %bound0 = icmp ult double* %scevgep, %scevgep16 %bound1 = icmp ult double* %scevgep14, %scevgep12 %found.conflict = and i1 %bound0, %bound1 %bound022 = icmp ult double* %scevgep, %scevgep20 %bound123 = icmp ult double* %scevgep18, %scevgep12 %found.conflict24 = and i1 %bound022, %bound123 %conflict.rdx = or i1 %found.conflict, %found.conflict24 br i1 %conflict.rdx, label %L5, label %vector.body vector.body: ; preds = %vector.body, % L2 %index = phi i64 [ %index.next, %vector.body ], [ 0, %L2 ] ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 4 within `inner_noalloc_ib!` ; ┌ @ array.jl:925 within `getindex` %37 = add i64 %index, %32 %38 = getelementptr inbounds double, double* %14, i64 %37 %39 = bitcast double* %38 to <4 x double>* %wide.load = load <4 x double>, <4 x double>* %39, align 8 %40 = add i64 %index, %33 %41 = getelementptr inbounds double, double* %20, i64 %40 %42 = bitcast double* %41 to <4 x double>* %wide.load25 = load <4 x double>, <4 x double>* %42, align 8 ; └ ; ┌ @ float.jl:383 within `+` %43 = fadd <4 x double> %wide.load, %wide.load25 ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `inner_noalloc_ib!` ; ┌ @ array.jl:968 within `setindex!` %44 = add i64 %index, %34 %45 = getelementptr inbounds double, double* %26, i64 %44 %46 = bitcast double* %45 to <4 x double>* store <4 x double> %43, <4 x double>* %46, align 8 %index.next = add nuw i64 %index, 4 %47 = icmp eq i64 %index.next, 100 br i1 %47, label %L27, label %vector.body L5: ; preds = %L5, %L2 %value_phi2 = phi i64 [ %58, %L5 ], [ 1, %L2 ] ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 4 within `inner_noalloc_ib!` ; ┌ @ array.jl:925 within `getindex` %48 = add nsw i64 %value_phi2, -1 %49 = add i64 %48, %32 %50 = getelementptr inbounds double, double* %14, i64 %49 %51 = load double, double* %50, align 8 %52 = add i64 %48, %33 %53 = getelementptr inbounds double, double* %20, i64 %52 %54 = load double, double* %53, align 8 ; └ ; ┌ @ float.jl:383 within `+` %55 = fadd double %51, %54 ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 5 within `inner_noalloc_ib!` ; ┌ @ array.jl:968 within `setindex!` %56 = add i64 %48, %34 %57 = getelementptr inbounds double, double* %26, i64 %56 store double %55, double* %57, align 8 ; └ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 6 within `inner_noalloc_ib!` ; ┌ @ range.jl:883 within `iterate` ; │┌ @ promotion.jl:477 within `==` %.not.not = icmp eq i64 %value_phi2, 100 ; │└ %58 = add nuw nsw i64 %value_phi2, 1 ; └ br i1 %.not.not, label %L27, label %L5 L27: ; preds = %L5, %vector.bo dy ; ┌ @ range.jl:883 within `iterate` ; │┌ @ promotion.jl:477 within `==` %.not.not10 = icmp eq i64 %value_phi, 100 ; │└ %59 = add nuw nsw i64 %value_phi, 1 ; └ %indvar.next = add i64 %indvar, 1 br i1 %.not.not10, label %L40, label %L2 L40: ; preds = %L27 ret {}* inttoptr (i64 139851186921480 to {}*) }

If you look closely, you will see things like:

```
%wide.load24 = load <4 x double>, <4 x double> addrspac(13)* %46, align 8
; └
; ┌ @ float.jl:395 within `+'
%47 = fadd <4 x double> %wide.load, %wide.load24
```

What this is saying is that it's loading and adding 4 `Float64`

s at a time! This feature of the processor is known as SIMD: single input multiple data. If certain primitive floating point operations, like `+`

and `*`

, are done in succession (i.e. no inbounds checks between them!), then the processor can lump them together and do multiples at once. Since clock cycles have stopped improving while transistors have gotten smaller, this "lumping" has been a big source of speedups in computational mathematics even though the actual `+`

and `*`

hasn't gotten faster. Thus to get full speed we want to make sure this is utilized whenever possible, which essentially just amounts to doing type inferred loops with no branches or bounds checks in the way.

### FMA

Modern processors have a single operation that fuses the multiplication and the addition in the operation `x*y+z`

, known as a *fused multiply-add* or FMA. Note that FMA has less floating point roundoff error than the two operation form. We can see this intrinsic in the resulting LLVM IR:

@code_llvm fma(2.0,5.0,3.0)

; @ floatfuncs.jl:422 within `fma` define double @julia_fma_6551(double %0, double %1, double %2) #0 { common.ret: ; ┌ @ floatfuncs.jl:417 within `fma_llvm` %3 = call double @llvm.fma.f64(double %0, double %1, double %2) ; └ ret double %3 }

The Julia function `muladd`

will automatically choose between FMA and the original form depending on the availability of the routine in the processor. The MuladdMacro.jl package has a macro `@muladd`

which pulls apart statements to add `muladd`

expressions. For example, `x1*y1 + x2*y2 + x3*y3`

can be rewritten as:

`muladd(x1,y1,muladd(x2,y2,x3*y3))`

Which reduces the linear combination to just 3 arithmetic operations. FMA operations can be SIMD'd.

### Inlining

All of this would go to waste if function call costs of 50 clock cycles were interrupting every single `+`

. Fortunately these function calls disappear during the compilation process due to what's known as inlining. Essentially, if the function call is determined to be "cheap enough", the actual function call is removed and the code is basically pasted into the function caller. We can force a function call to occur by telling it to not inline:

@noinline fnoinline(x,y) = x + y finline(x,y) = x + y # Can add @inline, but this is automatic here function qinline(x,y) a = 4 b = 2 c = finline(x,a) d = finline(b,c) finline(d,y) end function qnoinline(x,y) a = 4 b = 2 c = fnoinline(x,a) d = fnoinline(b,c) fnoinline(d,y) end

qnoinline (generic function with 1 method)

@code_llvm qinline(1.0,2.0)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 4 within `qinline` define double @julia_qinline_6554(double %0, double %1) #0 { top: ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 7 within `qinline` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :3 within `finline` ; │┌ @ promotion.jl:388 within `+` @ float.jl:383 %2 = fadd double %0, 4.000000e+00 ; └└ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 8 within `qinline` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :3 within `finline` ; │┌ @ promotion.jl:388 within `+` @ float.jl:383 %3 = fadd double %2, 2.000000e+00 ; └└ ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 9 within `qinline` ; ┌ @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd :3 within `finline` ; │┌ @ float.jl:383 within `+` %4 = fadd double %3, %1 ; └└ ret double %4 }

@code_llvm qnoinline(1.0,2.0)

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 11 within `qnoinline` define double @julia_qnoinline_6556(double %0, double %1) #0 { top: ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 14 within `qnoinline` %2 = call double @j_fnoinline_6558(double %0, i64 signext 4) #0 ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 15 within `qnoinline` %3 = call double @j_fnoinline_6559(i64 signext 2, double %2) #0 ; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 16 within `qnoinline` %4 = call double @j_fnoinline_6560(double %3, double %1) #0 ret double %4 }

We can see now that it keeps the function calls:

`%4 = call double @julia_fnoinline_21538(double %3, double %1)`

and this is slower in comparison to what we had before (but it still infers).

x = 1.0 y = 2.0 @btime qinline(x,y)

21.988 ns (1 allocation: 16 bytes) 9.0

@btime qnoinline(x,y)

23.193 ns (1 allocation: 16 bytes) 9.0

Note that if we ever want to go the other direction and tell Julia to inline as much as possible, one can use the macro `@inline`

.

### Summary

Scalar operations are super cheap, and if they are cache-aligned then more than one will occur in a clock cycle.

Inlining a function will remove the high function call overhead.

Branch prediction is pretty good these days, so keep them out of super tight inner loops but don't worry all too much about them.

Cache misses are quite expensive the further out it goes.

## Note on Benchmarking

Julia's compiler is smart. This means that if you don't try hard enough, Julia's compiler might get rid of your issues. For example, it can delete branches and directly compute the result if all of the values are known at compile time. So be very careful when benchmarking: your tests may have just compiled away!

Notice the following:

@btime qinline(1.0,2.0)

1.599 ns (0 allocations: 0 bytes) 9.0

Dang, that's much faster! But if you look into it, Julia's compiler is actually "cheating" on this benchmark:

cheat() = qinline(1.0,2.0) @code_llvm cheat()

; @ /home/runner/work/SciMLBook/SciMLBook/_weave/lecture02/optimizing.jmd: 2 within `cheat` define double @julia_cheat_6592() #0 { top: ret double 9.000000e+00 }

It realized that `1.0`

and `2.0`

are constants, so it did what's known as *constant propagation*, and then used those constants inside of the function. It realized that the solution is always `9`

, so it compiled the function that... spits out `9`

! So it's fast because it's not computing anything. So be very careful about propagation of constants and literals. In general this is a very helpful feature, but when benchmarking this can cause some weird behavior. If a micro benchmark is taking less than a nanosecond, check and see if the compiler "fixed" your code!

## Conclusion

Optimize your serial code before you parallelize. There's a lot to think about.

# Discussion Questions

Here's a few discussion questions to think about performance engineering in scientific tasks:

What are the advantages of a

`Vector{Array}`

vs a`Matrix`

? What are the disadvantage? (What's different?)What is a good way to implement a data frame?

What are some good things that come out of generic functions for free? What are some things you should watch out for with generic functions?