virutil.c 68.6 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 25 26
 *
 * Author: Daniel P. Berrange <berrange@redhat.com>
 * File created Jul 18, 2007 - Shuveb Hussain <shuveb@binarykarma.com>
 */

27
#include <config.h>
28

29
#include <stdlib.h>
30
#include <dirent.h>
31 32 33 34 35
#include <stdio.h>
#include <stdarg.h>
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
C
Cole Robinson 已提交
36
#include <poll.h>
37
#include <sys/stat.h>
38
#include <sys/types.h>
39 40 41 42 43 44 45

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

46
#include <sys/ioctl.h>
47
#include <string.h>
E
Eric Blake 已提交
48
#include <termios.h>
49
#include <locale.h>
50

51 52 53
#if HAVE_LIBDEVMAPPER_H
# include <libdevmapper.h>
#endif
54

55
#include <netdb.h>
56
#ifdef HAVE_GETPWUID_R
57 58
# include <pwd.h>
# include <grp.h>
59
#endif
60
#if WITH_CAPNG
61
# include <cap-ng.h>
62
# include <sys/prctl.h>
63
#endif
64

65
#ifdef WIN32
66 67 68
# ifdef HAVE_WINSOCK2_H
#  include <winsock2.h>
# endif
69 70 71 72
# include <windows.h>
# include <shlobj.h>
#endif

73
#include "c-ctype.h"
E
Eric Blake 已提交
74
#include "mgetgroups.h"
75
#include "virerror.h"
76
#include "virlog.h"
77
#include "virbuffer.h"
78
#include "viralloc.h"
79
#include "virthread.h"
E
Eric Blake 已提交
80
#include "verify.h"
81 82 83 84 85 86
#include "virfile.h"
#include "vircommand.h"
#include "nonblocking.h"
#include "virprocess.h"
#include "virstring.h"
#include "virutil.h"
87

88 89
verify(sizeof(gid_t) <= sizeof(unsigned int) &&
       sizeof(uid_t) <= sizeof(unsigned int));
90

91
#define VIR_FROM_THIS VIR_FROM_NONE
92

93 94
VIR_LOG_INIT("util.util");

J
Ján Tomko 已提交
95 96 97 98 99
VIR_ENUM_IMPL(virTristateBool, VIR_TRISTATE_BOOL_LAST,
              "default",
              "yes",
              "no")

J
Ján Tomko 已提交
100 101 102 103 104 105
VIR_ENUM_IMPL(virTristateSwitch, VIR_TRISTATE_SWITCH_LAST,
              "default",
              "on",
              "off")


106
#ifndef WIN32
107

108 109
int virSetInherit(int fd, bool inherit)
{
110 111
    int fflags;
    if ((fflags = fcntl(fd, F_GETFD)) < 0)
112
        return -1;
113 114 115 116 117
    if (inherit)
        fflags &= ~FD_CLOEXEC;
    else
        fflags |= FD_CLOEXEC;
    if ((fcntl(fd, F_SETFD, fflags)) < 0)
118
        return -1;
119 120 121
    return 0;
}

122
#else /* WIN32 */
123

124
int virSetInherit(int fd ATTRIBUTE_UNUSED, bool inherit ATTRIBUTE_UNUSED)
125
{
126 127 128 129 130
    /* 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;
131 132
}

133
#endif /* WIN32 */
134

135 136
int virSetBlocking(int fd, bool blocking)
{
137
    return set_nonblocking_flag(fd, !blocking);
138 139
}

140 141
int virSetNonBlock(int fd)
{
142
    return virSetBlocking(fd, false);
143
}
144

145
int virSetCloseExec(int fd)
146
{
147
    return virSetInherit(fd, false);
148 149
}

150
#ifdef WIN32
151
int virSetSockReuseAddr(int fd ATTRIBUTE_UNUSED, bool fatal ATTRIBUTE_UNUSED)
152 153 154 155 156 157 158 159 160 161 162 163 164 165
{
    /*
     * 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
166
int virSetSockReuseAddr(int fd, bool fatal)
167 168
{
    int opt = 1;
169 170 171 172 173 174 175 176
    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;
177 178 179
}
#endif

180 181 182
int
virPipeReadUntilEOF(int outfd, int errfd,
                    char **outbuf, char **errbuf) {
183

184
    struct pollfd fds[2];
185
    size_t i;
186
    bool finished[2];
187

188 189 190
    fds[0].fd = outfd;
    fds[0].events = POLLIN;
    fds[0].revents = 0;
191
    finished[0] = false;
192 193 194
    fds[1].fd = errfd;
    fds[1].events = POLLIN;
    fds[1].revents = 0;
195
    finished[1] = false;
196

197
    while (!(finished[0] && finished[1])) {
198

199 200 201 202
        if (poll(fds, ARRAY_CARDINALITY(fds), -1) < 0) {
            if ((errno == EAGAIN) || (errno == EINTR))
                continue;
            goto pollerr;
203 204
        }

205 206 207
        for (i = 0; i < ARRAY_CARDINALITY(fds); ++i) {
            char data[1024], **buf;
            int got, size;
208

209 210 211
            if (!(fds[i].revents))
                continue;
            else if (fds[i].revents & POLLHUP)
212
                finished[i] = true;
213

214 215 216
            if (!(fds[i].revents & POLLIN)) {
                if (fds[i].revents & POLLHUP)
                    continue;
217

218 219 220 221
                virReportError(VIR_ERR_INTERNAL_ERROR,
                               "%s", _("Unknown poll response."));
                goto error;
            }
222

223
            got = read(fds[i].fd, data, sizeof(data));
224

225
            if (got == sizeof(data))
226
                finished[i] = false;
A
Amy Griffis 已提交
227

228
            if (got == 0) {
229
                finished[i] = true;
230 231 232 233 234 235 236 237 238
                continue;
            }
            if (got < 0) {
                if (errno == EINTR)
                    continue;
                if (errno == EAGAIN)
                    break;
                goto pollerr;
            }
A
Amy Griffis 已提交
239

240 241
            buf = ((fds[i].fd == outfd) ? outbuf : errbuf);
            size = (*buf ? strlen(*buf) : 0);
242
            if (VIR_REALLOC_N(*buf, size+got+1) < 0)
243 244 245
                goto error;
            memmove(*buf+size, data, got);
            (*buf)[size+got] = '\0';
A
Amy Griffis 已提交
246
        }
247
        continue;
248

249 250 251 252
    pollerr:
        virReportSystemError(errno,
                             "%s", _("poll error"));
        goto error;
253 254
    }

255
    return 0;
256

257
 error:
258 259 260
    VIR_FREE(*outbuf);
    VIR_FREE(*errbuf);
    return -1;
261 262
}

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
/* 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;
    }
}

278 279 280 281 282 283 284 285 286 287 288 289 290 291
/* 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) {
292 293
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("invalid scale %llu"), scale);
294 295 296 297 298 299 300 301 302 303 304 305 306 307
            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;
        } else if (c_tolower(suffix[1]) == 'b' && !suffix[2]) {
            base = 1000;
        } else {
308
            virReportError(VIR_ERR_INVALID_ARG,
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
                         _("unknown suffix '%s'"), suffix);
            return -1;
        }
        scale = 1;
        switch (c_tolower(*suffix)) {
        case 'e':
            scale *= base;
            /* fallthrough */
        case 'p':
            scale *= base;
            /* fallthrough */
        case 't':
            scale *= base;
            /* fallthrough */
        case 'g':
            scale *= base;
            /* fallthrough */
        case 'm':
            scale *= base;
            /* fallthrough */
        case 'k':
            scale *= base;
            break;
        default:
333 334
            virReportError(VIR_ERR_INVALID_ARG,
                           _("unknown suffix '%s'"), suffix);
335 336 337 338
            return -1;
        }
    }

G
Guannan Ren 已提交
339
    if (*value && *value > (limit / scale)) {
340 341
        virReportError(VIR_ERR_OVERFLOW, _("value too large: %llu%s"),
                       *value, suffix);
342 343 344 345 346 347
        return -1;
    }
    *value *= scale;
    return 0;
}

E
Eric Blake 已提交
348

349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
/**
 * virParseNumber:
 * @str: pointer to the char pointer used
 *
 * Parse an unsigned number
 *
 * Returns the unsigned number or -1 in case of error. @str will be
 *         updated to skip the number.
 */
int
virParseNumber(const char **str)
{
    int ret = 0;
    const char *cur = *str;

    if ((*cur < '0') || (*cur > '9'))
365
        return -1;
366

J
Jim Meyering 已提交
367
    while (c_isdigit(*cur)) {
368 369 370 371
        unsigned int c = *cur - '0';

        if ((ret > INT_MAX / 10) ||
            ((ret == INT_MAX / 10) && (c > INT_MAX % 10)))
372
            return -1;
373 374 375 376
        ret = ret * 10 + c;
        cur++;
    }
    *str = cur;
377
    return ret;
378
}
379

380 381 382 383
/**
 * virParseVersionString:
 * @str: const char pointer to the version string
 * @version: unsigned long pointer to output the version number
384 385
 * @allowMissing: true to treat 3 like 3.0.0, false to error out on
 * missing minor or micro
386 387 388 389 390 391 392 393 394 395 396
 *
 * 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
397 398
virParseVersionString(const char *str, unsigned long *version,
                      bool allowMissing)
399
{
400
    unsigned int major, minor = 0, micro = 0;
401 402
    char *tmp;

403
    if (virStrToLong_ui(str, &tmp, 10, &major) < 0)
404 405
        return -1;

406 407 408
    if (!allowMissing && *tmp != '.')
        return -1;

409
    if ((*tmp == '.') && virStrToLong_ui(tmp + 1, &tmp, 10, &minor) < 0)
410 411
        return -1;

412 413 414
    if (!allowMissing && *tmp != '.')
        return -1;

415
    if ((*tmp == '.') && virStrToLong_ui(tmp + 1, &tmp, 10, &micro) < 0)
416 417
        return -1;

418 419 420
    if (major > UINT_MAX / 1000000 || minor > 999 || micro > 999)
        return -1;

421 422 423 424 425
    *version = 1000000 * major + 1000 * minor + micro;

    return 0;
}

426 427 428 429
int virEnumFromString(const char *const*types,
                      unsigned int ntypes,
                      const char *type)
{
430
    size_t i;
431 432 433
    if (!type)
        return -1;

434
    for (i = 0; i < ntypes; i++)
435 436 437 438 439 440
        if (STREQ(types[i], type))
            return i;

    return -1;
}

441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
/* In case thread-safe locales are available */
#if HAVE_NEWLOCALE

static locale_t virLocale;

static int
virLocaleOnceInit(void)
{
    virLocale = newlocale(LC_ALL_MASK, "C", (locale_t)0);
    if (!virLocale)
        return -1;
    return 0;
}

VIR_ONCE_GLOBAL_INIT(virLocale)
#endif

/**
 * virDoubleToStr
 *
 * converts double to string with C locale (thread-safe).
 *
 * Returns -1 on error, size of the string otherwise.
 */
int
virDoubleToStr(char **strp, double number)
{
    int ret = -1;

#if HAVE_NEWLOCALE

    locale_t old_loc;

    if (virLocaleInitialize() < 0)
        goto error;

    old_loc = uselocale(virLocale);
    ret = virAsprintf(strp, "%lf", number);
    uselocale(old_loc);

#else

    char *radix, *tmp;
    struct lconv *lc;

486
    if ((ret = virAsprintf(strp, "%lf", number) < 0))
487 488 489 490 491 492 493 494
        goto error;

    lc = localeconv();
    radix = lc->decimal_point;
    tmp = strstr(*strp, radix);
    if (tmp) {
        *tmp = '.';
        if (strlen(radix) > 1)
495
            memmove(tmp + 1, tmp + strlen(radix), strlen(*strp) - (tmp - *strp));
496 497 498 499 500 501 502
    }

#endif /* HAVE_NEWLOCALE */
 error:
    return ret;
}

D
Daniel P. Berrange 已提交
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532

/**
 * 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;
}


533 534 535 536 537 538 539 540 541 542
const char *virEnumToString(const char *const*types,
                            unsigned int ntypes,
                            int type)
{
    if (type < 0 || type >= ntypes)
        return NULL;

    return types[type];
}

543
/* Translates a device name of the form (regex) /^[fhv]d[a-z]+[0-9]*$/
544 545
 * into the corresponding index and partition number
 * (e.g. sda0 => (0,0), hdz2 => (25,2), vdaa12 => (26,12))
546
 * @param name The name of the device
547 548 549
 * @param disk The disk index to be returned
 * @param partition The partition index to be returned
 * @return 0 on success, or -1 on failure
550
 */
551
int virDiskNameParse(const char *name, int *disk, int *partition)
552
{
553
    const char *ptr = NULL;
554
    char *rem;
555
    int idx = 0;
556
    static char const* const drive_prefix[] = {"fd", "hd", "vd", "sd", "xvd", "ubd"};
557
    size_t i;
558

559 560 561
    for (i = 0; i < ARRAY_CARDINALITY(drive_prefix); i++) {
        if (STRPREFIX(name, drive_prefix[i])) {
            ptr = name + strlen(drive_prefix[i]);
562
            break;
563
        }
564 565
    }

566
    if (!ptr)
567 568
        return -1;

D
Daniel Veillard 已提交
569
    for (i = 0; *ptr; i++) {
J
Jim Meyering 已提交
570
        if (!c_islower(*ptr))
571
            break;
572

573
        idx = (idx + (i < 1 ? 0 : 1)) * 26;
574 575 576 577
        idx += *ptr - 'a';
        ptr++;
    }

578 579 580 581 582
    /* Count the trailing digits.  */
    size_t n_digits = strspn(ptr, "0123456789");
    if (ptr[n_digits] != '\0')
        return -1;

583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
    *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;

    if (virDiskNameParse(name, &idx, NULL))
        idx = -1;

613 614
    return idx;
}
G
Guido Günther 已提交
615

616 617 618
char *virIndexToDiskName(int idx, const char *prefix)
{
    char *name = NULL;
619 620 621
    size_t i;
    int ctr;
    int offset;
622 623

    if (idx < 0) {
624 625
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Disk index %d is negative"), idx);
626 627 628
        return NULL;
    }

629
    for (i = 0, ctr = idx; ctr >= 0; ++i, ctr = ctr / 26 - 1) { }
630 631 632

    offset = strlen(prefix);

633
    if (VIR_ALLOC_N(name, offset + i + 1))
634 635 636 637 638
        return NULL;

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

639
    for (i = i - 1, ctr = idx; ctr >= 0; --i, ctr = ctr / 26 - 1)
640
        name[offset + i] = 'a' + (ctr % 26);
641 642 643 644

    return name;
}

645
#ifndef AI_CANONIDN
646
# define AI_CANONIDN 0
647 648
#endif

C
Chris Lalancette 已提交
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
/* 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
664
 *     b)  getaddrinfo() fails or resolves to localhost - in this case, the
665 666 667
 *         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 已提交
668
 */
669 670
static char *
virGetHostnameImpl(bool quiet)
671 672
{
    int r;
673
    char hostname[HOST_NAME_MAX+1], *result = NULL;
C
Chris Lalancette 已提交
674
    struct addrinfo hints, *info;
675

676
    r = gethostname(hostname, sizeof(hostname));
677
    if (r == -1) {
678 679 680
        if (!quiet)
            virReportSystemError(errno,
                                 "%s", _("failed to determine host name"));
681
        return NULL;
682
    }
683 684
    NUL_TERMINATE(hostname);

C
Chris Lalancette 已提交
685 686 687 688 689 690 691
    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.
         */
692
        ignore_value(VIR_STRDUP_QUIET(result, hostname));
693
        goto cleanup;
C
Chris Lalancette 已提交
694 695 696 697 698 699
    }

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

700 701 702 703
    memset(&hints, 0, sizeof(hints));
    hints.ai_flags = AI_CANONNAME|AI_CANONIDN;
    hints.ai_family = AF_UNSPEC;
    r = getaddrinfo(hostname, NULL, &hints, &info);
704
    if (r != 0) {
705 706 707 708
        if (!quiet)
            VIR_WARN("getaddrinfo failed for '%s': %s",
                     hostname, gai_strerror(r));
        ignore_value(VIR_STRDUP_QUIET(result, hostname));
709
        goto cleanup;
710
    }
711

712
    /* Tell static analyzers about getaddrinfo semantics.  */
713
    sa_assert(info);
714

C
Chris Lalancette 已提交
715 716 717 718 719 720
    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
         */
721
        ignore_value(VIR_STRDUP_QUIET(result, hostname));
C
Chris Lalancette 已提交
722 723
    else
        /* Caller frees this string. */
724
        ignore_value(VIR_STRDUP_QUIET(result, info->ai_canonname));
725

C
Chris Lalancette 已提交
726
    freeaddrinfo(info);
727

728
 cleanup:
729 730
    if (!result)
        virReportOOMError();
731 732 733
    return result;
}

D
Dan Walsh 已提交
734

735 736 737 738 739 740 741 742 743 744 745 746 747 748
char *
virGetHostname(void)
{
    return virGetHostnameImpl(false);
}


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


D
Dan Walsh 已提交
749 750 751 752 753 754 755
char *
virGetUserDirectory(void)
{
    return virGetUserDirectoryByUID(geteuid());
}


756
#ifdef HAVE_GETPWUID_R
E
Eric Blake 已提交
757
/* Look up fields from the user database for the given user.  On
758 759
 * error, set errno, report the error if not instructed otherwise via @quiet,
 * and return -1.  */
E
Eric Blake 已提交
760
static int
761
virGetUserEnt(uid_t uid, char **name, gid_t *group, char **dir, char **shell, bool quiet)
762 763 764
{
    char *strbuf;
    struct passwd pwbuf;
765
    struct passwd *pw = NULL;
766 767
    long val = sysconf(_SC_GETPW_R_SIZE_MAX);
    size_t strbuflen = val;
768
    int rc;
E
Eric Blake 已提交
769 770 771 772 773 774
    int ret = -1;

    if (name)
        *name = NULL;
    if (dir)
        *dir = NULL;
775 776
    if (shell)
        *shell = NULL;
777

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

782
    if (VIR_ALLOC_N(strbuf, strbuflen) < 0)
E
Eric Blake 已提交
783
        return -1;
784

785 786 787 788 789 790 791
    /*
     * 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.
     */
792
    while ((rc = getpwuid_r(uid, &pwbuf, strbuf, strbuflen, &pw)) == ERANGE) {
793
        if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0)
E
Eric Blake 已提交
794
            goto cleanup;
795
    }
796

797
    if (rc != 0) {
798 799 800
        if (quiet)
            goto cleanup;

801
        virReportSystemError(rc,
E
Eric Blake 已提交
802 803
                             _("Failed to find user record for uid '%u'"),
                             (unsigned int) uid);
E
Eric Blake 已提交
804
        goto cleanup;
805
    } else if (pw == NULL) {
806 807 808
        if (quiet)
            goto cleanup;

809 810 811 812
        virReportError(VIR_ERR_SYSTEM_ERROR,
                       _("Failed to find user record for uid '%u'"),
                       (unsigned int) uid);
        goto cleanup;
E
Eric Blake 已提交
813 814 815 816 817 818
    }

    if (name && VIR_STRDUP(*name, pw->pw_name) < 0)
        goto cleanup;
    if (group)
        *group = pw->pw_gid;
819 820 821
    if (dir && VIR_STRDUP(*dir, pw->pw_dir) < 0)
        goto cleanup;
    if (shell && VIR_STRDUP(*shell, pw->pw_shell) < 0)
E
Eric Blake 已提交
822
        goto cleanup;
823

E
Eric Blake 已提交
824
    ret = 0;
825
 cleanup:
826 827 828 829 830 831 832 833
    if (ret < 0) {
        if (name)
            VIR_FREE(*name);
        if (dir)
            VIR_FREE(*dir);
        if (shell)
            VIR_FREE(*shell);
    }
834 835 836
    VIR_FREE(strbuf);
    return ret;
}
837

838 839 840 841 842 843 844 845 846 847 848 849 850 851
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;

852
    if (VIR_ALLOC_N(strbuf, strbuflen) < 0)
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
        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) {
869 870 871 872 873 874 875 876 877 878
        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);
        }

879 880 881 882
        VIR_FREE(strbuf);
        return NULL;
    }

883
    ignore_value(VIR_STRDUP(ret, gr->gr_name));
884 885 886 887
    VIR_FREE(strbuf);
    return ret;
}

D
Dan Walsh 已提交
888 889 890

char *
virGetUserDirectoryByUID(uid_t uid)
891
{
E
Eric Blake 已提交
892
    char *ret;
893
    virGetUserEnt(uid, NULL, NULL, &ret, NULL, false);
894 895 896 897 898 899 900
    return ret;
}


char *virGetUserShell(uid_t uid)
{
    char *ret;
901
    virGetUserEnt(uid, NULL, NULL, NULL, &ret, false);
E
Eric Blake 已提交
902
    return ret;
903 904
}

D
Dan Walsh 已提交
905

906
static char *virGetXDGDirectory(const char *xdgenvname, const char *xdgdefdir)
907
{
908
    const char *path = virGetEnvBlockSUID(xdgenvname);
909
    char *ret = NULL;
910
    char *home = NULL;
911 912

    if (path && path[0]) {
913
        ignore_value(virAsprintf(&ret, "%s/libvirt", path));
914
    } else {
E
Eric Blake 已提交
915 916 917
        home = virGetUserDirectory();
        if (home)
            ignore_value(virAsprintf(&ret, "%s/%s/libvirt", home, xdgdefdir));
918 919 920 921 922 923
    }

    VIR_FREE(home);
    return ret;
}

924
char *virGetUserConfigDirectory(void)
925
{
926
    return virGetXDGDirectory("XDG_CONFIG_HOME", ".config");
927 928
}

929
char *virGetUserCacheDirectory(void)
930
{
931
     return virGetXDGDirectory("XDG_CACHE_HOME", ".cache");
932 933
}

934
char *virGetUserRuntimeDirectory(void)
935
{
936
    const char *path = virGetEnvBlockSUID("XDG_RUNTIME_DIR");
937 938

    if (!path || !path[0]) {
939
        return virGetUserCacheDirectory();
940 941 942
    } else {
        char *ret;

943
        ignore_value(virAsprintf(&ret, "%s/libvirt", path));
944 945 946 947
        return ret;
    }
}

948
char *virGetUserName(uid_t uid)
949
{
E
Eric Blake 已提交
950
    char *ret;
951
    virGetUserEnt(uid, &ret, NULL, NULL, NULL, false);
E
Eric Blake 已提交
952
    return ret;
953 954
}

955 956 957 958 959
char *virGetGroupName(gid_t gid)
{
    return virGetGroupEnt(gid);
}

960 961 962 963 964
/* 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.
 */
static int
virGetUserIDByName(const char *name, uid_t *uid)
965
{
966
    char *strbuf = NULL;
967 968
    struct passwd pwbuf;
    struct passwd *pw = NULL;
969 970
    long val = sysconf(_SC_GETPW_R_SIZE_MAX);
    size_t strbuflen = val;
971
    int rc;
972
    int ret = -1;
973

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

978
    if (VIR_ALLOC_N(strbuf, strbuflen) < 0)
979
        goto cleanup;
980

981
    while ((rc = getpwnam_r(name, &pwbuf, strbuf, strbuflen, &pw)) == ERANGE) {
982
        if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0)
983
            goto cleanup;
984
    }
985 986

    if (!pw) {
987 988 989 990 991
        if (rc != 0) {
            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 */
992
            VIR_WARN("User record for user '%s' was not found: %s",
993 994 995
                     name, virStrerror(rc, buf, sizeof(buf)));
        }

996 997
        ret = 1;
        goto cleanup;
998 999 1000
    }

    *uid = pw->pw_uid;
1001
    ret = 0;
1002

1003
 cleanup:
1004 1005
    VIR_FREE(strbuf);

1006
    return ret;
1007 1008
}

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
/* 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 {
        int rc = virGetUserIDByName(user, uid);
        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;
}
1039

1040 1041 1042 1043 1044
/* 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.
 */
static int
virGetGroupIDByName(const char *name, gid_t *gid)
1045
{
1046
    char *strbuf = NULL;
1047 1048
    struct group grbuf;
    struct group *gr = NULL;
1049 1050
    long val = sysconf(_SC_GETGR_R_SIZE_MAX);
    size_t strbuflen = val;
1051
    int rc;
1052
    int ret = -1;
1053

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

1058
    if (VIR_ALLOC_N(strbuf, strbuflen) < 0)
1059
        goto cleanup;
1060

1061
    while ((rc = getgrnam_r(name, &grbuf, strbuf, strbuflen, &gr)) == ERANGE) {
1062
        if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0)
1063
            goto cleanup;
1064
    }
1065 1066

    if (!gr) {
1067 1068 1069 1070 1071
        if (rc != 0) {
            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 */
1072
            VIR_WARN("Group record for user '%s' was not found: %s",
1073 1074 1075
                     name, virStrerror(rc, buf, sizeof(buf)));
        }

1076 1077
        ret = 1;
        goto cleanup;
1078 1079 1080
    }

    *gid = gr->gr_gid;
1081
    ret = 0;
1082

1083
 cleanup:
1084 1085
    VIR_FREE(strbuf);

1086
    return ret;
1087
}
1088

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
/* 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 {
        int rc = virGetGroupIDByName(group, gid);
        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 已提交
1119

E
Eric Blake 已提交
1120

1121 1122
/* Compute the list of primary and supplementary groups associated
 * with @uid, and including @gid in the list (unless it is -1),
1123 1124 1125 1126 1127 1128
 * 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 已提交
1129 1130 1131
int
virGetGroupList(uid_t uid, gid_t gid, gid_t **list)
{
1132
    int ret = 0;
E
Eric Blake 已提交
1133
    char *user = NULL;
1134
    gid_t primary;
E
Eric Blake 已提交
1135 1136 1137

    *list = NULL;

1138 1139 1140 1141 1142 1143 1144 1145 1146
    /* 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;
        }
1147 1148 1149
    }

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

E
Eric Blake 已提交
1152
        for (i = 0; i < ret; i++) {
1153 1154 1155
            if ((*list)[i] == gid)
                goto cleanup;
        }
E
Eric Blake 已提交
1156
        if (VIR_APPEND_ELEMENT(*list, i, gid) < 0) {
1157 1158 1159 1160
            ret = -1;
            VIR_FREE(*list);
            goto cleanup;
        } else {
E
Eric Blake 已提交
1161
            ret = i;
1162 1163 1164
        }
    }

1165
 cleanup:
E
Eric Blake 已提交
1166 1167 1168 1169 1170
    VIR_FREE(user);
    return ret;
}


1171 1172 1173 1174
/* 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 已提交
1175 1176
 */
int
1177 1178
virSetUIDGID(uid_t uid, gid_t gid, gid_t *groups ATTRIBUTE_UNUSED,
             int ngroups ATTRIBUTE_UNUSED)
L
Laine Stump 已提交
1179
{
1180 1181 1182 1183 1184
    if (gid != (gid_t)-1 && setregid(gid, gid) < 0) {
        virReportSystemError(errno,
                             _("cannot change to '%u' group"),
                             (unsigned int) gid);
        return -1;
L
Laine Stump 已提交
1185 1186
    }

1187
# if HAVE_SETGROUPS
1188
    if (gid != (gid_t)-1 && setgroups(ngroups, groups) < 0) {
1189 1190 1191 1192
        virReportSystemError(errno, "%s",
                             _("cannot set supplemental groups"));
        return -1;
    }
L
Laine Stump 已提交
1193
# endif
1194 1195 1196 1197 1198 1199

    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 已提交
1200
    }
1201

L
Laine Stump 已提交
1202 1203 1204
    return 0;
}

1205 1206
#else /* ! HAVE_GETPWUID_R */

E
Eric Blake 已提交
1207 1208 1209 1210 1211 1212 1213 1214
int
virGetGroupList(uid_t uid ATTRIBUTE_UNUSED, gid_t gid ATTRIBUTE_UNUSED,
                gid_t **list)
{
    *list = NULL;
    return 0;
}

1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
# 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) {
1227 1228
        if (SHGetPathFromIDList(pidl, buf) && VIR_STRDUP(*path, buf) < 0)
            ret = -1;
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
        CoTaskMemFree(pidl);
    }
    return ret;
}

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

    *path = NULL;

E
Eric Blake 已提交
1241
    if (GetWindowsDirectory(windowsdir, ARRAY_CARDINALITY(windowsdir))) {
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
        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:\\");
    }

1256
    return VIR_STRDUP(*path, windowsdir) < 0 ? -1 : 0;
1257 1258 1259 1260 1261
}



char *
D
Dan Walsh 已提交
1262
virGetUserDirectoryByUID(uid_t uid ATTRIBUTE_UNUSED)
1263
{
D
Dan Walsh 已提交
1264 1265 1266
    /* 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 */
1267 1268 1269
    const char *dir;
    char *ret;

1270
    dir = virGetEnvBlockSUID("HOME");
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283

    /* 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;
1284
        while ((p = strchr(dir, '/')) != NULL)
1285 1286 1287 1288 1289
            *p = '\\';
    }

    if (!dir)
        /* USERPROFILE is probably the closest equivalent to $HOME? */
1290
        dir = virGetEnvBlockSUID("USERPROFILE");
1291

1292 1293
    if (VIR_STRDUP(ret, dir) < 0)
        return NULL;
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303

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

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

    if (!ret) {
1304 1305
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("Unable to determine home directory"));
1306 1307 1308 1309 1310 1311
        return NULL;
    }

    return ret;
}

1312 1313 1314 1315 1316 1317 1318 1319 1320
char *
virGetUserShell(uid_t uid ATTRIBUTE_UNUSED)
{
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserShell is not available"));

    return NULL;
}

1321 1322 1323 1324 1325 1326
char *
virGetUserConfigDirectory(void)
{
    char *ret;
    if (virGetWin32SpecialFolder(CSIDL_LOCAL_APPDATA, &ret) < 0)
        return NULL;
1327

1328
    if (!ret) {
1329 1330
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("Unable to determine config directory"));
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
        return NULL;
    }
    return ret;
}

char *
virGetUserCacheDirectory(void)
{
    char *ret;
    if (virGetWin32SpecialFolder(CSIDL_INTERNET_CACHE, &ret) < 0)
        return NULL;

    if (!ret) {
1344 1345
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("Unable to determine config directory"));
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
        return NULL;
    }
    return ret;
}

char *
virGetUserRuntimeDirectory(void)
{
    return virGetUserCacheDirectory();
}
E
Eric Blake 已提交
1356

1357
# else /* !HAVE_GETPWUID_R && !WIN32 */
1358
char *
D
Dan Walsh 已提交
1359
virGetUserDirectoryByUID(uid_t uid ATTRIBUTE_UNUSED)
1360
{
1361 1362
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserDirectory is not available"));
1363 1364 1365 1366

    return NULL;
}

1367 1368 1369 1370 1371 1372 1373 1374 1375
char *
virGetUserShell(uid_t uid ATTRIBUTE_UNUSED)
{
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserShell is not available"));

    return NULL;
}

1376 1377 1378
char *
virGetUserConfigDirectory(void)
{
1379 1380
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserConfigDirectory is not available"));
1381 1382 1383 1384 1385 1386 1387

    return NULL;
}

char *
virGetUserCacheDirectory(void)
{
1388 1389
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserCacheDirectory is not available"));
1390 1391 1392 1393 1394 1395 1396

    return NULL;
}

char *
virGetUserRuntimeDirectory(void)
{
1397 1398
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserRuntimeDirectory is not available"));
1399 1400 1401 1402 1403

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

1404 1405 1406
char *
virGetUserName(uid_t uid ATTRIBUTE_UNUSED)
{
1407 1408
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserName is not available"));
1409 1410 1411 1412 1413 1414 1415

    return NULL;
}

int virGetUserID(const char *name ATTRIBUTE_UNUSED,
                 uid_t *uid ATTRIBUTE_UNUSED)
{
1416 1417
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetUserID is not available"));
1418

1419
    return -1;
1420 1421 1422 1423 1424 1425
}


int virGetGroupID(const char *name ATTRIBUTE_UNUSED,
                  gid_t *gid ATTRIBUTE_UNUSED)
{
1426 1427
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetGroupID is not available"));
1428

1429
    return -1;
1430
}
L
Laine Stump 已提交
1431 1432 1433

int
virSetUIDGID(uid_t uid ATTRIBUTE_UNUSED,
1434 1435 1436
             gid_t gid ATTRIBUTE_UNUSED,
             gid_t *groups ATTRIBUTE_UNUSED,
             int ngroups ATTRIBUTE_UNUSED)
L
Laine Stump 已提交
1437
{
1438 1439
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virSetUIDGID is not available"));
L
Laine Stump 已提交
1440 1441
    return -1;
}
1442 1443 1444 1445

char *
virGetGroupName(gid_t gid ATTRIBUTE_UNUSED)
{
1446 1447
    virReportError(VIR_ERR_INTERNAL_ERROR,
                   "%s", _("virGetGroupName is not available"));
1448 1449 1450

    return NULL;
}
1451
#endif /* HAVE_GETPWUID_R */
1452

1453 1454 1455 1456 1457 1458 1459
#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
1460 1461
virSetUIDGIDWithCaps(uid_t uid, gid_t gid, gid_t *groups, int ngroups,
                     unsigned long long capBits, bool clearExistingCaps)
1462
{
1463 1464
    size_t i;
    int capng_ret, ret = -1;
1465
    bool need_setgid = false, need_setuid = false;
1466
    bool need_setpcap = false;
1467

1468 1469 1470 1471
    /* 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.
1472 1473
     */

1474
    if (clearExistingCaps || (uid != (uid_t)-1 && uid != 0))
1475
       capng_clear(CAPNG_SELECT_BOTH);
1476

1477 1478
    for (i = 0; i <= CAP_LAST_CAP; i++) {
        if (capBits & (1ULL << i)) {
1479 1480 1481
            capng_update(CAPNG_ADD,
                         CAPNG_EFFECTIVE|CAPNG_INHERITABLE|
                         CAPNG_PERMITTED|CAPNG_BOUNDING_SET,
1482
                         i);
1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506
        }
    }

    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 */
1507
    if (prctl(PR_SET_KEEPCAPS, 1, 0, 0, 0)) {
1508 1509 1510 1511 1512 1513
        virReportSystemError(errno, "%s",
                             _("prctl failed to set KEEPCAPS"));
        goto cleanup;
    }

    /* Change to the temp capabilities */
1514
    if ((capng_ret = capng_apply(CAPNG_SELECT_CAPS)) < 0) {
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
        /* 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);
            goto cleanup;
        }
1530 1531
    }

1532
    if (virSetUIDGID(uid, gid, groups, ngroups) < 0)
1533 1534 1535
        goto cleanup;

    /* Tell it we are done keeping capabilities */
1536
    if (prctl(PR_SET_KEEPCAPS, 0, 0, 0, 0)) {
1537 1538 1539 1540 1541
        virReportSystemError(errno, "%s",
                             _("prctl failed to reset KEEPCAPS"));
        goto cleanup;
    }

1542 1543 1544 1545 1546 1547
    /* 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);

1548 1549 1550 1551 1552 1553 1554 1555 1556
    /* 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);

1557
    if (((capng_ret = capng_apply(CAPNG_SELECT_CAPS)) < 0)) {
1558 1559 1560 1561 1562 1563 1564
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("cannot apply process capabilities %d"), capng_ret);
        ret = -1;
        goto cleanup;
    }

    ret = 0;
1565
 cleanup:
1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
    return ret;
}

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

int
1576
virSetUIDGIDWithCaps(uid_t uid, gid_t gid, gid_t *groups, int ngroups,
1577 1578
                     unsigned long long capBits ATTRIBUTE_UNUSED,
                     bool clearExistingCaps ATTRIBUTE_UNUSED)
1579
{
1580
    return virSetUIDGID(uid, gid, groups, ngroups);
1581 1582 1583
}
#endif

1584

1585
#if defined(UDEVADM) || defined(UDEVSETTLE)
1586
void virFileWaitForDevices(void)
D
Daniel P. Berrange 已提交
1587
{
1588
# ifdef UDEVADM
D
Daniel P. Berrange 已提交
1589
    const char *const settleprog[] = { UDEVADM, "settle", NULL };
1590
# else
D
Daniel P. Berrange 已提交
1591
    const char *const settleprog[] = { UDEVSETTLE, NULL };
1592
# endif
D
Daniel P. Berrange 已提交
1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
    int exitstatus;

    if (access(settleprog[0], X_OK) != 0)
        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.
     * If this fails for any reason, we still have the backup of polling for
     * 5 seconds for device nodes.
     */
E
Eric Blake 已提交
1604
    ignore_value(virRun(settleprog, &exitstatus));
D
Daniel P. Berrange 已提交
1605
}
1606
#else
1607 1608
void virFileWaitForDevices(void)
{}
D
Daniel P. Berrange 已提交
1609
#endif
1610

1611
#if HAVE_LIBDEVMAPPER_H
1612
bool
1613
virIsDevMapperDevice(const char *dev_name)
1614 1615 1616
{
    struct stat buf;

1617
    if (!stat(dev_name, &buf) &&
1618 1619 1620 1621 1622 1623
        S_ISBLK(buf.st_mode) &&
        dm_is_dm_major(major(buf.st_rdev)))
            return true;

    return false;
}
1624
#else
1625
bool virIsDevMapperDevice(const char *dev_name ATTRIBUTE_UNUSED)
1626 1627 1628 1629
{
    return false;
}
#endif
O
Osier Yang 已提交
1630 1631

bool
1632 1633
virValidateWWN(const char *wwn)
{
1634
    size_t i;
1635
    const char *p = wwn;
O
Osier Yang 已提交
1636

1637
    if (STRPREFIX(wwn, "0x"))
1638 1639 1640 1641
        p += 2;

    for (i = 0; p[i]; i++) {
        if (!c_isxdigit(p[i]))
O
Osier Yang 已提交
1642
            break;
1643
    }
O
Osier Yang 已提交
1644

1645
    if (i != 16 || p[i]) {
1646 1647
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Malformed wwn: %s"), wwn);
O
Osier Yang 已提交
1648 1649 1650 1651 1652
        return false;
    }

    return true;
}
1653

1654 1655 1656 1657 1658 1659
#if defined(major) && defined(minor)
int
virGetDeviceID(const char *path, int *maj, int *min)
{
    struct stat sb;

1660
    if (stat(path, &sb) < 0)
1661 1662
        return -errno;

1663
    if (!S_ISBLK(sb.st_mode))
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
        return -EINVAL;

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

    return 0;
}
#else
int
E
Eric Blake 已提交
1675 1676 1677
virGetDeviceID(const char *path ATTRIBUTE_UNUSED,
               int *maj ATTRIBUTE_UNUSED,
               int *min ATTRIBUTE_UNUSED)
1678 1679 1680 1681 1682 1683 1684 1685
{

    return -ENOSYS;
}
#endif

#define SYSFS_DEV_BLOCK_PATH "/sys/dev/block"

1686
char *
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700
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;
    }

1701 1702 1703
    ignore_value(virAsprintf(&sysfs_path, "%s/%d:%d/queue/unpriv_sgio",
                             sysfs_dir ? sysfs_dir : SYSFS_DEV_BLOCK_PATH,
                             maj, min));
1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
    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;
    }

1726
    if (virAsprintf(&val, "%d", unpriv_sgio) < 0)
1727 1728 1729 1730 1731 1732 1733 1734
        goto cleanup;

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

    ret = 0;
1735
 cleanup:
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772
    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;
1773
 cleanup:
1774 1775 1776 1777
    VIR_FREE(sysfs_path);
    VIR_FREE(buf);
    return ret;
}
1778 1779 1780

#ifdef __linux__
# define SYSFS_FC_HOST_PATH "/sys/class/fc_host/"
O
Osier Yang 已提交
1781
# define SYSFS_SCSI_HOST_PATH "/sys/class/scsi_host/"
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 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
/* virReadSCSIUniqueId:
 * @sysfs_prefix: "scsi_host" sysfs path, defaults to SYSFS_SCSI_HOST_PATH
 * @host: Host number, E.g. 5 of "scsi_host/host5"
 * @result: Return the entry value as an unsigned int
 *
 * Read the value of the "scsi_host" unique_id file.
 *
 * Returns 0 on success, and @result is filled with the unique_id value
 * Otherwise returns -1
 */
int
virReadSCSIUniqueId(const char *sysfs_prefix,
                    int host,
                    int *result)
{
    char *sysfs_path = NULL;
    char *p = NULL;
    int ret = -1;
    char *buf = NULL;
    int unique_id;

    if (virAsprintf(&sysfs_path, "%s/host%d/unique_id",
                    sysfs_prefix ? sysfs_prefix : SYSFS_SCSI_HOST_PATH,
                    host) < 0)
        goto cleanup;

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

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

    if (virStrToLong_i(buf, NULL, 10, &unique_id) < 0) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("unable to parse unique_id: %s"), buf);

        goto cleanup;
    }

    *result = unique_id;
    ret = 0;

 cleanup:
    VIR_FREE(sysfs_path);
    VIR_FREE(buf);
    return ret;
}

1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866
/* virFindSCSIHostByPCI:
 * @sysfs_prefix: "scsi_host" sysfs path, defaults to SYSFS_SCSI_HOST_PATH
 * @parentaddr: string of the PCI address "scsi_host" device to be found
 * @unique_id: unique_id value of the to be found "scsi_host" device
 * @result: Return the host# of the matching "scsi_host" device
 *
 * Iterate over the SYSFS_SCSI_HOST_PATH entries looking for a matching
 * PCI Address in the expected format (dddd:bb:ss.f, where 'dddd' is the
 * 'domain' value, 'bb' is the 'bus' value, 'ss' is the 'slot' value, and
 * 'f' is the 'function' value from the PCI address) with a unique_id file
 * entry having the value expected. Unlike virReadSCSIUniqueId() we don't
 * have a host number yet and that's what we're looking for.
 *
 * Returns the host name of the "scsi_host" which must be freed by the caller,
 * or NULL on failure
 */
char *
virFindSCSIHostByPCI(const char *sysfs_prefix,
                     const char *parentaddr,
                     unsigned int unique_id)
{
    const char *prefix = sysfs_prefix ? sysfs_prefix : SYSFS_SCSI_HOST_PATH;
    struct dirent *entry = NULL;
    DIR *dir = NULL;
    char *host_link = NULL;
    char *host_path = NULL;
    char *p = NULL;
    char *ret = NULL;
    char *buf = NULL;
    char *unique_path = NULL;
    unsigned int read_unique_id;

    if (!(dir = opendir(prefix))) {
        virReportSystemError(errno,
                             _("Failed to opendir path '%s'"),
                             prefix);
J
Jiri Denemark 已提交
1867
        return NULL;
1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905
    }

    while (virDirRead(dir, &entry, prefix) > 0) {
        if (entry->d_name[0] == '.' || !virFileIsLink(entry->d_name))
            continue;

        if (virAsprintf(&host_link, "%s/%s", prefix, entry->d_name) < 0)
            goto cleanup;

        if (virFileResolveLink(host_link, &host_path) < 0)
            goto cleanup;

        if (!strstr(host_path, parentaddr)) {
            VIR_FREE(host_link);
            VIR_FREE(host_path);
            continue;
        }
        VIR_FREE(host_link);
        VIR_FREE(host_path);

        if (virAsprintf(&unique_path, "%s/%s/unique_id", prefix,
                        entry->d_name) < 0)
            goto cleanup;

        if (!virFileExists(unique_path)) {
            VIR_FREE(unique_path);
            continue;
        }

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

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

        if (virStrToLong_ui(buf, NULL, 10, &read_unique_id) < 0)
            goto cleanup;

1906 1907
        VIR_FREE(buf);

1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
        if (read_unique_id != unique_id) {
            VIR_FREE(unique_path);
            continue;
        }

        ignore_value(VIR_STRDUP(ret, entry->d_name));
        break;
    }

 cleanup:
J
Ján Tomko 已提交
1918
    VIR_DIR_CLOSE(dir);
1919 1920 1921
    VIR_FREE(unique_path);
    VIR_FREE(host_link);
    VIR_FREE(host_path);
1922
    VIR_FREE(buf);
1923 1924 1925
    return ret;
}

1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971
/* virGetSCSIHostNumber:
 * @adapter_name: Name of the host adapter
 * @result: Return the entry value as unsigned int
 *
 * Convert the various forms of scsi_host names into the numeric
 * host# value that can be used in order to scan sysfs looking for
 * the specific host.
 *
 * Names can be either "scsi_host#" or just "host#", where
 * "host#" is the back-compat format, but both equate to
 * the same source adapter.  First check if both pool and def
 * are using same format (easier) - if so, then compare
 *
 * Returns 0 on success, and @result has the host number.
 * Otherwise returns -1.
 */
int
virGetSCSIHostNumber(const char *adapter_name,
                     unsigned int *result)
{
    /* Specifying adapter like 'host5' is still supported for
     * back-compat reason.
     */
    if (STRPREFIX(adapter_name, "scsi_host")) {
        adapter_name += strlen("scsi_host");
    } else if (STRPREFIX(adapter_name, "fc_host")) {
        adapter_name += strlen("fc_host");
    } else if (STRPREFIX(adapter_name, "host")) {
        adapter_name += strlen("host");
    } else {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Invalid adapter name '%s' for SCSI pool"),
                       adapter_name);
        return -1;
    }

    if (virStrToLong_ui(adapter_name, NULL, 10, result) == -1) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Invalid adapter name '%s' for SCSI pool"),
                       adapter_name);
        return -1;
    }

    return 0;
}

1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010
/* virGetSCSIHostNameByParentaddr:
 * @domain: The domain from the scsi_host parentaddr
 * @bus: The bus from the scsi_host parentaddr
 * @slot: The slot from the scsi_host parentaddr
 * @function: The function from the scsi_host parentaddr
 * @unique_id: The unique id value for parentaddr
 *
 * Generate a parentaddr and find the scsi_host host# for
 * the provided parentaddr PCI address fields.
 *
 * Returns the "host#" string which must be free'd by
 * the caller or NULL on error
 */
char *
virGetSCSIHostNameByParentaddr(unsigned int domain,
                               unsigned int bus,
                               unsigned int slot,
                               unsigned int function,
                               unsigned int unique_id)
{
    char *name = NULL;
    char *parentaddr = NULL;

    if (virAsprintf(&parentaddr, "%04x:%02x:%02x.%01x",
                    domain, bus, slot, function) < 0)
        goto cleanup;
    if (!(name = virFindSCSIHostByPCI(NULL, parentaddr, unique_id))) {
        virReportError(VIR_ERR_XML_ERROR,
                       _("Failed to find scsi_host using PCI '%s' "
                         "and unique_id='%u'"),
                       parentaddr, unique_id);
        goto cleanup;
    }

 cleanup:
    VIR_FREE(parentaddr);
    return name;
}

2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035
/* virReadFCHost:
 * @sysfs_prefix: "fc_host" sysfs path, defaults to SYSFS_FC_HOST_PATH
 * @host: Host number, E.g. 5 of "fc_host/host5"
 * @entry: Name of the sysfs entry to read
 * @result: Return the entry value as string
 *
 * Read the value of sysfs "fc_host" entry.
 *
 * Returns 0 on success, and @result is filled with the entry value.
 * as string, Otherwise returns -1. Caller must free @result after
 * use.
 */
int
virReadFCHost(const char *sysfs_prefix,
              int host,
              const char *entry,
              char **result)
{
    char *sysfs_path = NULL;
    char *p = NULL;
    int ret = -1;
    char *buf = NULL;

    if (virAsprintf(&sysfs_path, "%s/host%d/%s",
                    sysfs_prefix ? sysfs_prefix : SYSFS_FC_HOST_PATH,
2036
                    host, entry) < 0)
2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049
        goto cleanup;

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

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

    if ((p = strstr(buf, "0x")))
        p += strlen("0x");
    else
        p = buf;

O
Osier Yang 已提交
2050
    if (VIR_STRDUP(*result, p) < 0)
2051 2052 2053
        goto cleanup;

    ret = 0;
2054
 cleanup:
2055 2056 2057 2058
    VIR_FREE(sysfs_path);
    VIR_FREE(buf);
    return ret;
}
O
Osier Yang 已提交
2059

2060
bool
O
Osier Yang 已提交
2061 2062 2063 2064
virIsCapableFCHost(const char *sysfs_prefix,
                   int host)
{
    char *sysfs_path = NULL;
2065
    bool ret = false;
O
Osier Yang 已提交
2066

2067
    if (virAsprintf(&sysfs_path, "%s/host%d",
O
Osier Yang 已提交
2068
                    sysfs_prefix ? sysfs_prefix : SYSFS_FC_HOST_PATH,
2069
                    host) < 0)
2070
        return false;
O
Osier Yang 已提交
2071

2072
    if (virFileExists(sysfs_path))
2073
        ret = true;
O
Osier Yang 已提交
2074 2075 2076 2077 2078

    VIR_FREE(sysfs_path);
    return ret;
}

2079
bool
O
Osier Yang 已提交
2080 2081 2082 2083 2084
virIsCapableVport(const char *sysfs_prefix,
                  int host)
{
    char *scsi_host_path = NULL;
    char *fc_host_path = NULL;
E
Eric Blake 已提交
2085
    bool ret = false;
O
Osier Yang 已提交
2086 2087

    if (virAsprintf(&fc_host_path,
2088
                    "%s/host%d/%s",
O
Osier Yang 已提交
2089 2090
                    sysfs_prefix ? sysfs_prefix : SYSFS_FC_HOST_PATH,
                    host,
2091
                    "vport_create") < 0)
2092
        return false;
O
Osier Yang 已提交
2093 2094

    if (virAsprintf(&scsi_host_path,
2095
                    "%s/host%d/%s",
O
Osier Yang 已提交
2096 2097
                    sysfs_prefix ? sysfs_prefix : SYSFS_SCSI_HOST_PATH,
                    host,
2098
                    "vport_create") < 0)
O
Osier Yang 已提交
2099 2100
        goto cleanup;

2101 2102
    if (virFileExists(fc_host_path) ||
        virFileExists(scsi_host_path))
2103
        ret = true;
O
Osier Yang 已提交
2104

2105
 cleanup:
O
Osier Yang 已提交
2106 2107 2108 2109
    VIR_FREE(fc_host_path);
    VIR_FREE(scsi_host_path);
    return ret;
}
2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134

int
virManageVport(const int parent_host,
               const char *wwpn,
               const char *wwnn,
               int operation)
{
    int ret = -1;
    char *operation_path = NULL, *vport_name = NULL;
    const char *operation_file = NULL;

    switch (operation) {
    case VPORT_CREATE:
        operation_file = "vport_create";
        break;
    case VPORT_DELETE:
        operation_file = "vport_delete";
        break;
    default:
        virReportError(VIR_ERR_OPERATION_INVALID,
                       _("Invalid vport operation (%d)"), operation);
        goto cleanup;
    }

    if (virAsprintf(&operation_path,
2135
                    "%s/host%d/%s",
2136 2137
                    SYSFS_FC_HOST_PATH,
                    parent_host,
2138
                    operation_file) < 0)
2139 2140 2141 2142 2143
        goto cleanup;

    if (!virFileExists(operation_path)) {
        VIR_FREE(operation_path);
        if (virAsprintf(&operation_path,
2144
                        "%s/host%d/%s",
2145 2146
                        SYSFS_SCSI_HOST_PATH,
                        parent_host,
2147
                        operation_file) < 0)
2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159
            goto cleanup;

        if (!virFileExists(operation_path)) {
            virReportError(VIR_ERR_OPERATION_INVALID,
                           _("vport operation '%s' is not supported for host%d"),
                           operation_file, parent_host);
            goto cleanup;
        }
    }

    if (virAsprintf(&vport_name,
                    "%s:%s",
2160
                    wwpn,
2161
                    wwnn) < 0)
2162 2163 2164 2165 2166 2167 2168 2169 2170 2171
        goto cleanup;

    if (virFileWriteStr(operation_path, vport_name, 0) == 0)
        ret = 0;
    else
        virReportSystemError(errno,
                             _("Write of '%s' to '%s' during "
                               "vport create/delete failed"),
                             vport_name, operation_path);

2172
 cleanup:
2173 2174 2175 2176
    VIR_FREE(vport_name);
    VIR_FREE(operation_path);
    return ret;
}
2177 2178 2179

/* virGetHostNameByWWN:
 *
2180
 * Iterate over the sysfs tree to get FC host name (e.g. host5)
O
Osier Yang 已提交
2181 2182 2183 2184
 * by the provided "wwnn,wwpn" pair.
 *
 * Returns the FC host name which must be freed by the caller,
 * or NULL on failure.
2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219
 */
char *
virGetFCHostNameByWWN(const char *sysfs_prefix,
                      const char *wwnn,
                      const char *wwpn)
{
    const char *prefix = sysfs_prefix ? sysfs_prefix : SYSFS_FC_HOST_PATH;
    struct dirent *entry = NULL;
    DIR *dir = NULL;
    char *wwnn_path = NULL;
    char *wwpn_path = NULL;
    char *wwnn_buf = NULL;
    char *wwpn_buf = NULL;
    char *p;
    char *ret = NULL;

    if (!(dir = opendir(prefix))) {
        virReportSystemError(errno,
                             _("Failed to opendir path '%s'"),
                             prefix);
        return NULL;
    }

# define READ_WWN(wwn_path, buf)                      \
    do {                                              \
        if (virFileReadAll(wwn_path, 1024, &buf) < 0) \
            goto cleanup;                             \
        if ((p = strchr(buf, '\n')))                  \
            *p = '\0';                                \
        if (STRPREFIX(buf, "0x"))                     \
            p = buf + strlen("0x");                   \
        else                                          \
            p = buf;                                  \
    } while (0)

E
Eric Blake 已提交
2220
    while (virDirRead(dir, &entry, prefix) > 0) {
2221 2222 2223
        if (entry->d_name[0] == '.')
            continue;

2224
        if (virAsprintf(&wwnn_path, "%s/%s/node_name", prefix,
2225
                        entry->d_name) < 0)
2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240
            goto cleanup;

        if (!virFileExists(wwnn_path)) {
            VIR_FREE(wwnn_path);
            continue;
        }

        READ_WWN(wwnn_path, wwnn_buf);

        if (STRNEQ(wwnn, p)) {
            VIR_FREE(wwnn_buf);
            VIR_FREE(wwnn_path);
            continue;
        }

2241
        if (virAsprintf(&wwpn_path, "%s/%s/port_name", prefix,
2242
                        entry->d_name) < 0)
2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261
            goto cleanup;

        if (!virFileExists(wwpn_path)) {
            VIR_FREE(wwnn_buf);
            VIR_FREE(wwnn_path);
            VIR_FREE(wwpn_path);
            continue;
        }

        READ_WWN(wwpn_path, wwpn_buf);

        if (STRNEQ(wwpn, p)) {
            VIR_FREE(wwnn_path);
            VIR_FREE(wwpn_path);
            VIR_FREE(wwnn_buf);
            VIR_FREE(wwpn_buf);
            continue;
        }

2262
        ignore_value(VIR_STRDUP(ret, entry->d_name));
2263 2264 2265
        break;
    }

2266
 cleanup:
2267
# undef READ_WWN
J
Ján Tomko 已提交
2268
    VIR_DIR_CLOSE(dir);
2269 2270 2271 2272 2273 2274
    VIR_FREE(wwnn_path);
    VIR_FREE(wwpn_path);
    VIR_FREE(wwnn_buf);
    VIR_FREE(wwpn_buf);
    return ret;
}
2275 2276 2277 2278 2279 2280

# define PORT_STATE_ONLINE "Online"

/* virFindFCHostCapableVport:
 *
 * Iterate over the sysfs and find out the first online HBA which
O
Osier Yang 已提交
2281 2282
 * supports vport, and not saturated. Returns the host name (e.g.
 * host5) on success, or NULL on failure.
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301
 */
char *
virFindFCHostCapableVport(const char *sysfs_prefix)
{
    const char *prefix = sysfs_prefix ? sysfs_prefix : SYSFS_FC_HOST_PATH;
    DIR *dir = NULL;
    struct dirent *entry = NULL;
    char *max_vports = NULL;
    char *vports = NULL;
    char *state = NULL;
    char *ret = NULL;

    if (!(dir = opendir(prefix))) {
        virReportSystemError(errno,
                             _("Failed to opendir path '%s'"),
                             prefix);
        return NULL;
    }

E
Eric Blake 已提交
2302
    while (virDirRead(dir, &entry, prefix) > 0) {
2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315
        unsigned int host;
        char *p = NULL;

        if (entry->d_name[0] == '.')
            continue;

        p = entry->d_name + strlen("host");
        if (virStrToLong_ui(p, NULL, 10, &host) == -1) {
            VIR_DEBUG("Failed to parse host number from '%s'",
                      entry->d_name);
            continue;
        }

O
Osier Yang 已提交
2316
        if (!virIsCapableVport(prefix, host))
2317 2318
            continue;

O
Osier Yang 已提交
2319
        if (virReadFCHost(prefix, host, "port_state", &state) < 0) {
2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330
             VIR_DEBUG("Failed to read port_state for host%d", host);
             continue;
        }

        /* Skip the not online FC host */
        if (STRNEQ(state, PORT_STATE_ONLINE)) {
            VIR_FREE(state);
            continue;
        }
        VIR_FREE(state);

O
Osier Yang 已提交
2331
        if (virReadFCHost(prefix, host, "max_npiv_vports", &max_vports) < 0) {
2332 2333 2334 2335
             VIR_DEBUG("Failed to read max_npiv_vports for host%d", host);
             continue;
        }

O
Osier Yang 已提交
2336
        if (virReadFCHost(prefix, host, "npiv_vports_inuse", &vports) < 0) {
2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347
             VIR_DEBUG("Failed to read npiv_vports_inuse for host%d", host);
             VIR_FREE(max_vports);
             continue;
        }

        /* Compare from the strings directly, instead of converting
         * the strings to integers first
         */
        if ((strlen(max_vports) >= strlen(vports)) ||
            ((strlen(max_vports) == strlen(vports)) &&
             strcmp(max_vports, vports) > 0)) {
2348
            ignore_value(VIR_STRDUP(ret, entry->d_name));
2349 2350 2351 2352 2353 2354 2355
            goto cleanup;
        }

        VIR_FREE(max_vports);
        VIR_FREE(vports);
    }

2356
 cleanup:
J
Ján Tomko 已提交
2357
    VIR_DIR_CLOSE(dir);
2358 2359 2360 2361
    VIR_FREE(max_vports);
    VIR_FREE(vports);
    return ret;
}
2362
#else
2363 2364 2365
int
virReadSCSIUniqueId(const char *sysfs_prefix ATTRIBUTE_UNUSED,
                    int host ATTRIBUTE_UNUSED,
2366
                    int *result ATTRIBUTE_UNUSED)
2367 2368 2369 2370 2371
{
    virReportSystemError(ENOSYS, "%s", _("Not supported on this platform"));
    return -1;
}

2372 2373 2374 2375
char *
virFindSCSIHostByPCI(const char *sysfs_prefix ATTRIBUTE_UNUSED,
                     const char *parentaddr ATTRIBUTE_UNUSED,
                     unsigned int unique_id ATTRIBUTE_UNUSED)
2376 2377 2378 2379 2380 2381 2382 2383
{
    virReportSystemError(ENOSYS, "%s", _("Not supported on this platform"));
    return NULL;
}

int
virGetSCSIHostNumber(const char *adapter_name ATTRIBUTE_UNUSED,
                     unsigned int *result ATTRIBUTE_UNUSED)
2384 2385
{
    virReportSystemError(ENOSYS, "%s", _("Not supported on this platform"));
2386
    return -1;
2387 2388 2389 2390 2391 2392 2393 2394
}

char *
virGetSCSIHostNameByParentaddr(unsigned int domain ATTRIBUTE_UNUSED,
                               unsigned int bus ATTRIBUTE_UNUSED,
                               unsigned int slot ATTRIBUTE_UNUSED,
                               unsigned int function ATTRIBUTE_UNUSED,
                               unsigned int unique_id ATTRIBUTE_UNUSED)
2395 2396
{
    virReportSystemError(ENOSYS, "%s", _("Not supported on this platform"));
2397
    return NULL;
2398 2399
}

2400 2401 2402 2403 2404 2405 2406 2407 2408
int
virReadFCHost(const char *sysfs_prefix ATTRIBUTE_UNUSED,
              int host ATTRIBUTE_UNUSED,
              const char *entry ATTRIBUTE_UNUSED,
              char **result ATTRIBUTE_UNUSED)
{
    virReportSystemError(ENOSYS, "%s", _("Not supported on this platform"));
    return -1;
}
O
Osier Yang 已提交
2409

2410
bool
2411 2412
virIsCapableFCHost(const char *sysfs_prefix ATTRIBUTE_UNUSED,
                   int host ATTRIBUTE_UNUSED)
O
Osier Yang 已提交
2413 2414
{
    virReportSystemError(ENOSYS, "%s", _("Not supported on this platform"));
2415
    return false;
O
Osier Yang 已提交
2416 2417
}

2418
bool
2419 2420
virIsCapableVport(const char *sysfs_prefix ATTRIBUTE_UNUSED,
                  int host ATTRIBUTE_UNUSED)
O
Osier Yang 已提交
2421 2422
{
    virReportSystemError(ENOSYS, "%s", _("Not supported on this platform"));
2423
    return false;
O
Osier Yang 已提交
2424
}
2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435

int
virManageVport(const int parent_host ATTRIBUTE_UNUSED,
               const char *wwpn ATTRIBUTE_UNUSED,
               const char *wwnn ATTRIBUTE_UNUSED,
               int operation ATTRIBUTE_UNUSED)
{
    virReportSystemError(ENOSYS, "%s", _("Not supported on this platform"));
    return -1;
}

2436 2437 2438 2439 2440 2441 2442 2443 2444
char *
virGetFCHostNameByWWN(const char *sysfs_prefix ATTRIBUTE_UNUSED,
                      const char *wwnn ATTRIBUTE_UNUSED,
                      const char *wwpn ATTRIBUTE_UNUSED)
{
    virReportSystemError(ENOSYS, "%s", _("Not supported on this platform"));
    return NULL;
}

2445 2446 2447 2448 2449 2450 2451
char *
virFindFCHostCapableVport(const char *sysfs_prefix ATTRIBUTE_UNUSED)
{
    virReportSystemError(ENOSYS, "%s", _("Not supported on this platform"));
    return NULL;
}

2452
#endif /* __linux__ */
2453

M
Martin Kletzander 已提交
2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503
/**
 * 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;

    if (VIR_STRDUP(tmp_label, label) < 0)
        goto cleanup;

    /* 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;

2504
 cleanup:
M
Martin Kletzander 已提交
2505 2506 2507 2508
    VIR_FREE(tmp_label);

    return rc;
}
2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520


/**
 * virGetEnvBlockSUID:
 * @name: the environment variable name
 *
 * Obtain an environment variable which is unsafe to
 * use when running setuid. If running setuid, a NULL
 * value will be returned
 */
const char *virGetEnvBlockSUID(const char *name)
{
2521
    return secure_getenv(name); /* exempt from syntax-check */
2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534
}


/**
 * virGetEnvBlockSUID:
 * @name: the environment variable name
 *
 * Obtain an environment variable which is safe to
 * use when running setuid. The value will be returned
 * even when running setuid
 */
const char *virGetEnvAllowSUID(const char *name)
{
2535
    return getenv(name); /* exempt from syntax-check */
2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547
}


/**
 * virIsSUID:
 * Return a true value if running setuid. Does not
 * check for elevated capabilities bits.
 */
bool virIsSUID(void)
{
    return getuid() != geteuid();
}
2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570


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;
    }
}
2571

2572 2573
#ifndef WIN32

2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627
/**
 * virGetListenFDs:
 *
 * Parse LISTEN_PID and LISTEN_FDS passed from caller.
 *
 * Returns number of passed FDs.
 */
unsigned int
virGetListenFDs(void)
{
    const char *pidstr;
    const char *fdstr;
    size_t i = 0;
    unsigned long long procid;
    unsigned int nfds;

    VIR_DEBUG("Setting up networking from caller");

    if (!(pidstr = virGetEnvAllowSUID("LISTEN_PID"))) {
        VIR_DEBUG("No LISTEN_PID from caller");
        return 0;
    }

    if (virStrToLong_ull(pidstr, NULL, 10, &procid) < 0) {
        VIR_DEBUG("Malformed LISTEN_PID from caller %s", pidstr);
        return 0;
    }

    if ((pid_t)procid != getpid()) {
        VIR_DEBUG("LISTEN_PID %s is not for us %llu",
                  pidstr, (unsigned long long)getpid());
        return 0;
    }

    if (!(fdstr = virGetEnvAllowSUID("LISTEN_FDS"))) {
        VIR_DEBUG("No LISTEN_FDS from caller");
        return 0;
    }

    if (virStrToLong_ui(fdstr, NULL, 10, &nfds) < 0) {
        VIR_DEBUG("Malformed LISTEN_FDS from caller %s", fdstr);
        return 0;
    }

    unsetenv("LISTEN_PID");
    unsetenv("LISTEN_FDS");

    VIR_DEBUG("Got %u file descriptors", nfds);

    for (i = 0; i < nfds; i++) {
        int fd = STDERR_FILENO + i + 1;

        VIR_DEBUG("Disabling inheritance of passed FD %d", fd);

2628
        if (virSetInherit(fd, false) < 0)
2629 2630 2631 2632 2633
            VIR_WARN("Couldn't disable inheritance of passed FD %d", fd);
    }

    return nfds;
}
2634 2635 2636 2637 2638 2639 2640 2641 2642 2643

#else /* WIN32 */

unsigned int
virGetListenFDs(void)
{
    return 0;
}

#endif /* WIN32 */
2644

P
Pavel Hrdina 已提交
2645
#ifndef WIN32
2646 2647 2648 2649
long virGetSystemPageSize(void)
{
    return sysconf(_SC_PAGESIZE);
}
P
Pavel Hrdina 已提交
2650 2651 2652 2653 2654 2655 2656
#else /* WIN32 */
long virGetSystemPageSize(void)
{
    errno = ENOSYS;
    return -1;
}
#endif /* WIN32 */
2657 2658 2659 2660 2661 2662 2663 2664

long virGetSystemPageSizeKB(void)
{
    long val = virGetSystemPageSize();
    if (val < 0)
        return val;
    return val / 1024;
}
2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688

/**
 * 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;
}
2689 2690 2691 2692 2693


/**
 * virMemoryMaxValue
 *
2694
 * @capped: whether the value must fit into unsigned long
2695 2696
 *   (long long is assumed otherwise)
 *
2697 2698
 * Note: This function is mocked in tests/qemuxml2argvmock.c for test stability
 *
2699 2700 2701
 * Returns the maximum possible memory value in bytes.
 */
unsigned long long
2702
virMemoryMaxValue(bool capped)
2703 2704 2705
{
    /* On 32-bit machines, our bound is 0xffffffff * KiB. On 64-bit
     * machines, our bound is off_t (2^63).  */
2706
    if (capped && sizeof(unsigned long) < sizeof(long long))
2707 2708 2709 2710
        return 1024ull * ULONG_MAX;
    else
        return LLONG_MAX;
}