~rdoering/ubuntu/karmic/erlang/fix-535090

.TH erl 1 "erts  5.7.2" "Ericsson AB" "USER COMMANDS"

\fI+sFlag Value\fR:

Scheduling specific flags\&.

.RS 4

.LP

 

.RS 2

.TP 4

.B

+sbt BindType:

 

.RS 4

.LP

Set scheduler bind type\&. Currently valid \fIBindType\fRs: 

.LP

 

.RS 2

.TP 4

.B

\fIu\fR:

Same as erlang:system_flag(scheduler_bind_type, unbound)\&. 

.TP 4

.B

\fIns\fR:

Same as erlang:system_flag(scheduler_bind_type, no_spread)\&. 

.TP 4

.B

\fIts\fR:

Same as erlang:system_flag(scheduler_bind_type, thread_spread)\&. 

.TP 4

.B

\fIps\fR:

Same as erlang:system_flag(scheduler_bind_type, processor_spread)\&. 

.TP 4

.B

\fInnts\fR:

Same as erlang:system_flag(scheduler_bind_type, no_node_thread_spread)\&. 

.TP 4

.B

\fInnps\fR:

Same as erlang:system_flag(scheduler_bind_type, no_node_processor_spread)\&. 

.TP 4

.B

\fItnnps\fR:

Same as erlang:system_flag(scheduler_bind_type, thread_no_node_processor_spread)\&. 

.TP 4

.B

\fIdb\fR:

Same as erlang:system_flag(scheduler_bind_type, default_bind)\&. 

.RE

.LP

 

.LP

Binding of schedulers are currently only supported on newer Linux and Solaris systems\&.

.LP

 

.LP

If no CPU topology is available when the \fI+sbt\fR flag is processed and \fIBindType\fR is any other type than \fIu\fR, the runtime system will fail to start\&. CPU topology can be defined using the +sct flag\&. Note that the \fI+sct\fR flag may have to be passed before the \fI+sbt\fR flag on the command line (in case no CPU topology has been automatically detected)\&.

.LP

 

.LP

For more information, see erlang:system_flag(scheduler_bind_type, SchedulerBindType)\&. 

.RE

.TP 4

.B

\fI+sct CpuTopology\fR:

 

.RS 4

.RS 2

.TP 2

*

\fI<Id> = integer(); when 0 =< <Id> =< 65535\fR

.TP 2

*

\fI<IdRange> = <Id>-<Id>\fR

.TP 2

*

\fI<IdOrIdRange> = <Id> | <IdRange>\fR

.TP 2

*

\fI<IdList> = <IdOrIdRange>, <IdOrIdRange> | <IdOrIdRange>\fR

.TP 2

*

\fI<LogicalIds> = L<IdList>\fR

.TP 2

*

\fI<ThreadIds> = T<IdList> | t<IdList>\fR

.TP 2

*

\fI<CoreIds> = C<IdList> | c<IdList>\fR

.TP 2

*

\fI<ProcessorIds> = P<IdList> | p<IdList>\fR

.TP 2

*

\fI<NodeIds> = N<IdList> | n<IdList>\fR

.TP 2

*

\fI<IdDefs> = <LogicalIds><ThreadIds><CoreIds><ProcessorIds><NodeIds>\fR

.TP 2

*

\fICpuTopology = <IdDefs>:<IdDefs> | <IdDefs>\fR

.RE

.LP

 

.LP

Upper-case letters signify real identifiers and lower-case letters signify fake identifiers only used for description of the topology\&. Identifiers passed as real identifiers may be used by the runtime system when trying to access specific hardware and if they are not correct the behavior is undefined\&. Faked logical CPU identifiers are not accepted since there is no point in defining the CPU topology without real logical CPU identifiers\&. Thread, core, processor, and node identifiers may be left out\&. If left out, thread id defaults to \fIt0\fR, core id defaults to \fIc0\fR, processor id defaults to \fIp0\fR, and node id will be left undefined\&. Either all processors or no processors should have node identifiers defined\&. 

.LP

 

.LP

Both increasing and decreasing \fI<IdRange>\fRs are allowed\&.

.LP

 

.LP

NUMA node identifiers are system wide\&. That is, each NUMA node on the system have to have a unique identifier\&. Processor identifiers are also system wide\&. Core identifiers are processor wide\&. Thread identifiers are core wide\&.

.LP

 

.LP

The order of the identifier types imply the hierarchy of the CPU topology\&. Currently, the only valid order is: logical, thread, core, processor, node\&. That is, thread is part of a core which is part of a processor which is part of a NUMA node\&. This will, however, change in the future, since multiple NUMA nodes can be part of a processor, but this is not supported yet\&. 

.LP

 

.LP

If a list of identifiers is used in an \fI<IdDefs>\fR:

.LP

 

.RS 2

.TP 2

*

\fI<LogicalIds>\fR have to be a list of identifiers\&.

.TP 2

*

At least one other identifier type apart from \fI<LogicalIds>\fR also have to have a list of identifiers\&.

.TP 2

*

All lists of identifiers have to produce the same amount of identifiers\&.

.RE

.LP

 

.LP

A simple example\&. A single quad core processor may be described this way:

.LP

 

 

.nf

% erl +sct L0-3c0-3

 

1> erlang:system_info(cpu_topology)\&.

 

[{processor,[{core,{logical,0}},

             {core,{logical,1}},

             {core,{logical,2}},

             {core,{logical,3}}]}]

 

.fi

.LP

 

.LP

A little more complicated example\&. Two quad core processors\&. Each processor in its own NUMA node\&. The ordering of logical processors is a little weird\&. This in order to give a better example of identifier lists:

.LP

 

 

.nf

% erl +sct L0-1,3-2c0-3p0N0:L7,4,6-5c0-3p1N1

 

1> erlang:system_info(cpu_topology)\&.

 

[{node,[{processor,[{core,{logical,0}},

                    {core,{logical,1}},

                    {core,{logical,3}},

                    {core,{logical,2}}]}]},

 {node,[{processor,[{core,{logical,7}},

                    {core,{logical,4}},

                    {core,{logical,6}},

                    {core,{logical,5}}]}]}]

 

.fi

.LP

 

.LP

As long as real identifiers are correct it is okay to pass a CPU topology that is not a correct description of the CPU topology\&. When used with care this can actually be very useful\&. This in order to trick the emulator to bind its schedulers as you want\&. For example, if you want to run multiple Erlang runtime systems on the same machine, you want to reduce the amount of schedulers used and manipulate the CPU topology so that they bind to different logical CPUs\&. An example, with two Erlang runtime systems on a quad core machine:

.LP

 

 

.nf

% erl +sct L0-3c0-3 +sbt db +S3:2 -detached -noinput -noshell -sname one

 

% erl +sct L3-0c0-3 +sbt db +S3:2 -detached -noinput -noshell -sname two

 

 

.fi

.LP

 

.LP

In this example each runtime system have two schedulers each online, and all schedulers online will run on different cores\&. If we change to one scheduler online on one runtime system, and three schedulers online on the other, all schedulers online will still run on different cores\&.

.LP

 

.LP

Note that a faked CPU topology that does not reflect how the real CPU topology looks like is likely to decrease the performance of the runtime system\&.

.LP

 

.LP

For more information, see erlang:system_flag(cpu_topology, CpuTopology)\&.

.RE

.RE

.RE

.TP 4

.B