From 2a0e4b5e62f1eb50ae0f8249be02bdaa797a409e Mon Sep 17 00:00:00 2001 From: Ralph Castain Date: Thu, 9 Jan 2014 04:44:28 +0000 Subject: [PATCH] Update the orterun help messages and man page to reflect new map/rank/bind options and defaults. Thanks to Paul Hargrove for reporting it. cmr=v1.7.4:reviewer=jsquyres This commit was SVN r30173. --- orte/tools/orterun/orterun.1in | 54 ++++++++++++++++++++-------------- orte/tools/orterun/orterun.c | 6 ++-- 2 files changed, 35 insertions(+), 25 deletions(-) diff --git a/orte/tools/orterun/orterun.1in b/orte/tools/orterun/orterun.1in index 0f745197c5..d99302f28a 100644 --- a/orte/tools/orterun/orterun.1in +++ b/orte/tools/orterun/orterun.1in @@ -185,12 +185,21 @@ On each node, launch one process -- equivalent to \fI-npernode\fP 1. . . .P -To map processes to nodes: +To map processes: . . .TP -.B -loadbalance\fR,\fP --loadbalance -Uniform distribution of ranks across all nodes. See more detailed description below. +.B --map-by +Map to the specified object, defaults to \fIsocket\fP. Supported options +include slot, hwthread, core, socket, numa, board, and node. +. +.TP +.B -bycore\fR,\fP --bycore +Map processes by core (deprecated in favor of --map-by core) +. +.TP +.B -bysocket\fR,\fP --bysocket +Map processes by socket (deprecated in favor of --map-by socket) . .TP .B -nolocal\fR,\fP --nolocal @@ -215,22 +224,29 @@ ranks in a round-robin, "by node" manner. . . .P +To rank processes: +. +. +.TP +.B --rank-by +Rank in round-robin fashion according to the specified object, +defaults to \fIslot\fP. Supported options +include slot, hwthread, core, socket, numa, board, and node. +. +. +. +. +.P For process binding: . .TP -.B -bycore\fR,\fP --bycore -Associate processes with successive cores -if used with one of the \fI-bind-to-*\fP options. -. -.TP -.B -bysocket\fR,\fP --bysocket -Associate processes with successive processor sockets -if used with one of the \fI-bind-to-*\fP options. +.B --bind-to +Bind processes to the specified object, defaults to \fIcore\fP. Supported options +include slot, hwthread, core, socket, numa, board, and none. . .TP .B -cpus-per-proc\fR,\fP --cpus-per-proc <#perproc> -Use the number of cores per process -if used with one of the \fI-bind-to-*\fP options. +Bind each process to the specified number of cpus. . .TP .B -cpus-per-rank\fR,\fP --cpus-per-rank <#perrank> @@ -238,15 +254,15 @@ Alias for \fI-cpus-per-proc\fP. . .TP .B -bind-to-core\fR,\fP --bind-to-core -Bind processes to cores. +Bind processes to cores (deprecated in favor of --bind-to core) . .TP .B -bind-to-socket\fR,\fP --bind-to-socket -Bind processes to processor sockets. +Bind processes to processor sockets (deprecated in favor of --bind-to socket) . .TP .B -bind-to-none\fR,\fP --bind-to-none -Do not bind processes. (Default.) +Do not bind processes (deprecated in favor of --bind-to none) . .TP .B -report-bindings\fR,\fP --report-bindings @@ -696,17 +712,11 @@ Consider the same hostfile as above, again with \fI-np\fP 6: mpirun 0 1 2 3 4 5 - mpirun -loadbalance 0 1 2 3 4 5 - mpirun -bynode 0 3 1 4 2 5 mpirun -nolocal 0 1 2 3 4 5 . .PP -The \fI-loadbalance\fP option tries to spread processes out fairly among the -nodes. -. -.PP The \fI-bynode\fP option does likewise but numbers the processes in "by node" in a round-robin fashion. . diff --git a/orte/tools/orterun/orterun.c b/orte/tools/orterun/orterun.c index 1add88cc98..581d90617b 100644 --- a/orte/tools/orterun/orterun.c +++ b/orte/tools/orterun/orterun.c @@ -14,7 +14,7 @@ * Copyright (c) 2007-2009 Sun Microsystems, Inc. All rights reserved. * Copyright (c) 2007-2013 Los Alamos National Security, LLC. All rights * reserved. - * Copyright (c) 2013 Intel, Inc. All rights reserved. + * Copyright (c) 2013-2014 Intel, Inc. All rights reserved. * $COPYRIGHT$ * * Additional copyrights may follow @@ -374,7 +374,7 @@ static opal_cmd_line_init_t cmd_line_init[] = { /* Mapping options */ { "rmaps_base_mapping_policy", '\0', NULL, "map-by", 1, NULL, OPAL_CMD_LINE_TYPE_STRING, - "Mapping Policy [slot (default) | hwthread | core | socket | numa | board | node]" }, + "Mapping Policy [slot | hwthread | core | socket (default) | numa | board | node]" }, /* Ranking options */ { "rmaps_base_ranking_policy", '\0', NULL, "rank-by", 1, @@ -384,7 +384,7 @@ static opal_cmd_line_init_t cmd_line_init[] = { /* Binding options */ { "hwloc_base_binding_policy", '\0', NULL, "bind-to", 1, NULL, OPAL_CMD_LINE_TYPE_STRING, - "Policy for binding processes [none (default) | hwthread | core | socket | numa | board] (supported qualifiers: overload-allowed,if-supported)" }, + "Policy for binding processes [none | hwthread | core (default) | socket | numa | board] (supported qualifiers: overload-allowed,if-supported)" }, /* backward compatiblity */ { "hwloc_base_bind_to_core", '\0', "bind-to-core", "bind-to-core", 0,