sys-utils/chcpu.c

   1 /*
   2  * chcpu - CPU configuration tool
   3  *
   4  * Copyright IBM Corp. 2011
   5  * Author(s): Heiko Carstens <heiko.carstens@de.ibm.com>,
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it would be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #include <ctype.h>
  23 #include <dirent.h>
  24 #include <errno.h>
  25 #include <fcntl.h>
  26 #include <getopt.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <sys/utsname.h>
  31 #include <unistd.h>
  32 #include <stdarg.h>
  33 #include <sys/types.h>
  34 #include <sys/stat.h>
  35
  36 #include "cpuset.h"
  37 #include "nls.h"
  38 #include "xalloc.h"
  39 #include "c.h"
  40 #include "strutils.h"
  41 #include "bitops.h"
  42 #include "path.h"
  43 #include "closestream.h"
  44 #include "optutils.h"
  45
  46 #define EXCL_ERROR "--{configure,deconfigure,disable,dispatch,enable}"
  47
  48 /* partial success, otherwise we return regular EXIT_{SUCCESS,FAILURE} */
  49 #define CHCPU_EXIT_SOMEOK       64
  50
  51 #define _PATH_SYS_CPU           "/sys/devices/system/cpu"
  52 #define _PATH_SYS_CPU_ONLINE    _PATH_SYS_CPU "/online"
  53 #define _PATH_SYS_CPU_RESCAN    _PATH_SYS_CPU "/rescan"
  54 #define _PATH_SYS_CPU_DISPATCH  _PATH_SYS_CPU "/dispatching"
  55
  56 static cpu_set_t *onlinecpus;
  57 static int maxcpus;
  58
  59 #define is_cpu_online(cpu) (CPU_ISSET_S((cpu), CPU_ALLOC_SIZE(maxcpus), onlinecpus))
  60 #define num_online_cpus()  (CPU_COUNT_S(CPU_ALLOC_SIZE(maxcpus), onlinecpus))
  61
  62 enum {
  63         CMD_CPU_ENABLE  = 0,
  64         CMD_CPU_DISABLE,
  65         CMD_CPU_CONFIGURE,
  66         CMD_CPU_DECONFIGURE,
  67         CMD_CPU_RESCAN,
  68         CMD_CPU_DISPATCH_HORIZONTAL,
  69         CMD_CPU_DISPATCH_VERTICAL,
  70 };
  71
  72 /* returns:   0 = success
  73  *          < 0 = failure
  74  *          > 0 = partial success
  75  */
  76 static int cpu_enable(cpu_set_t *cpu_set, size_t setsize, int enable)
  77 {
  78         unsigned int cpu;
  79         int online, rc;
  80         int configured = -1;
  81         size_t fails = 0;
  82
  83         for (cpu = 0; cpu < setsize; cpu++) {
  84                 if (!CPU_ISSET(cpu, cpu_set))
  85                         continue;
  86                 if (!path_exist(_PATH_SYS_CPU "/cpu%d", cpu)) {
  87                         warnx(_("CPU %u does not exist"), cpu);
  88                         fails++;
  89                         continue;
  90                 }
  91                 if (!path_exist(_PATH_SYS_CPU "/cpu%d/online", cpu)) {
  92                         warnx(_("CPU %u is not hot pluggable"), cpu);
  93                         fails++;
  94                         continue;
  95                 }
  96                 online = path_read_s32(_PATH_SYS_CPU "/cpu%d/online", cpu);
  97                 if ((online == 1) && (enable == 1)) {
  98                         printf(_("CPU %u is already enabled\n"), cpu);
  99                         continue;
 100                 }
 101                 if ((online == 0) && (enable == 0)) {
 102                         printf(_("CPU %u is already disabled\n"), cpu);
 103                         continue;
 104                 }
 105                 if (path_exist(_PATH_SYS_CPU "/cpu%d/configure", cpu))
 106                         configured = path_read_s32(_PATH_SYS_CPU "/cpu%d/configure", cpu);
 107                 if (enable) {
 108                         rc = path_write_str("1", _PATH_SYS_CPU "/cpu%d/online", cpu);
 109                         if ((rc == -1) && (configured == 0)) {
 110                                 warn(_("CPU %u enable failed (CPU is deconfigured)"), cpu);
 111                                 fails++;
 112                         } else if (rc == -1) {
 113                                 warn(_("CPU %u enable failed"), cpu);
 114                                 fails++;
 115                         } else
 116                                 printf(_("CPU %u enabled\n"), cpu);
 117                 } else {
 118                         if (onlinecpus && num_online_cpus() == 1) {
 119                                 warnx(_("CPU %u disable failed (last enabled CPU)"), cpu);
 120                                 fails++;
 121                                 continue;
 122                         }
 123                         rc = path_write_str("0", _PATH_SYS_CPU "/cpu%d/online", cpu);
 124                         if (rc == -1) {
 125                                 warn(_("CPU %u disable failed"), cpu);
 126                                 fails++;
 127                         } else {
 128                                 printf(_("CPU %u disabled\n"), cpu);
 129                                 if (onlinecpus)
 130                                         CPU_CLR(cpu, onlinecpus);
 131                         }
 132                 }
 133         }
 134
 135         return fails == 0 ? 0 : fails == setsize ? -1 : 1;
 136 }
 137
 138 static int cpu_rescan(void)
 139 {
 140         if (!path_exist(_PATH_SYS_CPU_RESCAN))
 141                 errx(EXIT_FAILURE, _("This system does not support rescanning of CPUs"));
 142         if (path_write_str("1", _PATH_SYS_CPU_RESCAN) == -1)
 143                 err(EXIT_FAILURE, _("Failed to trigger rescan of CPUs"));
 144         printf(_("Triggered rescan of CPUs\n"));
 145         return 0;
 146 }
 147
 148 static int cpu_set_dispatch(int mode)
 149 {
 150         if (!path_exist(_PATH_SYS_CPU_DISPATCH))
 151                 errx(EXIT_FAILURE, _("This system does not support setting "
 152                                      "the dispatching mode of CPUs"));
 153         if (mode == 0) {
 154                 if (path_write_str("0", _PATH_SYS_CPU_DISPATCH) == -1)
 155                         err(EXIT_FAILURE, _("Failed to set horizontal dispatch mode"));
 156                 printf(_("Successfully set horizontal dispatching mode\n"));
 157         } else {
 158                 if (path_write_str("1", _PATH_SYS_CPU_DISPATCH) == -1)
 159                         err(EXIT_FAILURE, _("Failed to set vertical dispatch mode"));
 160                 printf(_("Successfully set vertical dispatching mode\n"));
 161         }
 162         return 0;
 163 }
 164
 165 /* returns:   0 = success
 166  *          < 0 = failure
 167  *          > 0 = partial success
 168  */
 169 static int cpu_configure(cpu_set_t *cpu_set, size_t setsize, int configure)
 170 {
 171         unsigned int cpu;
 172         int rc, current;
 173         size_t fails = 0;
 174
 175         for (cpu = 0; cpu < setsize; cpu++) {
 176                 if (!CPU_ISSET(cpu, cpu_set))
 177                         continue;
 178                 if (!path_exist(_PATH_SYS_CPU "/cpu%d", cpu)) {
 179                         warnx(_("CPU %u does not exist"), cpu);
 180                         fails++;
 181                         continue;
 182                 }
 183                 if (!path_exist(_PATH_SYS_CPU "/cpu%d/configure", cpu)) {
 184                         warnx(_("CPU %u is not configurable"), cpu);
 185                         fails++;
 186                         continue;
 187                 }
 188                 current = path_read_s32(_PATH_SYS_CPU "/cpu%d/configure", cpu);
 189                 if ((current == 1) && (configure == 1)) {
 190                         printf(_("CPU %u is already configured\n"), cpu);
 191                         continue;
 192                 }
 193                 if ((current == 0) && (configure == 0)) {
 194                         printf(_("CPU %u is already deconfigured\n"), cpu);
 195                         continue;
 196                 }
 197                 if ((current == 1) && (configure == 0) && onlinecpus &&
 198                     is_cpu_online(cpu)) {
 199                         warnx(_("CPU %u deconfigure failed (CPU is enabled)"), cpu);
 200                         fails++;
 201                         continue;
 202                 }
 203                 if (configure) {
 204                         rc = path_write_str("1", _PATH_SYS_CPU "/cpu%d/configure", cpu);
 205                         if (rc == -1) {
 206                                 warn(_("CPU %u configure failed"), cpu);
 207                                 fails++;
 208                         } else
 209                                 printf(_("CPU %u configured\n"), cpu);
 210                 } else {
 211                         rc = path_write_str("0", _PATH_SYS_CPU "/cpu%d/configure", cpu);
 212                         if (rc == -1) {
 213                                 warn(_("CPU %u deconfigure failed"), cpu);
 214                                 fails++;
 215                         } else
 216                                 printf(_("CPU %u deconfigured\n"), cpu);
 217                 }
 218         }
 219
 220         return fails == 0 ? 0 : fails == setsize ? -1 : 1;
 221 }
 222
 223 static void cpu_parse(char *cpu_string, cpu_set_t *cpu_set, size_t setsize)
 224 {
 225         int rc;
 226
 227         rc = cpulist_parse(cpu_string, cpu_set, setsize, 1);
 228         if (rc == 0)
 229                 return;
 230         if (rc == 2)
 231                 errx(EXIT_FAILURE, _("invalid CPU number in CPU list: %s"), cpu_string);
 232         errx(EXIT_FAILURE, _("failed to parse CPU list: %s"), cpu_string);
 233 }
 234
 235 static void __attribute__((__noreturn__)) usage(FILE *out)
 236 {
 237         fprintf(out, _(
 238                 "\nUsage:\n"
 239                 " %s [options]\n"), program_invocation_short_name);
 240
 241         fputs(USAGE_SEPARATOR, out);
 242         fputs(_("Configure CPUs in a multi-processor system.\n"), out);
 243
 244         puts(_( "\nOptions:\n"
 245                 "  -h, --help                    print this help\n"
 246                 "  -e, --enable <cpu-list>       enable cpus\n"
 247                 "  -d, --disable <cpu-list>      disable cpus\n"
 248                 "  -c, --configure <cpu-list>    configure cpus\n"
 249                 "  -g, --deconfigure <cpu-list>  deconfigure cpus\n"
 250                 "  -p, --dispatch <mode>         set dispatching mode\n"
 251                 "  -r, --rescan                  trigger rescan of cpus\n"
 252                 "  -V, --version                 output version information and exit\n"));
 253
 254         exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
 255 }
 256
 257 int main(int argc, char *argv[])
 258 {
 259         cpu_set_t *cpu_set;
 260         size_t setsize;
 261         int cmd = -1;
 262         int c, rc;
 263
 264         static const struct option longopts[] = {
 265                 { "configure",  required_argument, NULL, 'c' },
 266                 { "deconfigure",required_argument, NULL, 'g' },
 267                 { "disable",    required_argument, NULL, 'd' },
 268                 { "dispatch",   required_argument, NULL, 'p' },
 269                 { "enable",     required_argument, NULL, 'e' },
 270                 { "help",       no_argument,       NULL, 'h' },
 271                 { "rescan",     no_argument,       NULL, 'r' },
 272                 { "version",    no_argument,       NULL, 'V' },
 273                 { NULL,         0, NULL, 0 }
 274         };
 275
 276         static const ul_excl_t excl[] = {       /* rows and cols in ASCII order */
 277                 { 'c','d','e','g','p' },
 278                 { 0 }
 279         };
 280         int excl_st[ARRAY_SIZE(excl)] = UL_EXCL_STATUS_INIT;
 281
 282         setlocale(LC_ALL, "");
 283         bindtextdomain(PACKAGE, LOCALEDIR);
 284         textdomain(PACKAGE);
 285         atexit(close_stdout);
 286
 287         maxcpus = get_max_number_of_cpus();
 288         if (maxcpus < 1)
 289                 errx(EXIT_FAILURE, _("cannot determine NR_CPUS; aborting"));
 290         if (path_exist(_PATH_SYS_CPU_ONLINE))
 291                 onlinecpus = path_read_cpulist(maxcpus, _PATH_SYS_CPU_ONLINE);
 292         setsize = CPU_ALLOC_SIZE(maxcpus);
 293         cpu_set = CPU_ALLOC(maxcpus);
 294         if (!cpu_set)
 295                 err(EXIT_FAILURE, _("cpuset_alloc failed"));
 296
 297         while ((c = getopt_long(argc, argv, "c:d:e:g:hp:rV", longopts, NULL)) != -1) {
 298
 299                 err_exclusive_options(c, longopts, excl, excl_st);
 300
 301                 switch (c) {
 302                 case 'c':
 303                         cmd = CMD_CPU_CONFIGURE;
 304                         cpu_parse(argv[optind - 1], cpu_set, setsize);
 305                         break;
 306                 case 'd':
 307                         cmd = CMD_CPU_DISABLE;
 308                         cpu_parse(argv[optind - 1], cpu_set, setsize);
 309                         break;
 310                 case 'e':
 311                         cmd = CMD_CPU_ENABLE;
 312                         cpu_parse(argv[optind - 1], cpu_set, setsize);
 313                         break;
 314                 case 'g':
 315                         cmd = CMD_CPU_DECONFIGURE;
 316                         cpu_parse(argv[optind - 1], cpu_set, setsize);
 317                         break;
 318                 case 'h':
 319                         usage(stdout);
 320                 case 'p':
 321                         if (strcmp("horizontal", argv[optind - 1]) == 0)
 322                                 cmd = CMD_CPU_DISPATCH_HORIZONTAL;
 323                         else if (strcmp("vertical", argv[optind - 1]) == 0)
 324                                 cmd = CMD_CPU_DISPATCH_VERTICAL;
 325                         else
 326                                 errx(EXIT_FAILURE, _("unsupported argument: %s"),
 327                                      argv[optind -1 ]);
 328                         break;
 329                 case 'r':
 330                         cmd = CMD_CPU_RESCAN;
 331                         break;
 332                 case 'V':
 333                         printf(UTIL_LINUX_VERSION);
 334                         return EXIT_SUCCESS;
 335                 default:
 336                         errtryhelp(EXIT_FAILURE);
 337                 }
 338         }
 339
 340         if ((argc == 1) || (argc != optind))
 341                 usage(stderr);
 342
 343         switch (cmd) {
 344         case CMD_CPU_ENABLE:
 345                 rc = cpu_enable(cpu_set, maxcpus, 1);
 346                 break;
 347         case CMD_CPU_DISABLE:
 348                 rc = cpu_enable(cpu_set, maxcpus, 0);
 349                 break;
 350         case CMD_CPU_CONFIGURE:
 351                 rc = cpu_configure(cpu_set, maxcpus, 1);
 352                 break;
 353         case CMD_CPU_DECONFIGURE:
 354                 rc = cpu_configure(cpu_set, maxcpus, 0);
 355                 break;
 356         case CMD_CPU_RESCAN:
 357                 rc = cpu_rescan();
 358                 break;
 359         case CMD_CPU_DISPATCH_HORIZONTAL:
 360                 rc = cpu_set_dispatch(0);
 361                 break;
 362         case CMD_CPU_DISPATCH_VERTICAL:
 363                 rc = cpu_set_dispatch(1);
 364                 break;
 365         default:
 366                 rc = -EINVAL;
 367                 break;
 368         }
 369
 370         return rc == 0 ? EXIT_SUCCESS :
 371                 rc < 0 ? EXIT_FAILURE : CHCPU_EXIT_SOMEOK;
 372 }