You need to sign in or sign up before continuing.
virutil.c 45.2 KB
Newer Older
1
/*
2
 * virutil.c: common, generic utility functions
3
 *
4
 * Copyright (C) 2006-2014 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 * Copyright (C) 2006 Daniel P. Berrange
 * Copyright (C) 2006, 2007 Binary Karma
 * Copyright (C) 2006 Shuveb Hussain
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
20
 * License along with this library.  If not, see
O
Osier Yang 已提交
21
 * <http://www.gnu.org/licenses/>.
22 23
 */

24
#include <config.h>
25

26 27
#include <unistd.h>
#include <fcntl.h>
C
Cole Robinson 已提交
28
#include <poll.h>
29
#include <sys/stat.h>
30 31 32 33 34 35 36

#ifdef MAJOR_IN_MKDEV
# include <sys/mkdev.h>
#elif MAJOR_IN_SYSMACROS
# include <sys/sysmacros.h>
#endif

37
#include <sys/types.h>
E
Eric Blake 已提交
38
#include <termios.h>
39

40
#if WITH_DEVMAPPER
41 42
# include <libdevmapper.h>
#endif
43

44
#include <netdb.h>
45
#ifdef HAVE_GETPWUID_R
46 47
# include <pwd.h>
# include <grp.h>
48
#endif
49
#if WITH_CAPNG
50
# include <cap-ng.h>
51
# include <sys/prctl.h>
52
#endif
53

54
#ifdef WIN32
55 56 57
# ifdef HAVE_WINSOCK2_H
#  include <winsock2.h>
# endif
58 59 60 61
# include <windows.h>
# include <shlobj.h>
#endif

62 63 64 65
#ifdef HAVE_SYS_UN_H
# include <sys/un.h>
#endif

E
Eric Blake 已提交
66
#include "mgetgroups.h"
67
#include "virerror.h"
68
#include "virlog.h"
69
#include "virbuffer.h"
70
#include "viralloc.h"
E
Eric Blake 已提交
71
#include "verify.h"
72 73 74 75 76 77
#include "virfile.h"
#include "vircommand.h"
#include "nonblocking.h"
#include "virprocess.h"
#include "virstring.h"
#include "virutil.h"
78

79 80
verify(sizeof(gid_t) <= sizeof(unsigned int) &&
       sizeof(uid_t) <= sizeof(unsigned int));
81

82
#define VIR_FROM_THIS VIR_FROM_NONE
83

84 85
VIR_LOG_INIT("util.util");

86
#ifndef WIN32
87

88 89
int virSetInherit(int fd, bool inherit)
{
90 91
    int fflags;
    if ((fflags = fcntl(fd, F_GETFD)) < 0)
92
        return -1;
93 94 95 96 97
    if (inherit)
        fflags &= ~FD_CLOEXEC;
    else
        fflags |= FD_CLOEXEC;
    if ((fcntl(fd, F_SETFD, fflags)) < 0)
98
        return -1;
99 100 101
    return 0;
}

102
#else /* WIN32 */
103

J
Ján Tomko 已提交
104
int virSetInherit(int fd G_GNUC_UNUSED, bool inherit G_GNUC_UNUSED)
105
{
106 107 108 109 110
    /* FIXME: Currently creating child processes is not supported on
     * Win32, so there is no point in failing calls that are only relevant
     * when creating child processes. So just pretend that we changed the
     * inheritance property of the given fd as requested. */
    return 0;
111 112
}

113
#endif /* WIN32 */
114

115 116
int virSetBlocking(int fd, bool blocking)
{
117
    return set_nonblocking_flag(fd, !blocking);
118 119
}

120 121
int virSetNonBlock(int fd)
{
122
    return virSetBlocking(fd, false);
123
}
124

125
int virSetCloseExec(int fd)
126
{
127
    return virSetInherit(fd, false);
128 129
}

130
#ifdef WIN32
J
Ján Tomko 已提交
131
int virSetSockReuseAddr(int fd G_GNUC_UNUSED, bool fatal G_GNUC_UNUSED)
132 133 134 135 136 137 138 139 140 141 142 143 144 145
{
    /*
     * SO_REUSEADDR on Windows is actually akin to SO_REUSEPORT
     * on Linux/BSD. ie it allows 2 apps to listen to the same
     * port at once which is certainly not what we want here.
     *
     * Win32 sockets have Linux/BSD-like SO_REUSEADDR behaviour
     * by default, so we can be a no-op.
     *
     * http://msdn.microsoft.com/en-us/library/windows/desktop/ms740621.aspx
     */
    return 0;
}
#else
146
int virSetSockReuseAddr(int fd, bool fatal)
147 148
{
    int opt = 1;
149 150 151 152 153 154 155 156
    int ret = setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));

    if (ret < 0 && fatal) {
        virReportSystemError(errno, "%s",
                             _("Unable to set socket reuse addr flag"));
    }

    return ret;
157 158 159
}
#endif

160

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
/* Convert C from hexadecimal character to integer.  */
int
virHexToBin(unsigned char c)
{
    switch (c) {
    default: return c - '0';
    case 'a': case 'A': return 10;
    case 'b': case 'B': return 11;
    case 'c': case 'C': return 12;
    case 'd': case 'D': return 13;
    case 'e': case 'E': return 14;
    case 'f': case 'F': return 15;
    }
}

176 177 178 179 180 181 182 183 184 185 186 187 188 189
/* Scale an integer VALUE in-place by an optional case-insensitive
 * SUFFIX, defaulting to SCALE if suffix is NULL or empty (scale is
 * typically 1 or 1024).  Recognized suffixes include 'b' or 'bytes',
 * as well as power-of-two scaling via binary abbreviations ('KiB',
 * 'MiB', ...) or their one-letter counterpart ('k', 'M', ...), and
 * power-of-ten scaling via SI abbreviations ('KB', 'MB', ...).
 * Ensure that the result does not exceed LIMIT.  Return 0 on success,
 * -1 with error message raised on failure.  */
int
virScaleInteger(unsigned long long *value, const char *suffix,
                unsigned long long scale, unsigned long long limit)
{
    if (!suffix || !*suffix) {
        if (!scale) {
190 191
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("invalid scale %llu"), scale);
192 193 194 195 196 197 198 199 200 201 202
            return -1;
        }
        suffix = "";
    } else if (STRCASEEQ(suffix, "b") || STRCASEEQ(suffix, "byte") ||
               STRCASEEQ(suffix, "bytes")) {
        scale = 1;
    } else {
        int base;

        if (!suffix[1] || STRCASEEQ(suffix + 1, "iB")) {
            base = 1024;
203
        } else if (g_ascii_tolower(suffix[1]) == 'b' && !suffix[2]) {
204 205
            base = 1000;
        } else {
206
            virReportError(VIR_ERR_INVALID_ARG,
207
                           _("unknown suffix '%s'"), suffix);
208 209 210
            return -1;
        }
        scale = 1;
211
        switch (g_ascii_tolower(*suffix)) {
212 213
        case 'e':
            scale *= base;
214
            G_GNUC_FALLTHROUGH;
215 216
        case 'p':
            scale *= base;
217
            G_GNUC_FALLTHROUGH;
218 219
        case 't':
            scale *= base;
220
            G_GNUC_FALLTHROUGH;
221 222
        case 'g':
            scale *= base;
223
            G_GNUC_FALLTHROUGH;
224 225
        case 'm':
            scale *= base;
226
            G_GNUC_FALLTHROUGH;
227 228 229 230
        case 'k':
            scale *= base;
            break;
        default:
231 232
            virReportError(VIR_ERR_INVALID_ARG,
                           _("unknown suffix '%s'"), suffix);
233 234 235 236
            return -1;
        }
    }

G
Guannan Ren 已提交
237
    if (*value && *value > (limit / scale)) {
238 239
        virReportError(VIR_ERR_OVERFLOW, _("value too large: %llu%s"),
                       *value, suffix);
240 241 242 243 244 245
        return -1;
    }
    *value *= scale;
    return 0;
}

E
Eric Blake 已提交
246

247 248 249 250
/**
 * virParseVersionString:
 * @str: const char pointer to the version string
 * @version: unsigned long pointer to output the version number
251 252
 * @allowMissing: true to treat 3 like 3.0.0, false to error out on
 * missing minor or micro
253 254 255 256 257 258 259 260 261 262 263
 *
 * Parse an unsigned version number from a version string. Expecting
 * 'major.minor.micro' format, ignoring an optional suffix.
 *
 * The major, minor and micro numbers are encoded into a single version number:
 *
 *   1000000 * major + 1000 * minor + micro
 *
 * Returns the 0 for success, -1 for error.
 */
int
264 265
virParseVersionString(const char *str, unsigned long *version,
                      bool allowMissing)
266
{
267
    unsigned int major, minor = 0, micro = 0;
268 269
    char *tmp;

270
    if (virStrToLong_ui(str, &tmp, 10, &major) < 0)
271 272
        return -1;

273 274 275
    if (!allowMissing && *tmp != '.')
        return -1;

276
    if ((*tmp == '.') && virStrToLong_ui(tmp + 1, &tmp, 10, &minor) < 0)
277 278
        return -1;

279 280 281
    if (!allowMissing && *tmp != '.')
        return -1;

282
    if ((*tmp == '.') && virStrToLong_ui(tmp + 1, &tmp, 10, &micro) < 0)
283 284
        return -1;

285 286 287
    if (major > UINT_MAX / 1000000 || minor > 999 || micro > 999)
        return -1;

288 289 290 291 292
    *version = 1000000 * major + 1000 * minor + micro;

    return 0;
}

D
Daniel P. Berrange 已提交
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
/**
 * Format @val as a base-10 decimal number, in the
 * buffer @buf of size @buflen. To allocate a suitable
 * sized buffer, the INT_BUFLEN(int) macro should be
 * used
 *
 * Returns pointer to start of the number in @buf
 */
char *
virFormatIntDecimal(char *buf, size_t buflen, int val)
{
    char *p = buf + buflen - 1;
    *p = '\0';
    if (val >= 0) {
        do {
            *--p = '0' + (val % 10);
            val /= 10;
        } while (val != 0);
    } else {
        do {
            *--p = '0' - (val % 10);
            val /= 10;
        } while (val != 0);
        *--p = '-';
    }
    return p;
}


322 323 324 325 326 327 328 329
/**
 * virFormatIntPretty
 *
 * @val: Value in bytes to be shortened
 * @unit: unit to be used
 *
 * Similar to vshPrettyCapacity, but operates on integers and not doubles
 *
330 331 332 333
 * NB: Since using unsigned long long, we are limited to at most a "PiB"
 *     to make pretty. This is because a PiB is 1152921504606846976 bytes,
 *     but that value * 1024 > ULLONG_MAX value 18446744073709551615 bytes.
 *
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
 * Returns shortened value that can be used with @unit.
 */
unsigned long long
virFormatIntPretty(unsigned long long val,
                   const char **unit)
{
    unsigned long long limit = 1024;

    if (val % limit || val == 0) {
        *unit = "B";
        return val;
    }
    limit *= 1024;
    if (val % limit) {
        *unit = "KiB";
        return val / (limit / 1024);
    }
    limit *= 1024;
    if (val % limit) {
        *unit = "MiB";
        return val / (limit / 1024);
    }
    limit *= 1024;
    if (val % limit) {
        *unit = "GiB";
        return val / (limit / 1024);
    }
    limit *= 1024;
    if (val % limit) {
        *unit = "TiB";
        return val / (limit / 1024);
    }
    limit *= 1024;
367
    *unit = "PiB";
368 369 370 371
    return val / (limit / 1024);
}


372
/* Translates a device name of the form (regex) /^[fhv]d[a-z]+[0-9]*$/
373 374
 * into the corresponding index and partition number
 * (e.g. sda0 => (0,0), hdz2 => (25,2), vdaa12 => (26,12))
375
 * @param name The name of the device
376 377 378
 * @param disk The disk index to be returned
 * @param partition The partition index to be returned
 * @return 0 on success, or -1 on failure
379
 */
380
int virDiskNameParse(const char *name, int *disk, int *partition)
381
{
382
    const char *ptr = NULL;
383
    char *rem;
384
    int idx = 0;
385
    static char const* const drive_prefix[] = {"fd", "hd", "vd", "sd", "xvd", "ubd"};
386
    size_t i;
387

388
    for (i = 0; i < G_N_ELEMENTS(drive_prefix); i++) {
389 390
        if (STRPREFIX(name, drive_prefix[i])) {
            ptr = name + strlen(drive_prefix[i]);
391
            break;
392
        }
393 394
    }

395
    if (!ptr || !g_ascii_islower(*ptr))
396 397
        return -1;

D
Daniel Veillard 已提交
398
    for (i = 0; *ptr; i++) {
399
        if (!g_ascii_islower(*ptr))
400
            break;
401

402
        idx = (idx + (i < 1 ? 0 : 1)) * 26;
403 404 405 406
        idx += *ptr - 'a';
        ptr++;
    }

407 408 409 410 411
    /* Count the trailing digits.  */
    size_t n_digits = strspn(ptr, "0123456789");
    if (ptr[n_digits] != '\0')
        return -1;

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
    *disk = idx;

    /* Convert trailing digits into our partition index */
    if (partition) {
        *partition = 0;

        /* Shouldn't start by zero */
        if (n_digits > 1 && *ptr == '0')
            return -1;

        if (n_digits && virStrToLong_i(ptr, &rem, 10, partition) < 0)
            return -1;
    }

    return 0;
}

/* Translates a device name of the form (regex) /^[fhv]d[a-z]+[0-9]*$/
 * into the corresponding index (e.g. sda => 0, hdz => 25, vdaa => 26)
 * Note that any trailing string of digits is simply ignored.
 * @param name The name of the device
 * @return name's index, or -1 on failure
 */
int virDiskNameToIndex(const char *name)
{
    int idx;

439
    if (virDiskNameParse(name, &idx, NULL) < 0)
440 441
        idx = -1;

442 443
    return idx;
}
G
Guido Günther 已提交
444

445 446 447
char *virIndexToDiskName(int idx, const char *prefix)
{
    char *name = NULL;
448 449 450
    size_t i;
    int ctr;
    int offset;
451 452

    if (idx < 0) {
453 454
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Disk index %d is negative"), idx);
455 456 457
        return NULL;
    }

458
    for (i = 0, ctr = idx; ctr >= 0; ++i, ctr = ctr / 26 - 1) { }
459 460 461

    offset = strlen(prefix);

462
    if (VIR_ALLOC_N(name, offset + i + 1))
463 464 465 466 467
        return NULL;

    strcpy(name, prefix);
    name[offset + i] = '\0';

468
    for (i = i - 1, ctr = idx; ctr >= 0; --i, ctr = ctr / 26 - 1)
469
        name[offset + i] = 'a' + (ctr % 26);
470 471 472 473

    return name;
}

474
#ifndef AI_CANONIDN
475
# define AI_CANONIDN 0
476 477
#endif

478 479 480 481
#ifndef HOST_NAME_MAX
# define HOST_NAME_MAX 256
#endif

C
Chris Lalancette 已提交
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
/* Who knew getting a hostname could be so delicate.  In Linux (and Unices
 * in general), many things depend on "hostname" returning a value that will
 * resolve one way or another.  In the modern world where networks frequently
 * come and go this is often being hard-coded to resolve to "localhost".  If
 * it *doesn't* resolve to localhost, then we would prefer to have the FQDN.
 * That leads us to 3 possibilities:
 *
 * 1)  gethostname() returns an FQDN (not localhost) - we return the string
 *     as-is, it's all of the information we want
 * 2)  gethostname() returns "localhost" - we return localhost; doing further
 *     work to try to resolve it is pointless
 * 3)  gethostname() returns a shortened hostname - in this case, we want to
 *     try to resolve this to a fully-qualified name.  Therefore we pass it
 *     to getaddrinfo().  There are two possible responses:
 *     a)  getaddrinfo() resolves to a FQDN - return the FQDN
497
 *     b)  getaddrinfo() fails or resolves to localhost - in this case, the
498 499 500
 *         data we got from gethostname() is actually more useful than what
 *         we got from getaddrinfo().  Return the value from gethostname()
 *         and hope for the best.
C
Chris Lalancette 已提交
501
 */
502 503
static char *
virGetHostnameImpl(bool quiet)
504 505
{
    int r;
506
    char hostname[HOST_NAME_MAX+1], *result = NULL;
C
Chris Lalancette 已提交
507
    struct addrinfo hints, *info;
508

509
    r = gethostname(hostname, sizeof(hostname));
510
    if (r == -1) {
511 512 513
        if (!quiet)
            virReportSystemError(errno,
                                 "%s", _("failed to determine host name"));
514
        return NULL;
515
    }
516 517
    NUL_TERMINATE(hostname);

C
Chris Lalancette 已提交
518 519 520 521 522 523 524
    if (STRPREFIX(hostname, "localhost") || strchr(hostname, '.')) {
        /* in this case, gethostname returned localhost (meaning we can't
         * do any further canonicalization), or it returned an FQDN (and
         * we don't need to do any further canonicalization).  Return the
         * string as-is; it's up to callers to check whether "localhost"
         * is allowed.
         */
525
        result = g_strdup(hostname);
526
        goto cleanup;
C
Chris Lalancette 已提交
527 528 529 530 531 532
    }

    /* otherwise, it's a shortened, non-localhost, hostname.  Attempt to
     * canonicalize the hostname by running it through getaddrinfo
     */

533 534 535 536
    memset(&hints, 0, sizeof(hints));
    hints.ai_flags = AI_CANONNAME|AI_CANONIDN;
    hints.ai_family = AF_UNSPEC;
    r = getaddrinfo(hostname, NULL, &hints, &info);
537
    if (r != 0) {
538 539 540
        if (!quiet)
            VIR_WARN("getaddrinfo failed for '%s': %s",
                     hostname, gai_strerror(r));
541
        result = g_strdup(hostname);
542
        goto cleanup;
543
    }
544

545
    /* Tell static analyzers about getaddrinfo semantics.  */
546
    sa_assert(info);
547

C
Chris Lalancette 已提交
548 549 550 551 552 553
    if (info->ai_canonname == NULL ||
        STRPREFIX(info->ai_canonname, "localhost"))
        /* in this case, we tried to canonicalize and we ended up back with
         * localhost.  Ignore the canonicalized name and just return the
         * original hostname
         */
554
        result = g_strdup(hostname);
C
Chris Lalancette 已提交
555 556
    else
        /* Caller frees this string. */
557
        result = g_strdup(info->ai_canonname);
558

C
Chris Lalancette 已提交
559
    freeaddrinfo(info);
560

561
 cleanup:
562 563
    if (!result)
        virReportOOMError();
564 565 566
    return result;
}

D
Dan Walsh 已提交
567

568 569 570 571 572 573 574 575 576 577 578 579 580 581
char *
virGetHostname(void)
{
    return virGetHostnameImpl(false);
}


char *
virGetHostnameQuiet(void)
{
    return virGetHostnameImpl(true);
}


D
Dan Walsh 已提交
582 583 584
char *
virGetUserDirectory(void)
{
585
    return g_strdup(g_get_home_dir());
D
Dan Walsh 已提交
586 587 588
}


589 590 591 592 593 594 595 596 597 598
char *virGetUserConfigDirectory(void)
{
#ifdef WIN32
    return g_strdup(g_get_user_config_dir());
#else
    return g_build_filename(g_get_user_config_dir(), "libvirt", NULL);
#endif
}


599 600 601 602 603 604 605 606 607 608
char *virGetUserCacheDirectory(void)
{
#ifdef WIN32
    return g_strdup(g_get_user_cache_dir());
#else
    return g_build_filename(g_get_user_cache_dir(), "libvirt", NULL);
#endif
}


609
#ifdef HAVE_GETPWUID_R
E
Eric Blake 已提交
610
/* Look up fields from the user database for the given user.  On
611 612
 * error, set errno, report the error if not instructed otherwise via @quiet,
 * and return -1.  */
E
Eric Blake 已提交
613
static int
614
virGetUserEnt(uid_t uid, char **name, gid_t *group, char **dir, char **shell, bool quiet)
615 616 617
{
    char *strbuf;
    struct passwd pwbuf;
618
    struct passwd *pw = NULL;
619 620
    long val = sysconf(_SC_GETPW_R_SIZE_MAX);
    size_t strbuflen = val;
621
    int rc;
E
Eric Blake 已提交
622 623 624 625 626 627
    int ret = -1;

    if (name)
        *name = NULL;
    if (dir)
        *dir = NULL;
628 629
    if (shell)
        *shell = NULL;
630

631 632 633
    /* sysconf is a hint; if it fails, fall back to a reasonable size */
    if (val < 0)
        strbuflen = 1024;
634

635
    if (VIR_ALLOC_N(strbuf, strbuflen) < 0)
E
Eric Blake 已提交
636
        return -1;
637

638 639 640 641 642 643 644
    /*
     * From the manpage (terrifying but true):
     *
     * ERRORS
     *  0 or ENOENT or ESRCH or EBADF or EPERM or ...
     *        The given name or uid was not found.
     */
645
    while ((rc = getpwuid_r(uid, &pwbuf, strbuf, strbuflen, &pw)) == ERANGE) {
646
        if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0)
E
Eric Blake 已提交
647
            goto cleanup;
648
    }
649

650
    if (rc != 0) {
651 652 653
        if (quiet)
            goto cleanup;

654
        virReportSystemError(rc,
E
Eric Blake 已提交
655 656
                             _("Failed to find user record for uid '%u'"),
                             (unsigned int) uid);
E
Eric Blake 已提交
657
        goto cleanup;
658
    } else if (pw == NULL) {
659 660 661
        if (quiet)
            goto cleanup;

662 663 664 665
        virReportError(VIR_ERR_SYSTEM_ERROR,
                       _("Failed to find user record for uid '%u'"),
                       (unsigned int) uid);
        goto cleanup;
E
Eric Blake 已提交
666 667
    }

668 669
    if (name)
        *name = g_strdup(pw->pw_name);
E
Eric Blake 已提交
670 671
    if (group)
        *group = pw->pw_gid;
672 673 674 675
    if (dir)
        *dir = g_strdup(pw->pw_dir);
    if (shell)
        *shell = g_strdup(pw->pw_shell);
676

E
Eric Blake 已提交
677
    ret = 0;
678
 cleanup:
679 680 681 682 683 684 685 686
    if (ret < 0) {
        if (name)
            VIR_FREE(*name);
        if (dir)
            VIR_FREE(*dir);
        if (shell)
            VIR_FREE(*shell);
    }
687 688 689
    VIR_FREE(strbuf);
    return ret;
}
690

691 692 693 694 695 696 697 698 699 700 701 702 703 704
static char *virGetGroupEnt(gid_t gid)
{
    char *strbuf;
    char *ret;
    struct group grbuf;
    struct group *gr = NULL;
    long val = sysconf(_SC_GETGR_R_SIZE_MAX);
    size_t strbuflen = val;
    int rc;

    /* sysconf is a hint; if it fails, fall back to a reasonable size */
    if (val < 0)
        strbuflen = 1024;

705
    if (VIR_ALLOC_N(strbuf, strbuflen) < 0)
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
        return NULL;

    /*
     * From the manpage (terrifying but true):
     *
     * ERRORS
     *  0 or ENOENT or ESRCH or EBADF or EPERM or ...
     *        The given name or gid was not found.
     */
    while ((rc = getgrgid_r(gid, &grbuf, strbuf, strbuflen, &gr)) == ERANGE) {
        if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0) {
            VIR_FREE(strbuf);
            return NULL;
        }
    }
    if (rc != 0 || gr == NULL) {
722 723 724 725 726 727 728 729 730 731
        if (rc != 0) {
            virReportSystemError(rc,
                                 _("Failed to find group record for gid '%u'"),
                                 (unsigned int) gid);
        } else {
            virReportError(VIR_ERR_SYSTEM_ERROR,
                           _("Failed to find group record for gid '%u'"),
                           (unsigned int) gid);
        }

732 733 734 735
        VIR_FREE(strbuf);
        return NULL;
    }

736
    ret = g_strdup(gr->gr_name);
737 738 739 740
    VIR_FREE(strbuf);
    return ret;
}

D
Dan Walsh 已提交
741 742 743

char *
virGetUserDirectoryByUID(uid_t uid)
744
{
E
Eric Blake 已提交
745
    char *ret;
746
    virGetUserEnt(uid, NULL, NULL, &ret, NULL, false);
747 748 749 750 751 752 753
    return ret;
}


char *virGetUserShell(uid_t uid)
{
    char *ret;
754
    virGetUserEnt(uid, NULL, NULL, NULL, &ret, false);
E
Eric Blake 已提交
755
    return ret;
756 757
}

D
Dan Walsh 已提交
758

759
char *virGetUserRuntimeDirectory(void)
760
{
761
    const char *path = getenv("XDG_RUNTIME_DIR");
762 763

    if (!path || !path[0]) {
764
        return virGetUserCacheDirectory();
765 766 767
    } else {
        char *ret;

768
        ret = g_strdup_printf("%s/libvirt", path);
769 770 771 772
        return ret;
    }
}

773
char *virGetUserName(uid_t uid)
774
{
E
Eric Blake 已提交
775
    char *ret;
776
    virGetUserEnt(uid, &ret, NULL, NULL, NULL, false);
E
Eric Blake 已提交
777
    return ret;
778 779
}

780 781 782 783 784
char *virGetGroupName(gid_t gid)
{
    return virGetGroupEnt(gid);
}

785 786
/* Search in the password database for a user id that matches the user name
 * `name`. Returns 0 on success, -1 on failure or 1 if name cannot be found.
787 788
 *
 * Warns if @missing_ok is false
789 790
 */
static int
791
virGetUserIDByName(const char *name, uid_t *uid, bool missing_ok)
792
{
793
    char *strbuf = NULL;
794 795
    struct passwd pwbuf;
    struct passwd *pw = NULL;
796 797
    long val = sysconf(_SC_GETPW_R_SIZE_MAX);
    size_t strbuflen = val;
798
    int rc;
799
    int ret = -1;
800

801 802 803
    /* sysconf is a hint; if it fails, fall back to a reasonable size */
    if (val < 0)
        strbuflen = 1024;
804

805
    if (VIR_ALLOC_N(strbuf, strbuflen) < 0)
806
        goto cleanup;
807

808
    while ((rc = getpwnam_r(name, &pwbuf, strbuf, strbuflen, &pw)) == ERANGE) {
809
        if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0)
810
            goto cleanup;
811
    }
812 813

    if (!pw) {
814
        if (rc != 0 && !missing_ok) {
815 816 817 818
            char buf[1024];
            /* log the possible error from getpwnam_r. Unfortunately error
             * reporting from this function is bad and we can't really
             * rely on it, so we just report that the user wasn't found */
819
            VIR_WARN("User record for user '%s' was not found: %s",
820 821 822
                     name, virStrerror(rc, buf, sizeof(buf)));
        }

823 824
        ret = 1;
        goto cleanup;
825 826
    }

827 828
    if (uid)
        *uid = pw->pw_uid;
829
    ret = 0;
830

831
 cleanup:
832 833
    VIR_FREE(strbuf);

834
    return ret;
835 836
}

837 838 839 840 841 842 843 844 845 846 847 848 849 850
/* Try to match a user id based on `user`. The default behavior is to parse
 * `user` first as a user name and then as a user id. However if `user`
 * contains a leading '+', the rest of the string is always parsed as a uid.
 *
 * Returns 0 on success and -1 otherwise.
 */
int
virGetUserID(const char *user, uid_t *uid)
{
    unsigned int uint_uid;

    if (*user == '+') {
        user++;
    } else {
851
        int rc = virGetUserIDByName(user, uid, false);
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
        if (rc <= 0)
            return rc;
    }

    if (virStrToLong_ui(user, NULL, 10, &uint_uid) < 0 ||
        ((uid_t) uint_uid) != uint_uid) {
        virReportError(VIR_ERR_INVALID_ARG, _("Failed to parse user '%s'"),
                       user);
        return -1;
    }

    *uid = uint_uid;

    return 0;
}
867

868 869
/* Search in the group database for a group id that matches the group name
 * `name`. Returns 0 on success, -1 on failure or 1 if name cannot be found.
870 871
 *
 * Warns if @missing_ok is false
872 873
 */
static int
874
virGetGroupIDByName(const char *name, gid_t *gid, bool missing_ok)
875
{
876
    char *strbuf = NULL;
877 878
    struct group grbuf;
    struct group *gr = NULL;
879 880
    long val = sysconf(_SC_GETGR_R_SIZE_MAX);
    size_t strbuflen = val;
881
    int rc;
882
    int ret = -1;
883

884 885 886
    /* sysconf is a hint; if it fails, fall back to a reasonable size */
    if (val < 0)
        strbuflen = 1024;
887

888
    if (VIR_ALLOC_N(strbuf, strbuflen) < 0)
889
        goto cleanup;
890

891
    while ((rc = getgrnam_r(name, &grbuf, strbuf, strbuflen, &gr)) == ERANGE) {
892
        if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0)
893
            goto cleanup;
894
    }
895 896

    if (!gr) {
897
        if (rc != 0 && !missing_ok) {
898 899 900 901
            char buf[1024];
            /* log the possible error from getgrnam_r. Unfortunately error
             * reporting from this function is bad and we can't really
             * rely on it, so we just report that the user wasn't found */
902
            VIR_WARN("Group record for user '%s' was not found: %s",
903 904 905
                     name, virStrerror(rc, buf, sizeof(buf)));
        }

906 907
        ret = 1;
        goto cleanup;
908 909
    }

910 911
    if (gid)
        *gid = gr->gr_gid;
912
    ret = 0;
913

914
 cleanup:
915 916
    VIR_FREE(strbuf);

917
    return ret;
918
}
919

920 921 922 923 924 925 926 927 928 929 930 931 932 933
/* Try to match a group id based on `group`. The default behavior is to parse
 * `group` first as a group name and then as a group id. However if `group`
 * contains a leading '+', the rest of the string is always parsed as a guid.
 *
 * Returns 0 on success and -1 otherwise.
 */
int
virGetGroupID(const char *group, gid_t *gid)
{
    unsigned int uint_gid;

    if (*group == '+') {
        group++;
    } else {
934
        int rc = virGetGroupIDByName(group, gid, false);
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
        if (rc <= 0)
            return rc;
    }

    if (virStrToLong_ui(group, NULL, 10, &uint_gid) < 0 ||
        ((gid_t) uint_gid) != uint_gid) {
        virReportError(VIR_ERR_INVALID_ARG, _("Failed to parse group '%s'"),
                       group);
        return -1;
    }

    *gid = uint_gid;

    return 0;
}
L
Laine Stump 已提交
950

951 952 953
/* Silently checks if User @name exists.
 * Returns if the user exists and fallbacks to false on error.
 */
954
bool
955 956 957 958 959 960 961 962
virDoesUserExist(const char *name)
{
    return virGetUserIDByName(name, NULL, true) == 0;
}

/* Silently checks if Group @name exists.
 * Returns if the group exists and fallbacks to false on error.
 */
963
bool
964 965 966 967 968
virDoesGroupExist(const char *name)
{
    return virGetGroupIDByName(name, NULL, true) == 0;
}

E
Eric Blake 已提交
969

970 971
/* Compute the list of primary and supplementary groups associated
 * with @uid, and including @gid in the list (unless it is -1),
972 973 974 975 976 977
 * storing a malloc'd result into @list. If uid is -1 or doesn't exist in the
 * system database querying of the supplementary groups is skipped.
 *
 * Returns the size of the list on success, or -1 on failure with error
 * reported and errno set. May not be called between fork and exec.
 * */
E
Eric Blake 已提交
978 979 980
int
virGetGroupList(uid_t uid, gid_t gid, gid_t **list)
{
981
    int ret = 0;
E
Eric Blake 已提交
982
    char *user = NULL;
983
    gid_t primary;
E
Eric Blake 已提交
984 985 986

    *list = NULL;

987 988 989 990 991 992 993 994 995
    /* invalid users have no supplementary groups */
    if (uid != (uid_t)-1 &&
        virGetUserEnt(uid, &user, &primary, NULL, NULL, true) >= 0) {
        if ((ret = mgetgroups(user, primary, list)) < 0) {
            virReportSystemError(errno,
                                 _("cannot get group list for '%s'"), user);
            ret = -1;
            goto cleanup;
        }
996 997 998
    }

    if (gid != (gid_t)-1) {
E
Eric Blake 已提交
999
        size_t i;
1000

E
Eric Blake 已提交
1001
        for (i = 0; i < ret; i++) {
1002 1003 1004
            if ((*list)[i] == gid)
                goto cleanup;
        }
E
Eric Blake 已提交
1005
        if (VIR_APPEND_ELEMENT(*list, i, gid) < 0) {
1006 1007 1008 1009
            ret = -1;
            VIR_FREE(*list);
            goto cleanup;
        } else {
E
Eric Blake 已提交
1010
            ret = i;
1011 1012 1013
        }
    }

1014
 cleanup:
E
Eric Blake 已提交
1015 1016 1017 1018 1019
    VIR_FREE(user);
    return ret;
}


1020 1021 1022 1023
/* Set the real and effective uid and gid to the given values, as well
 * as all the supplementary groups, so that the process has all the
 * assumed group membership of that uid. Return 0 on success, -1 on
 * failure (the original system error remains in errno).
L
Laine Stump 已提交
1024 1025
 */
int
J
Ján Tomko 已提交
1026 1027
virSetUIDGID(uid_t uid, gid_t gid, gid_t *groups G_GNUC_UNUSED,
             int ngroups G_GNUC_UNUSED)
L
Laine Stump 已提交
1028
{
1029 1030 1031 1032 1033
    if (gid != (gid_t)-1 && setregid(gid, gid) < 0) {
        virReportSystemError(errno,
                             _("cannot change to '%u' group"),
                             (unsigned int) gid);
        return -1;
L
Laine Stump 已提交
1034 1035
    }

1036
# if HAVE_SETGROUPS
1037
    if (gid != (gid_t)-1 && setgroups(ngroups, groups) < 0) {
1038 1039 1040 1041
        virReportSystemError(errno, "%s",
                             _("cannot set supplemental groups"));
        return -1;
    }
L
Laine Stump 已提交
1042
# endif
1043 1044 1045 1046 1047 1048

    if (uid != (uid_t)-1 && setreuid(uid, uid) < 0) {
        virReportSystemError(errno,
                             _("cannot change to uid to '%u'"),
                             (unsigned int) uid);
        return -1;
L
Laine Stump 已提交
1049
    }
1050

L
Laine Stump 已提交
1051 1052 1053
    return 0;
}

1054 1055
#else /* ! HAVE_GETPWUID_R */

E
Eric Blake 已提交
1056
int
J
Ján Tomko 已提交
1057
virGetGroupList(uid_t uid G_GNUC_UNUSED, gid_t gid G_GNUC_UNUSED,
E
Eric Blake 已提交
1058 1059 1060 1061 1062 1063
                gid_t **list)
{
    *list = NULL;
    return 0;
}

1064
bool
J
Ján Tomko 已提交
1065
virDoesUserExist(const char *name G_GNUC_UNUSED)
1066
{
1067
    return false;
1068 1069
}

1070
bool
J
Ján Tomko 已提交
1071
virDoesGroupExist(const char *name G_GNUC_UNUSED)
1072
{
1073
    return false;
1074 1075
}

1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
# ifdef WIN32
/* These methods are adapted from GLib2 under terms of LGPLv2+ */
static int
virGetWin32SpecialFolder(int csidl, char **path)
{
    char buf[MAX_PATH+1];
    LPITEMIDLIST pidl = NULL;
    int ret = 0;

    *path = NULL;

    if (SHGetSpecialFolderLocation(NULL, csidl, &pidl) == S_OK) {
1088 1089
        if (SHGetPathFromIDList(pidl, buf))
            *path = g_strdup(buf);
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
        CoTaskMemFree(pidl);
    }
    return ret;
}

static int
virGetWin32DirectoryRoot(char **path)
{
    char windowsdir[MAX_PATH];

    *path = NULL;

1102
    if (GetWindowsDirectory(windowsdir, G_N_ELEMENTS(windowsdir))) {
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
        const char *tmp;
        /* Usually X:\Windows, but in terminal server environments
         * might be an UNC path, AFAIK.
         */
        tmp = virFileSkipRoot(windowsdir);
        if (VIR_FILE_IS_DIR_SEPARATOR(tmp[-1]) &&
            tmp[-2] != ':')
            tmp--;

        windowsdir[tmp - windowsdir] = '\0';
    } else {
        strcpy(windowsdir, "C:\\");
    }

1117 1118
    *path = g_strdup(windowsdir);
    return 0;
1119 1120 1121 1122 1123
}



char *
J
Ján Tomko 已提交
1124
virGetUserDirectoryByUID(uid_t uid G_GNUC_UNUSED)
1125
{
D
Dan Walsh 已提交
1126 1127 1128
    /* Since Windows lacks setuid binaries, and since we already fake
     * geteuid(), we can safely assume that this is only called when
     * querying about the current user */
1129 1130 1131
    const char *dir;
    char *ret;

1132
    dir = getenv("HOME");
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145

    /* Only believe HOME if it is an absolute path and exists */
    if (dir) {
        if (!virFileIsAbsPath(dir) ||
            !virFileExists(dir))
            dir = NULL;
    }

    /* In case HOME is Unix-style (it happens), convert it to
     * Windows style.
     */
    if (dir) {
        char *p;
1146
        while ((p = strchr(dir, '/')) != NULL)
1147 1148 1149 1150 1151
            *p = '\\';
    }

    if (!dir)
        /* USERPROFILE is probably the closest equivalent to $HOME? */
1152
        dir = getenv("USERPROFILE");
1153

1154
    ret = g_strdup(dir);
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164

    if (!ret &&
        virGetWin32SpecialFolder(CSIDL_PROFILE, &ret) < 0)
        return NULL;

    if (!ret &&
        virGetWin32DirectoryRoot(&ret) < 0)
        return NULL;

    if (!ret) {
1165 1166
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("Unable to determine home directory"));
1167 1168 1169 1170 1171 1172
        return NULL;
    }

    return ret;
}

1173
char *
J
Ján Tomko 已提交
1174
virGetUserShell(uid_t uid G_GNUC_UNUSED)
1175 1176 1177 1178 1179 1180 1181
{
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserShell is not available"));

    return NULL;
}

1182 1183 1184 1185 1186
char *
virGetUserRuntimeDirectory(void)
{
    return virGetUserCacheDirectory();
}
E
Eric Blake 已提交
1187

1188
# else /* !HAVE_GETPWUID_R && !WIN32 */
1189
char *
J
Ján Tomko 已提交
1190
virGetUserDirectoryByUID(uid_t uid G_GNUC_UNUSED)
1191
{
1192 1193
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserDirectory is not available"));
1194 1195 1196 1197

    return NULL;
}

1198
char *
J
Ján Tomko 已提交
1199
virGetUserShell(uid_t uid G_GNUC_UNUSED)
1200 1201 1202 1203 1204 1205 1206
{
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserShell is not available"));

    return NULL;
}

1207 1208 1209
char *
virGetUserRuntimeDirectory(void)
{
1210 1211
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserRuntimeDirectory is not available"));
1212 1213 1214 1215 1216

    return NULL;
}
# endif /* ! HAVE_GETPWUID_R && ! WIN32 */

1217
char *
J
Ján Tomko 已提交
1218
virGetUserName(uid_t uid G_GNUC_UNUSED)
1219
{
1220 1221
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserName is not available"));
1222 1223 1224 1225

    return NULL;
}

J
Ján Tomko 已提交
1226 1227
int virGetUserID(const char *name G_GNUC_UNUSED,
                 uid_t *uid G_GNUC_UNUSED)
1228
{
1229 1230
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserID is not available"));
1231

1232
    return -1;
1233 1234 1235
}


J
Ján Tomko 已提交
1236 1237
int virGetGroupID(const char *name G_GNUC_UNUSED,
                  gid_t *gid G_GNUC_UNUSED)
1238
{
1239 1240
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetGroupID is not available"));
1241

1242
    return -1;
1243
}
L
Laine Stump 已提交
1244 1245

int
J
Ján Tomko 已提交
1246 1247 1248 1249
virSetUIDGID(uid_t uid G_GNUC_UNUSED,
             gid_t gid G_GNUC_UNUSED,
             gid_t *groups G_GNUC_UNUSED,
             int ngroups G_GNUC_UNUSED)
L
Laine Stump 已提交
1250
{
1251 1252
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virSetUIDGID is not available"));
L
Laine Stump 已提交
1253 1254
    return -1;
}
1255 1256

char *
J
Ján Tomko 已提交
1257
virGetGroupName(gid_t gid G_GNUC_UNUSED)
1258
{
1259 1260
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetGroupName is not available"));
1261 1262 1263

    return NULL;
}
1264
#endif /* HAVE_GETPWUID_R */
1265

1266 1267 1268 1269 1270 1271 1272
#if WITH_CAPNG
/* Set the real and effective uid and gid to the given values, while
 * maintaining the capabilities indicated by bits in @capBits. Return
 * 0 on success, -1 on failure (the original system error remains in
 * errno).
 */
int
1273 1274
virSetUIDGIDWithCaps(uid_t uid, gid_t gid, gid_t *groups, int ngroups,
                     unsigned long long capBits, bool clearExistingCaps)
1275
{
1276
    size_t i;
1277
    int capng_ret;
1278 1279
    bool need_setgid = false;
    bool need_setuid = false;
1280
    bool need_setpcap = false;
1281
    const char *capstr = NULL;
1282

1283 1284 1285 1286
    /* First drop all caps (unless the requested uid is "unchanged" or
     * root and clearExistingCaps wasn't requested), then add back
     * those in capBits + the extra ones we need to change uid/gid and
     * change the capabilities bounding set.
1287 1288
     */

1289
    if (clearExistingCaps || (uid != (uid_t)-1 && uid != 0))
1290
        capng_clear(CAPNG_SELECT_BOTH);
1291

1292
    for (i = 0; i <= CAP_LAST_CAP; i++) {
1293 1294
        capstr = capng_capability_to_name(i);

1295
        if (capBits & (1ULL << i)) {
1296 1297 1298
            capng_update(CAPNG_ADD,
                         CAPNG_EFFECTIVE|CAPNG_INHERITABLE|
                         CAPNG_PERMITTED|CAPNG_BOUNDING_SET,
1299
                         i);
1300 1301

            VIR_DEBUG("Added '%s' to child capabilities' set", capstr);
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
        }
    }

    if (gid != (gid_t)-1 &&
        !capng_have_capability(CAPNG_EFFECTIVE, CAP_SETGID)) {
        need_setgid = true;
        capng_update(CAPNG_ADD, CAPNG_EFFECTIVE|CAPNG_PERMITTED, CAP_SETGID);
    }
    if (uid != (uid_t)-1 &&
        !capng_have_capability(CAPNG_EFFECTIVE, CAP_SETUID)) {
        need_setuid = true;
        capng_update(CAPNG_ADD, CAPNG_EFFECTIVE|CAPNG_PERMITTED, CAP_SETUID);
    }
# ifdef PR_CAPBSET_DROP
    /* If newer kernel, we need also need setpcap to change the bounding set */
    if ((capBits || need_setgid || need_setuid) &&
        !capng_have_capability(CAPNG_EFFECTIVE, CAP_SETPCAP)) {
        need_setpcap = true;
    }
    if (need_setpcap)
        capng_update(CAPNG_ADD, CAPNG_EFFECTIVE|CAPNG_PERMITTED, CAP_SETPCAP);
# endif

    /* Tell system we want to keep caps across uid change */
1326
    if (prctl(PR_SET_KEEPCAPS, 1, 0, 0, 0)) {
1327 1328
        virReportSystemError(errno, "%s",
                             _("prctl failed to set KEEPCAPS"));
1329
        return -1;
1330 1331 1332
    }

    /* Change to the temp capabilities */
1333
    if ((capng_ret = capng_apply(CAPNG_SELECT_CAPS)) < 0) {
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
        /* Failed.  If we are running unprivileged, and the arguments make sense
         * for this scenario, assume we're starting some kind of setuid helper:
         * do not set any of capBits in the permitted or effective sets, and let
         * the program get them on its own.
         *
         * (Too bad we cannot restrict the bounding set to the capabilities we
         * would like the helper to have!).
         */
        if (getuid() > 0 && clearExistingCaps && !need_setuid && !need_setgid) {
            capng_clear(CAPNG_SELECT_CAPS);
        } else {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("cannot apply process capabilities %d"), capng_ret);
1347
            return -1;
1348
        }
1349 1350
    }

1351
    if (virSetUIDGID(uid, gid, groups, ngroups) < 0)
1352
        return -1;
1353 1354

    /* Tell it we are done keeping capabilities */
1355
    if (prctl(PR_SET_KEEPCAPS, 0, 0, 0, 0)) {
1356 1357
        virReportSystemError(errno, "%s",
                             _("prctl failed to reset KEEPCAPS"));
1358
        return -1;
1359 1360
    }

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
# ifdef PR_CAP_AMBIENT
    /* we couldn't do this in the loop earlier above, because the capabilities
     * were not applied yet, since in order to add a capability into the AMBIENT
     * set, it has to be present in both the PERMITTED and INHERITABLE sets
     * (capabilities(7))
     */
    for (i = 0; i <= CAP_LAST_CAP; i++) {
        capstr = capng_capability_to_name(i);

        if (capBits & (1ULL << i)) {
            if (prctl(PR_CAP_AMBIENT, PR_CAP_AMBIENT_RAISE, i, 0, 0) < 0) {
                virReportSystemError(errno,
                                     _("prctl failed to enable '%s' in the "
                                       "AMBIENT set"),
                                     capstr);
1376
                return -1;
1377 1378 1379 1380 1381
            }
        }
    }
# endif

1382 1383 1384 1385 1386 1387
    /* Set bounding set while we have CAP_SETPCAP.  Unfortunately we cannot
     * do this if we failed to get the capability above, so ignore the
     * return value.
     */
    capng_apply(CAPNG_SELECT_BOUNDS);

1388 1389 1390 1391 1392 1393 1394 1395 1396
    /* Drop the caps that allow setuid/gid (unless they were requested) */
    if (need_setgid)
        capng_update(CAPNG_DROP, CAPNG_EFFECTIVE|CAPNG_PERMITTED, CAP_SETGID);
    if (need_setuid)
        capng_update(CAPNG_DROP, CAPNG_EFFECTIVE|CAPNG_PERMITTED, CAP_SETUID);
    /* Throw away CAP_SETPCAP so no more changes */
    if (need_setpcap)
        capng_update(CAPNG_DROP, CAPNG_EFFECTIVE|CAPNG_PERMITTED, CAP_SETPCAP);

1397
    if (((capng_ret = capng_apply(CAPNG_SELECT_CAPS)) < 0)) {
1398 1399
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("cannot apply process capabilities %d"), capng_ret);
1400
        return -1;
1401 1402
    }

1403
    return 0;
1404 1405 1406 1407 1408 1409 1410 1411 1412
}

#else
/*
 * On platforms without libcapng, the capabilities setting is treated
 * as a NOP.
 */

int
1413
virSetUIDGIDWithCaps(uid_t uid, gid_t gid, gid_t *groups, int ngroups,
J
Ján Tomko 已提交
1414 1415
                     unsigned long long capBits G_GNUC_UNUSED,
                     bool clearExistingCaps G_GNUC_UNUSED)
1416
{
1417
    return virSetUIDGID(uid, gid, groups, ngroups);
1418 1419 1420
}
#endif

1421

J
John Ferlan 已提交
1422
void virWaitForDevices(void)
D
Daniel P. Berrange 已提交
1423
{
J
Ján Tomko 已提交
1424
    g_autoptr(virCommand) cmd = NULL;
1425
    g_autofree char *udev = NULL;
D
Daniel P. Berrange 已提交
1426 1427
    int exitstatus;

1428 1429 1430 1431
    if (!(udev = virFindFileInPath(UDEVADM)))
        return;

    if (!(cmd = virCommandNewArgList(udev, "settle", NULL)))
D
Daniel P. Berrange 已提交
1432 1433 1434 1435 1436 1437
        return;

    /*
     * NOTE: we ignore errors here; this is just to make sure that any device
     * nodes that are being created finish before we try to scan them.
     */
1438
    ignore_value(virCommandRun(cmd, &exitstatus));
D
Daniel P. Berrange 已提交
1439
}
1440

1441
#if WITH_DEVMAPPER
1442
bool
1443
virIsDevMapperDevice(const char *dev_name)
1444 1445 1446
{
    struct stat buf;

1447
    if (!stat(dev_name, &buf) &&
1448 1449 1450 1451 1452 1453
        S_ISBLK(buf.st_mode) &&
        dm_is_dm_major(major(buf.st_rdev)))
            return true;

    return false;
}
1454
#else
J
Ján Tomko 已提交
1455
bool virIsDevMapperDevice(const char *dev_name G_GNUC_UNUSED)
1456 1457 1458 1459
{
    return false;
}
#endif
O
Osier Yang 已提交
1460 1461

bool
1462 1463
virValidateWWN(const char *wwn)
{
1464
    size_t i;
1465
    const char *p = wwn;
O
Osier Yang 已提交
1466

1467
    if (STRPREFIX(wwn, "0x"))
1468 1469 1470
        p += 2;

    for (i = 0; p[i]; i++) {
1471
        if (!g_ascii_isxdigit(p[i]))
O
Osier Yang 已提交
1472
            break;
1473
    }
O
Osier Yang 已提交
1474

1475
    if (i != 16 || p[i]) {
1476 1477
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Malformed wwn: %s"), wwn);
O
Osier Yang 已提交
1478 1479 1480 1481 1482
        return false;
    }

    return true;
}
1483

1484 1485 1486 1487 1488 1489
#if defined(major) && defined(minor)
int
virGetDeviceID(const char *path, int *maj, int *min)
{
    struct stat sb;

1490
    if (stat(path, &sb) < 0)
1491 1492
        return -errno;

1493
    if (!S_ISBLK(sb.st_mode))
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
        return -EINVAL;

    if (maj)
        *maj = major(sb.st_rdev);
    if (min)
        *min = minor(sb.st_rdev);

    return 0;
}
#else
int
J
Ján Tomko 已提交
1505 1506 1507
virGetDeviceID(const char *path G_GNUC_UNUSED,
               int *maj G_GNUC_UNUSED,
               int *min G_GNUC_UNUSED)
1508 1509 1510 1511 1512 1513 1514
{
    return -ENOSYS;
}
#endif

#define SYSFS_DEV_BLOCK_PATH "/sys/dev/block"

1515
char *
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
virGetUnprivSGIOSysfsPath(const char *path,
                          const char *sysfs_dir)
{
    int maj, min;
    char *sysfs_path = NULL;
    int rc;

    if ((rc = virGetDeviceID(path, &maj, &min)) < 0) {
        virReportSystemError(-rc,
                             _("Unable to get device ID '%s'"),
                             path);
        return NULL;
    }

1530 1531 1532
    sysfs_path = g_strdup_printf("%s/%d:%d/queue/unpriv_sgio",
                                 sysfs_dir ? sysfs_dir : SYSFS_DEV_BLOCK_PATH,
                                 maj, min);
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
    return sysfs_path;
}

int
virSetDeviceUnprivSGIO(const char *path,
                       const char *sysfs_dir,
                       int unpriv_sgio)
{
    char *sysfs_path = NULL;
    char *val = NULL;
    int ret = -1;
    int rc;

    if (!(sysfs_path = virGetUnprivSGIOSysfsPath(path, sysfs_dir)))
        return -1;

    if (!virFileExists(sysfs_path)) {
        virReportError(VIR_ERR_OPERATION_INVALID, "%s",
                       _("unpriv_sgio is not supported by this kernel"));
        goto cleanup;
    }

1555
    val = g_strdup_printf("%d", unpriv_sgio);
1556 1557 1558 1559 1560 1561 1562

    if ((rc = virFileWriteStr(sysfs_path, val, 0)) < 0) {
        virReportSystemError(-rc, _("failed to set %s"), sysfs_path);
        goto cleanup;
    }

    ret = 0;
1563
 cleanup:
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
    VIR_FREE(sysfs_path);
    VIR_FREE(val);
    return ret;
}

int
virGetDeviceUnprivSGIO(const char *path,
                       const char *sysfs_dir,
                       int *unpriv_sgio)
{
    char *sysfs_path = NULL;
    char *buf = NULL;
    char *tmp = NULL;
    int ret = -1;

    if (!(sysfs_path = virGetUnprivSGIOSysfsPath(path, sysfs_dir)))
        return -1;

    if (!virFileExists(sysfs_path)) {
        virReportError(VIR_ERR_OPERATION_INVALID, "%s",
                       _("unpriv_sgio is not supported by this kernel"));
        goto cleanup;
    }

    if (virFileReadAll(sysfs_path, 1024, &buf) < 0)
        goto cleanup;

    if ((tmp = strchr(buf, '\n')))
        *tmp = '\0';

    if (virStrToLong_i(buf, NULL, 10, unpriv_sgio) < 0) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("failed to parse value of %s"), sysfs_path);
        goto cleanup;
    }

    ret = 0;
1601
 cleanup:
1602 1603 1604 1605
    VIR_FREE(sysfs_path);
    VIR_FREE(buf);
    return ret;
}
1606

1607

M
Martin Kletzander 已提交
1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
/**
 * virParseOwnershipIds:
 *
 * Parse the usual "uid:gid" ownership specification into uid_t and
 * gid_t passed as parameters.  NULL value for those parameters mean
 * the information is not needed.  Also, none of those values are
 * changed in case of any error.
 *
 * Returns -1 on error, 0 otherwise.
 */
int
virParseOwnershipIds(const char *label, uid_t *uidPtr, gid_t *gidPtr)
{
    int rc = -1;
    uid_t theuid;
    gid_t thegid;
    char *tmp_label = NULL;
    char *sep = NULL;
    char *owner = NULL;
    char *group = NULL;

1629
    tmp_label = g_strdup(label);
M
Martin Kletzander 已提交
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656

    /* Split label */
    sep = strchr(tmp_label, ':');
    if (sep == NULL) {
        virReportError(VIR_ERR_INVALID_ARG,
                       _("Failed to parse uid and gid from '%s'"),
                       label);
        goto cleanup;
    }
    *sep = '\0';
    owner = tmp_label;
    group = sep + 1;

    /* Parse owner and group, error message is defined by
     * virGetUserID or virGetGroupID.
     */
    if (virGetUserID(owner, &theuid) < 0 ||
        virGetGroupID(group, &thegid) < 0)
        goto cleanup;

    if (uidPtr)
        *uidPtr = theuid;
    if (gidPtr)
        *gidPtr = thegid;

    rc = 0;

1657
 cleanup:
M
Martin Kletzander 已提交
1658 1659 1660 1661
    VIR_FREE(tmp_label);

    return rc;
}
1662

1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
static time_t selfLastChanged;

time_t virGetSelfLastChanged(void)
{
    return selfLastChanged;
}


void virUpdateSelfLastChanged(const char *path)
{
    struct stat sb;

    if (stat(path, &sb) < 0)
        return;

    if (sb.st_ctime > selfLastChanged) {
        VIR_DEBUG("Setting self last changed to %lld for '%s'",
                  (long long)sb.st_ctime, path);
        selfLastChanged = sb.st_ctime;
    }
}
1684

1685

P
Pavel Hrdina 已提交
1686
#ifndef WIN32
1687 1688 1689 1690
long virGetSystemPageSize(void)
{
    return sysconf(_SC_PAGESIZE);
}
P
Pavel Hrdina 已提交
1691 1692 1693 1694 1695 1696 1697
#else /* WIN32 */
long virGetSystemPageSize(void)
{
    errno = ENOSYS;
    return -1;
}
#endif /* WIN32 */
1698 1699 1700 1701 1702 1703 1704 1705

long virGetSystemPageSizeKB(void)
{
    long val = virGetSystemPageSize();
    if (val < 0)
        return val;
    return val / 1024;
}
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729

/**
 * virMemoryLimitTruncate
 *
 * Return truncated memory limit to VIR_DOMAIN_MEMORY_PARAM_UNLIMITED as maximum
 * which means that the limit is not set => unlimited.
 */
unsigned long long
virMemoryLimitTruncate(unsigned long long value)
{
    return value < VIR_DOMAIN_MEMORY_PARAM_UNLIMITED ? value :
        VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
}

/**
 * virMemoryLimitIsSet
 *
 * Returns true if the limit is set and false for unlimited value.
 */
bool
virMemoryLimitIsSet(unsigned long long value)
{
    return value < VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
}
1730 1731 1732 1733 1734


/**
 * virMemoryMaxValue
 *
1735
 * @capped: whether the value must fit into unsigned long
1736 1737
 *   (long long is assumed otherwise)
 *
1738 1739
 * Note: This function is mocked in tests/qemuxml2argvmock.c for test stability
 *
1740 1741 1742
 * Returns the maximum possible memory value in bytes.
 */
unsigned long long
1743
virMemoryMaxValue(bool capped)
1744 1745 1746
{
    /* On 32-bit machines, our bound is 0xffffffff * KiB. On 64-bit
     * machines, our bound is off_t (2^63).  */
1747
    if (capped && sizeof(unsigned long) < sizeof(long long))
1748 1749 1750 1751
        return 1024ull * ULONG_MAX;
    else
        return LLONG_MAX;
}
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776


bool
virHostHasIOMMU(void)
{
    DIR *iommuDir = NULL;
    struct dirent *iommuGroup = NULL;
    bool ret = false;
    int direrr;

    if (virDirOpenQuiet(&iommuDir, "/sys/kernel/iommu_groups/") < 0)
        goto cleanup;

    while ((direrr = virDirRead(iommuDir, &iommuGroup, NULL)) > 0)
        break;

    if (direrr < 0 || !iommuGroup)
        goto cleanup;

    ret = true;

 cleanup:
    VIR_DIR_CLOSE(iommuDir);
    return ret;
}
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819


/**
 * virHostGetDRMRenderNode:
 *
 * Picks the first DRM render node available. Missing DRI or missing DRM render
 * nodes in the system results in an error.
 *
 * Returns an absolute path to the first render node available or NULL in case
 * of an error with the error being reported.
 * Caller is responsible for freeing the result string.
 *
 */
char *
virHostGetDRMRenderNode(void)
{
    char *ret = NULL;
    DIR *driDir = NULL;
    const char *driPath = "/dev/dri";
    struct dirent *ent = NULL;
    int dirErr = 0;
    bool have_rendernode = false;

    if (virDirOpen(&driDir, driPath) < 0)
        return NULL;

    while ((dirErr = virDirRead(driDir, &ent, driPath)) > 0) {
        if (STRPREFIX(ent->d_name, "renderD")) {
            have_rendernode = true;
            break;
        }
    }

    if (dirErr < 0)
        goto cleanup;

    /* even if /dev/dri exists, there might be no renderDX nodes available */
    if (!have_rendernode) {
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("No DRM render nodes available"));
        goto cleanup;
    }

1820
    ret = g_strdup_printf("%s/%s", driPath, ent->d_name);
1821 1822 1823 1824 1825

 cleanup:
    VIR_DIR_CLOSE(driDir);
    return ret;
}