c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync/* $Id$ */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync/** @file
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * IPRT - Symbolic Links, POSIX.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync/*
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync * Copyright (C) 2010-2011 Oracle Corporation
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync *
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * available from http://www.virtualbox.org. This file is free software;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * you can redistribute it and/or modify it under the terms of the GNU
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * General Public License (GPL) as published by the Free Software
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync *
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * The contents of this file may alternatively be used under the terms
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * of the Common Development and Distribution License Version 1.0
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * VirtualBox OSE distribution, in which case the provisions of the
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * CDDL are applicable instead of those of the GPL.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync *
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * You may elect to license modified versions of this file under the
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * terms and conditions of either the GPL or the CDDL or both.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync/*******************************************************************************
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync* Header Files *
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync*******************************************************************************/
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#define LOG_GROUP RTLOGGROUP_SYMLINK
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <errno.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <sys/stat.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <unistd.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/symlink.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/assert.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/err.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/log.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/mem.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/string.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include "internal/path.h"
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsyncRTDECL(bool) RTSymlinkExists(const char *pszSymlink)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync{
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync bool fRc = false;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char const *pszNativeSymlink;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync int rc = rtPathToNative(&pszNativeSymlink, pszSymlink, NULL);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync struct stat s;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync fRc = !lstat(pszNativeSymlink, &s)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync && S_ISLNK(s.st_mode);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rtPathFreeNative(pszNativeSymlink, pszSymlink);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync LogFlow(("RTSymlinkExists(%p={%s}): returns %RTbool\n", pszSymlink, pszSymlink, fRc));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync return fRc;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync}
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsyncRTDECL(bool) RTSymlinkIsDangling(const char *pszSymlink)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync{
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync bool fRc = false;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char const *pszNativeSymlink;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync int rc = rtPathToNative(&pszNativeSymlink, pszSymlink, NULL);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync struct stat s;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync fRc = !lstat(pszNativeSymlink, &s)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync && S_ISLNK(s.st_mode);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (fRc)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync errno = 0;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync fRc = stat(pszNativeSymlink, &s) != 0
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync && ( errno == ENOENT
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync || errno == ENOTDIR
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync || errno == ELOOP);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rtPathFreeNative(pszNativeSymlink, pszSymlink);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync LogFlow(("RTSymlinkIsDangling(%p={%s}): returns %RTbool\n", pszSymlink, pszSymlink, fRc));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync return fRc;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync}
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsyncRTDECL(int) RTSymlinkCreate(const char *pszSymlink, const char *pszTarget, RTSYMLINKTYPE enmType, uint32_t fCreate)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync{
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /*
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * Validate the input.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync AssertReturn(enmType > RTSYMLINKTYPE_INVALID && enmType < RTSYMLINKTYPE_END, VERR_INVALID_PARAMETER);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync AssertPtrReturn(pszSymlink, VERR_INVALID_POINTER);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync AssertPtrReturn(pszTarget, VERR_INVALID_POINTER);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /*
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * Convert the paths.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char const *pszNativeSymlink;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync int rc = rtPathToNative(&pszNativeSymlink, pszSymlink, NULL);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync const char *pszNativeTarget;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = rtPathToNative(&pszNativeTarget, pszTarget, NULL);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /*
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * Create the link.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (symlink(pszNativeTarget, pszNativeSymlink) == 0)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = VINF_SUCCESS;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = RTErrConvertFromErrno(errno);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rtPathFreeNative(pszNativeTarget, pszTarget);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rtPathFreeNative(pszNativeSymlink, pszSymlink);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync LogFlow(("RTSymlinkCreate(%p={%s}, %p={%s}, %d, %#x): returns %Rrc\n", pszSymlink, pszSymlink, pszTarget, pszTarget, enmType, fCreate, rc));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync return rc;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync}
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsyncRTDECL(int) RTSymlinkDelete(const char *pszSymlink, uint32_t fDelete)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync{
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char const *pszNativeSymlink;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync int rc = rtPathToNative(&pszNativeSymlink, pszSymlink, NULL);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync struct stat s;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (!lstat(pszNativeSymlink, &s))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (S_ISLNK(s.st_mode))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (unlink(pszNativeSymlink) == 0)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = VINF_SUCCESS;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = RTErrConvertFromErrno(errno);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = VERR_NOT_SYMLINK;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = RTErrConvertFromErrno(errno);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rtPathFreeNative(pszNativeSymlink, pszSymlink);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync LogFlow(("RTSymlinkDelete(%p={%s}, #%x): returns %Rrc\n", pszSymlink, pszSymlink, fDelete, rc));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync return rc;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync}
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsyncRTDECL(int) RTSymlinkRead(const char *pszSymlink, char *pszTarget, size_t cbTarget, uint32_t fRead)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync{
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char *pszMyTarget;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync int rc = RTSymlinkReadA(pszSymlink, &pszMyTarget);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = RTStrCopy(pszTarget, cbTarget, pszMyTarget);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTStrFree(pszMyTarget);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync LogFlow(("RTSymlinkRead(%p={%s}): returns %Rrc\n", pszSymlink, pszSymlink, rc));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync return rc;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync}
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsyncRTDECL(int) RTSymlinkReadA(const char *pszSymlink, char **ppszTarget)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync{
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync AssertPtr(ppszTarget);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char const *pszNativeSymlink;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync int rc = rtPathToNative(&pszNativeSymlink, pszSymlink, NULL);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /* Guess the initial buffer size. */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync ssize_t cbBuf;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync struct stat s;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (!lstat(pszNativeSymlink, &s))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync cbBuf = RT_MIN(RT_ALIGN_Z(s.st_size, 64), 64);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync cbBuf = 1024;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /* Read loop that grows the buffer. */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char *pszBuf = NULL;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync for (;;)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTMemTmpFree(pszBuf);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync pszBuf = (char *)RTMemTmpAlloc(cbBuf);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (pszBuf)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync ssize_t cbReturned = readlink(pszNativeSymlink, pszBuf, cbBuf);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (cbReturned >= cbBuf)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /* Increase the buffer size and try again */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync cbBuf *= 2;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync continue;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (cbReturned > 0)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync pszBuf[cbReturned] = '\0';
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = rtPathFromNativeDup(ppszTarget, pszBuf, pszSymlink);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else if (errno == EINVAL)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = VERR_NOT_SYMLINK;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = RTErrConvertFromErrno(errno);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rc = VERR_NO_TMP_MEMORY;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync break;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync } /* for loop */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTMemTmpFree(pszBuf);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync rtPathFreeNative(pszNativeSymlink, pszSymlink);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync LogFlow(("RTSymlinkReadA(%p={%s},%p): returns %Rrc *ppszTarget=%p:{%s}\n", pszSymlink, pszSymlink, ppszTarget, rc, *ppszTarget, *ppszTarget));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync LogFlow(("RTSymlinkReadA(%p={%s},%p): returns %Rrc\n", pszSymlink, pszSymlink, ppszTarget, rc));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync return rc;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync}
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync