usr.sbin/cpucontrol/cpucontrol.c

   1 /*-
   2  * Copyright (c) 2008 Stanislav Sedov <stas@FreeBSD.org>.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 /*
  27  * This utility provides userland access to the cpuctl(4) pseudo-device
  28  * features.
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 #include <assert.h>
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <string.h>
  38 #include <unistd.h>
  39 #include <fcntl.h>
  40 #include <err.h>
  41 #include <sysexits.h>
  42 #include <dirent.h>
  43
  44 #include <sys/queue.h>
  45 #include <sys/param.h>
  46 #include <sys/types.h>
  47 #include <sys/stat.h>
  48 #include <sys/ioctl.h>
  49 #include <sys/cpuctl.h>
  50
  51 #include "cpucontrol.h"
  52 #include "amd.h"
  53 #include "intel.h"
  54 #include "via.h"
  55
  56 int     verbosity_level = 0;
  57
  58 #define DEFAULT_DATADIR "/usr/local/share/cpucontrol"
  59
  60 #define FLAG_I  0x01
  61 #define FLAG_M  0x02
  62 #define FLAG_U  0x04
  63
  64 #define OP_INVAL        0x00
  65 #define OP_READ         0x01
  66 #define OP_WRITE        0x02
  67 #define OP_OR           0x04
  68 #define OP_AND          0x08
  69
  70 #define HIGH(val)       (uint32_t)(((val) >> 32) & 0xffffffff)
  71 #define LOW(val)        (uint32_t)((val) & 0xffffffff)
  72
  73 /*
  74  * Macros for freeing SLISTs, probably must be in /sys/queue.h
  75  */
  76 #define SLIST_FREE(head, field, freef) do {                             \
  77                 typeof(SLIST_FIRST(head)) __elm0;                       \
  78                 typeof(SLIST_FIRST(head)) __elm;                        \
  79                 SLIST_FOREACH_SAFE(__elm, (head), field, __elm0)        \
  80                         (void)(freef)(__elm);                           \
  81 } while(0);
  82
  83 struct datadir {
  84         const char              *path;
  85         SLIST_ENTRY(datadir)    next;
  86 };
  87 static SLIST_HEAD(, datadir) datadirs = SLIST_HEAD_INITIALIZER(datadirs);
  88
  89 struct ucode_handler {
  90         ucode_probe_t *probe;
  91         ucode_update_t *update;
  92 } handlers[] = {
  93         { intel_probe, intel_update },
  94         { amd_probe, amd_update },
  95         { via_probe, via_update },
  96 };
  97 #define NHANDLERS (sizeof(handlers) / sizeof(*handlers))
  98
  99 static void     usage(void);
 100 static int      isdir(const char *path);
 101 static int      do_cpuid(const char *cmdarg, const char *dev);
 102 static int      do_msr(const char *cmdarg, const char *dev);
 103 static int      do_update(const char *dev);
 104 static void     datadir_add(const char *path);
 105
 106 static void __dead2
 107 usage()
 108 {
 109         const char *name;
 110
 111         name = getprogname();
 112         if (name == NULL)
 113                 name = "cpuctl";
 114         fprintf(stderr, "Usage: %s [-vh] [-d datadir] [-m msr[=value] | "
 115             "-i level | -u] device\n", name);
 116         exit(EX_USAGE);
 117 }
 118
 119 static int
 120 isdir(const char *path)
 121 {
 122         int error;
 123         struct stat st;
 124
 125         error = stat(path, &st);
 126         if (error < 0) {
 127                 WARN(0, "stat(%s)", path);
 128                 return (error);
 129         }
 130         return (st.st_mode & S_IFDIR);
 131 }
 132
 133 static int
 134 do_cpuid(const char *cmdarg, const char *dev)
 135 {
 136         unsigned int level;
 137         cpuctl_cpuid_args_t args;
 138         int fd, error;
 139         char *endptr;
 140
 141         assert(cmdarg != NULL);
 142         assert(dev != NULL);
 143
 144         level = strtoul(cmdarg, &endptr, 16);
 145         if (*cmdarg == '\0' || *endptr != '\0') {
 146                 WARNX(0, "incorrect operand: %s", cmdarg);
 147                 usage();
 148                 /* NOTREACHED */
 149         }
 150
 151         /*
 152          * Fill ioctl argument structure.
 153          */
 154         args.level = level;
 155         fd = open(dev, O_RDONLY);
 156         if (fd < 0) {
 157                 WARN(0, "error opening %s for reading", dev);
 158                 return (1);
 159         }
 160         error = ioctl(fd, CPUCTL_CPUID, &args);
 161         if (error < 0) {
 162                 WARN(0, "ioctl(%s, CPUCTL_CPUID)", dev);
 163                 close(fd);
 164                 return (error);
 165         }
 166         fprintf(stdout, "cpuid level 0x%x: 0x%.8x 0x%.8x 0x%.8x 0x%.8x\n",
 167             level, args.data[0], args.data[1], args.data[2], args.data[3]);
 168         close(fd);
 169         return (0);
 170 }
 171
 172 static int
 173 do_msr(const char *cmdarg, const char *dev)
 174 {
 175         unsigned int msr;
 176         cpuctl_msr_args_t args;
 177         size_t len;
 178         uint64_t data = 0;
 179         unsigned long command;
 180         int do_invert = 0, op;
 181         int fd, error;
 182         char *endptr;
 183         char *p;
 184
 185         assert(cmdarg != NULL);
 186         assert(dev != NULL);
 187         len = strlen(cmdarg);
 188         if (len == 0) {
 189                 WARNX(0, "MSR register expected");
 190                 usage();
 191                 /* NOTREACHED */
 192         }
 193
 194         /*
 195          * Parse command string.
 196          */
 197         msr = strtoul(cmdarg, &endptr, 16);
 198         switch (*endptr) {
 199         case '\0':
 200                 op = OP_READ;
 201                 break;
 202         case '=':
 203                 op = OP_WRITE;
 204                 break;
 205         case '&':
 206                 op = OP_AND;
 207                 endptr++;
 208                 break;
 209         case '|':
 210                 op = OP_OR;
 211                 endptr++;
 212                 break;
 213         default:
 214                 op = OP_INVAL;
 215         }
 216         if (op != OP_READ) {    /* Complex operation. */
 217                 if (*endptr != '=')
 218                         op = OP_INVAL;
 219                 else {
 220                         p = ++endptr;
 221                         if (*p == '~') {
 222                                 do_invert = 1;
 223                                 p++;
 224                         }
 225                         data = strtoull(p, &endptr, 16);
 226                         if (*p == '\0' || *endptr != '\0') {
 227                                 WARNX(0, "argument required: %s", cmdarg);
 228                                 usage();
 229                                 /* NOTREACHED */
 230                         }
 231                 }
 232         }
 233         if (op == OP_INVAL) {
 234                 WARNX(0, "invalid operator: %s", cmdarg);
 235                 usage();
 236                 /* NOTREACHED */
 237         }
 238
 239         /*
 240          * Fill ioctl argument structure.
 241          */
 242         args.msr = msr;
 243         if ((do_invert != 0) ^ (op == OP_AND))
 244                 args.data = ~data;
 245         else
 246                 args.data = data;
 247         switch (op) {
 248         case OP_READ:
 249                 command = CPUCTL_RDMSR;
 250                 break;
 251         case OP_WRITE:
 252                 command = CPUCTL_WRMSR;
 253                 break;
 254         case OP_OR:
 255                 command = CPUCTL_MSRSBIT;
 256                 break;
 257         case OP_AND:
 258                 command = CPUCTL_MSRCBIT;
 259                 break;
 260         default:
 261                 abort();
 262         }
 263         fd = open(dev, op == OP_READ ? O_RDONLY : O_WRONLY);
 264         if (fd < 0) {
 265                 WARN(0, "error opening %s for %s", dev,
 266                     op == OP_READ ? "reading" : "writing");
 267                 return (1);
 268         }
 269         error = ioctl(fd, command, &args);
 270         if (error < 0) {
 271                 WARN(0, "ioctl(%s, %lu)", dev, command);
 272                 close(fd);
 273                 return (1);
 274         }
 275         if (op == OP_READ)
 276                 fprintf(stdout, "MSR 0x%x: 0x%.8x 0x%.8x\n", msr,
 277                     HIGH(args.data), LOW(args.data));
 278         close(fd);
 279         return (0);
 280 }
 281
 282 static int
 283 do_update(const char *dev)
 284 {
 285         int fd;
 286         unsigned int i;
 287         int error;
 288         struct ucode_handler *handler;
 289         struct datadir *dir;
 290         DIR *dirfd;
 291         struct dirent *direntry;
 292         char buf[MAXPATHLEN];
 293
 294         fd = open(dev, O_RDONLY);
 295         if (fd < 0) {
 296                 WARN(0, "error opening %s for reading", dev);
 297                 return (1);
 298         }
 299
 300         /*
 301          * Find the appropriate handler for device.
 302          */
 303         for (i = 0; i < NHANDLERS; i++)
 304                 if (handlers[i].probe(fd) == 0)
 305                         break;
 306         if (i < NHANDLERS)
 307                 handler = &handlers[i];
 308         else {
 309                 WARNX(0, "cannot find the appropriate handler for device");
 310                 close(fd);
 311                 return (1);
 312         }
 313         close(fd);
 314
 315         /*
 316          * Process every image in specified data directories.
 317          */
 318         SLIST_FOREACH(dir, &datadirs, next) {
 319                 dirfd  = opendir(dir->path);
 320                 if (dirfd == NULL) {
 321                         WARNX(1, "skipping directory %s: not accessible", dir->path);
 322                         continue;
 323                 }
 324                 while ((direntry = readdir(dirfd)) != NULL) {
 325                         if (direntry->d_namlen == 0)
 326                                 continue;
 327                         error = snprintf(buf, sizeof(buf), "%s/%s", dir->path,
 328                             direntry->d_name);
 329                         if ((unsigned)error >= sizeof(buf))
 330                                 WARNX(0, "skipping %s, buffer too short",
 331                                     direntry->d_name);
 332                         if (isdir(buf) != 0) {
 333                                 WARNX(2, "skipping %s: is a directory", buf);
 334                                 continue;
 335                         }
 336                         handler->update(dev, buf);
 337                 }
 338                 error = closedir(dirfd);
 339                 if (error != 0)
 340                         WARN(0, "closedir(%s)", dir->path);
 341         }
 342         return (0);
 343 }
 344
 345 /*
 346  * Add new data directory to the search list.
 347  */
 348 static void
 349 datadir_add(const char *path)
 350 {
 351         struct datadir *newdir;
 352
 353         newdir = (struct datadir *)malloc(sizeof(*newdir));
 354         if (newdir == NULL)
 355                 err(EX_OSERR, "cannot allocate memory");
 356         newdir->path = path;
 357         SLIST_INSERT_HEAD(&datadirs, newdir, next);
 358 }
 359
 360 int
 361 main(int argc, char *argv[])
 362 {
 363         int c, flags;
 364         const char *cmdarg;
 365         const char *dev;
 366         int error;
 367
 368         flags = 0;
 369         error = 0;
 370         cmdarg = "";    /* To keep gcc3 happy. */
 371
 372         /*
 373          * Add all default data dirs to the list first.
 374          */
 375         datadir_add(DEFAULT_DATADIR);
 376         while ((c = getopt(argc, argv, "d:hi:m:uv")) != -1) {
 377                 switch (c) {
 378                 case 'd':
 379                         datadir_add(optarg);
 380                         break;
 381                 case 'i':
 382                         flags |= FLAG_I;
 383                         cmdarg = optarg;
 384                         break;
 385                 case 'm':
 386                         flags |= FLAG_M;
 387                         cmdarg = optarg;
 388                         break;
 389                 case 'u':
 390                         flags |= FLAG_U;
 391                         break;
 392                 case 'v':
 393                         verbosity_level++;
 394                         break;
 395                 case 'h':
 396                         /* FALLTHROUGH */
 397                 default:
 398                         usage();
 399                         /* NOTREACHED */
 400                 }
 401         }
 402         argc -= optind;
 403         argv += optind;
 404         if (argc < 1) {
 405                 usage();
 406                 /* NOTREACHED */
 407         }
 408         dev = argv[0];
 409         c = flags & (FLAG_I | FLAG_M | FLAG_U);
 410         switch (c) {
 411                 case FLAG_I:
 412                         error = do_cpuid(cmdarg, dev);
 413                         break;
 414                 case FLAG_M:
 415                         error = do_msr(cmdarg, dev);
 416                         break;
 417                 case FLAG_U:
 418                         error = do_update(dev);
 419                         break;
 420                 default:
 421                         usage();        /* Only one command can be selected. */
 422         }
 423         SLIST_FREE(&datadirs, next, free);
 424         return (error);
 425 }