VirtualBox

Changeset 92707 in vbox


Ignore:
Timestamp:
Dec 2, 2021 1:14:23 PM (3 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
148606
Message:

Guest Control: Resolved a @todo: A bit more scoping for some defines, even if they're part of the guestControl namespace.

Location:
trunk
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/GuestHost/GuestControl.h

    r84816 r92707  
    6262    PROC_STS_ERROR = 8
    6363};
    64 
    65 /** @todo r=bird: Most defines in this file needs to be scoped a little
    66  *        better!  For instance INPUT_FLAG_NONE is very generic. */
    67 
     64 
    6865/**
    6966 * Input flags, set by the host. This is needed for
    … …  
    7168 * Note: Has to match Main's ProcessInputFlag_* flags!
    7269 */
    73 #define INPUT_FLAG_NONE                     0x0
    74 #define INPUT_FLAG_EOF                      RT_BIT(0)
     70#define GUEST_PROC_IN_FLAG_NONE                     0x0
     71#define GUEST_PROC_IN_FLAG_EOF                      RT_BIT(0)
    7572
    7673/**
    … …  
    9794/** @}   */
    9895
    99 /** @name EXECUTEPROCESSFLAG_XXX - Guest process creation flags.
     96/** @name GUEST_PROC_CREATE_FLAG_XXX - Guest process creation flags.
    10097 * @note Has to match Main's ProcessCreateFlag_* flags!
    10198 * @{
    10299 */
    103 #define EXECUTEPROCESSFLAG_NONE             UINT32_C(0x0)
    104 #define EXECUTEPROCESSFLAG_WAIT_START       RT_BIT(0)
    105 #define EXECUTEPROCESSFLAG_IGNORE_ORPHANED  RT_BIT(1)
    106 #define EXECUTEPROCESSFLAG_HIDDEN           RT_BIT(2)
    107 #define EXECUTEPROCESSFLAG_PROFILE          RT_BIT(3)
    108 #define EXECUTEPROCESSFLAG_WAIT_STDOUT      RT_BIT(4)
    109 #define EXECUTEPROCESSFLAG_WAIT_STDERR      RT_BIT(5)
    110 #define EXECUTEPROCESSFLAG_EXPAND_ARGUMENTS RT_BIT(6)
    111 #define EXECUTEPROCESSFLAG_UNQUOTED_ARGS    RT_BIT(7)
    112 /** @} */
    113 
    114 /** @name OUTPUT_HANDLE_ID_XXX - Pipe handle IDs used internally for referencing
     100#define GUEST_PROC_CREATE_FLAG_NONE             UINT32_C(0x0)
     101#define GUEST_PROC_CREATE_FLAG_WAIT_START       RT_BIT(0)
     102#define GUEST_PROC_CREATE_FLAG_IGNORE_ORPHANED  RT_BIT(1)
     103#define GUEST_PROC_CREATE_FLAG_HIDDEN           RT_BIT(2)
     104#define GUEST_PROC_CREATE_FLAG_PROFILE          RT_BIT(3)
     105#define GUEST_PROC_CREATE_FLAG_WAIT_STDOUT      RT_BIT(4)
     106#define GUEST_PROC_CREATE_FLAG_WAIT_STDERR      RT_BIT(5)
     107#define GUEST_PROC_CREATE_FLAG_EXPAND_ARGUMENTS RT_BIT(6)
     108#define GUEST_PROC_CREATE_FLAG_UNQUOTED_ARGS    RT_BIT(7)
     109/** @} */
     110
     111/** @name GUEST_PROC_OUT_H_XXX - Pipe handle IDs used internally for referencing
    115112 *        to a certain pipe buffer.
    116113 * @{
    117114 */
    118 #define OUTPUT_HANDLE_ID_STDOUT_DEPRECATED  0 /**< Needed for VBox hosts < 4.1.0. */
    119 #define OUTPUT_HANDLE_ID_STDOUT             1
    120 #define OUTPUT_HANDLE_ID_STDERR             2
     115#define GUEST_PROC_OUT_H_STDOUT_DEPRECATED  0 /**< Needed for VBox hosts < 4.1.0. */
     116#define GUEST_PROC_OUT_H_STDOUT             1
     117#define GUEST_PROC_OUT_H_STDERR             2
    121118/** @} */
    122119
    … …  
    135132/** @} */
    136133
    137 /** @name SHUTDOWN_FLAG_XXX - Guest shutdown flags.
     134/** @name GUEST_SHUTDOWN_FLAG_XXX - Guest shutdown flags.
    138135 * Must match Main's GuestShutdownFlag_ definitions.
    139136 * @{
    140137 */
    141 #define SHUTDOWN_FLAG_NONE                  UINT32_C(0)
    142 #define SHUTDOWN_FLAG_POWER_OFF             RT_BIT(0)
    143 #define SHUTDOWN_FLAG_REBOOT                RT_BIT(1)
    144 #define SHUTDOWN_FLAG_FORCE                 RT_BIT(2)
     138#define GUEST_SHUTDOWN_FLAG_NONE            UINT32_C(0)
     139#define GUEST_SHUTDOWN_FLAG_POWER_OFF       RT_BIT(0)
     140#define GUEST_SHUTDOWN_FLAG_REBOOT          RT_BIT(1)
     141#define GUEST_SHUTDOWN_FLAG_FORCE           RT_BIT(2)
    145142/** @} */
    146143
    … …  
    150147 * @{
    151148 */
    152 #define GUESTPROCESS_DEFAULT_CMD_LEN        _1K
    153 #define GUESTPROCESS_DEFAULT_ARGS_LEN       _1K
    154 #define GUESTPROCESS_DEFAULT_ENV_LEN        _1K
    155 #define GUESTPROCESS_DEFAULT_USER_LEN       128
    156 #define GUESTPROCESS_DEFAULT_PASSWORD_LEN   128
    157 #define GUESTPROCESS_DEFAULT_DOMAIN_LEN     256
     149#define GUEST_PROC_DEF_CMD_LEN        _1K
     150#define GUEST_PROC_DEF_ARGS_LEN       _1K
     151#define GUEST_PROC_DEF_ENV_LEN        _1K
     152#define GUEST_PROC_DEF_USER_LEN       128
     153#define GUEST_PROC_DEF_PASSWORD_LEN   128
     154#define GUEST_PROC_DEF_DOMAIN_LEN     256
    158155/** @} */
    159156
    … …  
    161158 * @{
    162159 */
    163 #define GUESTPROCESS_MAX_CMD_LEN            _1M
    164 #define GUESTPROCESS_MAX_ARGS_LEN           _2M
    165 #define GUESTPROCESS_MAX_ENV_LEN            _4M
    166 #define GUESTPROCESS_MAX_USER_LEN           _64K
    167 #define GUESTPROCESS_MAX_PASSWORD_LEN       _64K
    168 #define GUESTPROCESS_MAX_DOMAIN_LEN         _64K
     160#define GUEST_PROC_MAX_CMD_LEN            _1M
     161#define GUEST_PROC_MAX_ARGS_LEN           _2M
     162#define GUEST_PROC_MAX_ENV_LEN            _4M
     163#define GUEST_PROC_MAX_USER_LEN           _64K
     164#define GUEST_PROC_MAX_PASSWORD_LEN       _64K
     165#define GUEST_PROC_MAX_DOMAIN_LEN         _64K
    169166/** @} */
    170167

  • trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibGuestCtrl.cpp

    r84850 r92707  
    792792{
    793793    return VbglR3GuestCtrlSessionStartupInfoInitEx(pStartupInfo,
    794                                                    GUESTPROCESS_DEFAULT_USER_LEN, GUESTPROCESS_DEFAULT_PASSWORD_LEN,
    795                                                    GUESTPROCESS_DEFAULT_DOMAIN_LEN);
     794                                                   GUEST_PROC_DEF_USER_LEN, GUEST_PROC_DEF_PASSWORD_LEN,
     795                                                   GUEST_PROC_DEF_DOMAIN_LEN);
    796796}
    797797
    … …  
    11431143{
    11441144    return VbglR3GuestCtrlProcStartupInfoInitEx(pStartupInfo,
    1145                                                 GUESTPROCESS_DEFAULT_CMD_LEN,
    1146                                                 GUESTPROCESS_DEFAULT_USER_LEN     /* Deprecated, now handled via session creation. */,
    1147                                                 GUESTPROCESS_DEFAULT_PASSWORD_LEN /* Ditto. */,
    1148                                                 GUESTPROCESS_DEFAULT_DOMAIN_LEN   /* Ditto. */,
    1149                                                 GUESTPROCESS_DEFAULT_ARGS_LEN, GUESTPROCESS_DEFAULT_ENV_LEN);
     1145                                                GUEST_PROC_DEF_CMD_LEN,
     1146                                                GUEST_PROC_DEF_USER_LEN     /* Deprecated, now handled via session creation. */,
     1147                                                GUEST_PROC_DEF_PASSWORD_LEN /* Ditto. */,
     1148                                                GUEST_PROC_DEF_DOMAIN_LEN   /* Ditto. */,
     1149                                                GUEST_PROC_DEF_ARGS_LEN, GUEST_PROC_DEF_ENV_LEN);
    11501150}
    11511151
    … …  
    13191319
    13201320                /* We can't tell which parameter doesn't fit, so we have to resize all. */
    1321                 GROW_STR(Cmd , GUESTPROCESS_MAX_CMD_LEN);
    1322                 GROW_STR(Args, GUESTPROCESS_MAX_ARGS_LEN);
    1323                 GROW_STR(Env,  GUESTPROCESS_MAX_ENV_LEN);
     1321                GROW_STR(Cmd , GUEST_PROC_MAX_CMD_LEN);
     1322                GROW_STR(Args, GUEST_PROC_MAX_ARGS_LEN);
     1323                GROW_STR(Env,  GUEST_PROC_MAX_ENV_LEN);
    13241324
    13251325#undef GROW_STR

  • trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControlProcess.cpp

    r92690 r92707  
    10491049    AssertPtrReturn(pszArgv0,   VERR_INVALID_POINTER);
    10501050    AssertPtrReturn(ppapszArgv, VERR_INVALID_POINTER);
    1051     AssertReturn(!(fFlags & EXECUTEPROCESSFLAG_EXPAND_ARGUMENTS), VERR_INVALID_FLAGS); /** @todo implement me */
     1051    AssertReturn(!(fFlags & GUEST_PROC_CREATE_FLAG_EXPAND_ARGUMENTS), VERR_INVALID_FLAGS); /** @todo implement me */
    10521052
    10531053#ifndef VBOXSERVICE_ARG1_UTF8_ARGV
    … …  
    10851085                   ignored on all other hosts. */
    10861086#ifdef RT_OS_WINDOWS
    1087     if (   (fFlags & EXECUTEPROCESSFLAG_UNQUOTED_ARGS)
     1087    if (   (fFlags & GUEST_PROC_CREATE_FLAG_UNQUOTED_ARGS)
    10881088        && strpbrk(pszArgv0, " \t\n\r")
    10891089        && pszArgv0[0] == '"')
    … …  
    11231123            {
    11241124#if 0 /* Arguments expansion -- untested. */
    1125                 if (fFlags & EXECUTEPROCESSFLAG_EXPAND_ARGUMENTS)
     1125                if (fFlags & GUEST_PROC_CREATE_FLAG_EXPAND_ARGUMENTS)
    11261126                {
    11271127/** @todo r=bird: If you want this, we need a generic implementation, preferably in RTEnv or somewhere like that.  The marking
    … …  
    14011401            if (fFlags)
    14021402            {
    1403                 if (fFlags & EXECUTEPROCESSFLAG_HIDDEN)
     1403                if (fFlags & GUEST_PROC_CREATE_FLAG_HIDDEN)
    14041404                    fProcCreateFlags |= RTPROC_FLAGS_HIDDEN;
    1405                 if (fFlags & EXECUTEPROCESSFLAG_PROFILE)
     1405                if (fFlags & GUEST_PROC_CREATE_FLAG_PROFILE)
    14061406                    fProcCreateFlags |= RTPROC_FLAGS_PROFILE;
    1407                 if (fFlags & EXECUTEPROCESSFLAG_UNQUOTED_ARGS)
     1407                if (fFlags & GUEST_PROC_CREATE_FLAG_UNQUOTED_ARGS)
    14081408                    fProcCreateFlags |= RTPROC_FLAGS_UNQUOTED_ARGS;
    14091409            }
    … …  
    15731573    uint32_t const cbEnv = pProcess->pStartupInfo->cbEnv;
    15741574    if (RT_SUCCESS(rc))
    1575         AssertStmt(   cbEnv <= GUESTPROCESS_MAX_ENV_LEN
     1575        AssertStmt(   cbEnv <= GUEST_PROC_MAX_ENV_LEN
    15761576                   || pProcess->pStartupInfo->cEnvVars == 0,
    15771577                   rc = VERR_INVALID_PARAMETER);
    … …  
    16201620                    RTHANDLE    hStdOut;
    16211621                    PRTHANDLE   phStdOut;
    1622                     rc = vgsvcGstCtrlProcessSetupPipe(  (pProcess->pStartupInfo->fFlags & EXECUTEPROCESSFLAG_WAIT_STDOUT)
     1622                    rc = vgsvcGstCtrlProcessSetupPipe(  (pProcess->pStartupInfo->fFlags & GUEST_PROC_CREATE_FLAG_WAIT_STDOUT)
    16231623                                                 ? "|" : "/dev/null",
    16241624                                                 1 /*STDOUT_FILENO*/,
    … …  
    16281628                        RTHANDLE    hStdErr;
    16291629                        PRTHANDLE   phStdErr;
    1630                         rc = vgsvcGstCtrlProcessSetupPipe(  (pProcess->pStartupInfo->fFlags & EXECUTEPROCESSFLAG_WAIT_STDERR)
     1630                        rc = vgsvcGstCtrlProcessSetupPipe(  (pProcess->pStartupInfo->fFlags & GUEST_PROC_CREATE_FLAG_WAIT_STDERR)
    16311631                                                     ? "|" : "/dev/null",
    16321632                                                     2 /*STDERR_FILENO*/,
    … …  
    19841984    if (pvBuf)
    19851985    {
    1986         PRTPIPE phPipe = uHandle == OUTPUT_HANDLE_ID_STDOUT
     1986        PRTPIPE phPipe = uHandle == GUEST_PROC_OUT_H_STDOUT
    19871987                       ? &pThis->hPipeStdOutR
    19881988                       : &pThis->hPipeStdErrR;
    … …  
    19951995            if (RT_FAILURE(rc))
    19961996            {
    1997                 RTPollSetRemove(pThis->hPollSet,   uHandle == OUTPUT_HANDLE_ID_STDERR
     1997                RTPollSetRemove(pThis->hPollSet,   uHandle == GUEST_PROC_OUT_H_STDERR
    19981998                                                 ? VBOXSERVICECTRLPIPEID_STDERR : VBOXSERVICECTRLPIPEID_STDOUT);
    19991999                RTPipeClose(*phPipe);
    … …  
    20102010        {
    20112011            if (   pSession->fFlags & VBOXSERVICECTRLSESSION_FLAG_DUMPSTDOUT
    2012                 && (   uHandle == OUTPUT_HANDLE_ID_STDOUT
    2013                     || uHandle == OUTPUT_HANDLE_ID_STDOUT_DEPRECATED)
     2012                && (   uHandle == GUEST_PROC_OUT_H_STDOUT
     2013                    || uHandle == GUEST_PROC_OUT_H_STDOUT_DEPRECATED)
    20142014               )
    20152015            {
    … …  
    20192019            }
    20202020            else if (   pSession->fFlags & VBOXSERVICECTRLSESSION_FLAG_DUMPSTDERR
    2021                      && uHandle == OUTPUT_HANDLE_ID_STDERR)
     2021                     && uHandle == GUEST_PROC_OUT_H_STDERR)
    20222022            {
    20232023                rc = vgsvcGstCtrlProcessDbgDumpToFileF(pvBuf, cbRead, "VBoxService_Session%RU32_PID%RU32_StdErr.txt",

  • trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControlSession.cpp

    r92674 r92707  
    10221022
    10231023            /* Translate SHUTDOWN_FLAG_ into RTSYSTEM_SHUTDOWN_ flags. */
    1024             if (fAction & SHUTDOWN_FLAG_REBOOT)
     1024            if (fAction & GUEST_SHUTDOWN_FLAG_REBOOT)
    10251025                fSystemShutdown |= RTSYSTEM_SHUTDOWN_REBOOT;
    10261026            else /* SHUTDOWN_FLAG_POWER_OFF */
    10271027                fSystemShutdown |= RTSYSTEM_SHUTDOWN_POWER_OFF;
    10281028
    1029             if (fAction & SHUTDOWN_FLAG_FORCE)
     1029            if (fAction & GUEST_SHUTDOWN_FLAG_FORCE)
    10301030                fSystemShutdown |= RTSYSTEM_SHUTDOWN_FORCE;
    10311031
    … …  
    11791179    if (RT_SUCCESS(rc))
    11801180    {
    1181         if (fFlags & INPUT_FLAG_EOF)
     1181        if (fFlags & GUEST_PROC_IN_FLAG_EOF)
    11821182            VGSvcVerbose(4, "Got last process input block for PID=%RU32 (%RU32 bytes) ...\n", uPID, cbInput);
    11831183
    … …  
    11881188        if (pProcess)
    11891189        {
    1190             rc = VGSvcGstCtrlProcessHandleInput(pProcess, pHostCtx, RT_BOOL(fFlags & INPUT_FLAG_EOF),
     1190            rc = VGSvcGstCtrlProcessHandleInput(pProcess, pHostCtx, RT_BOOL(fFlags & GUEST_PROC_IN_FLAG_EOF),
    11911191                                                *ppvScratchBuf, RT_MIN(cbInput, *pcbScratchBuf));
    11921192            if (RT_FAILURE(rc))

  • trunk/src/VBox/Main/idl/VirtualBox.xidl

    r92223 r92707  
    1326013260      Guest process execution flags.
    1326113261      <note>The values are passed to the Guest Additions, so its not possible
    13262             to change (move) or reuse values.here. See EXECUTEPROCESSFLAG_XXX
     13262            to change (move) or reuse values.here. See GUEST_PROC_CREATE_FLAG_XXX
    1326313263            in GuestControlSvc.h.</note>
    1326413264    </desc>

  • trunk/src/VBox/Main/src-client/GuestProcessImpl.cpp

    r91718 r92707  
    854854        /* Skip reading if the process wasn't started with the appropriate
    855855         * flags. */
    856         || (   (   uHandle == OUTPUT_HANDLE_ID_STDOUT
    857                 || uHandle == OUTPUT_HANDLE_ID_STDOUT_DEPRECATED)
     856        || (   (   uHandle == GUEST_PROC_OUT_H_STDOUT
     857                || uHandle == GUEST_PROC_OUT_H_STDOUT_DEPRECATED)
    858858            && !(mData.mProcess.mFlags & ProcessCreateFlag_WaitForStdOut))
    859         || (   uHandle == OUTPUT_HANDLE_ID_STDERR
     859        || (   uHandle == GUEST_PROC_OUT_H_STDERR
    860860            && !(mData.mProcess.mFlags & ProcessCreateFlag_WaitForStdErr))
    861861       )
    … …  
    20362036{
    20372037    const GuestProcessStream *pStream = NULL;
    2038     if (uHandle == OUTPUT_HANDLE_ID_STDOUT)
     2038    if (uHandle == GUEST_PROC_OUT_H_STDOUT)
    20392039        pStream = &mStdOut;
    2040     else if (uHandle == OUTPUT_HANDLE_ID_STDERR)
     2040    else if (uHandle == GUEST_PROC_OUT_H_STDERR)
    20412041        pStream = &mStdErr;
    20422042
    … …  
    23122312    {
    23132313        AssertPtr(pStrmBlkOut);
    2314         vrc = getCurrentBlock(OUTPUT_HANDLE_ID_STDOUT, *pStrmBlkOut);
     2314        vrc = getCurrentBlock(GUEST_PROC_OUT_H_STDOUT, *pStrmBlkOut);
    23152315        if (RT_SUCCESS(vrc))
    23162316            return vrc;
    … …  
    24222422
    24232423            cbRead = 0;
    2424             vrc = pProcess->i_readData(OUTPUT_HANDLE_ID_STDOUT, sizeof(byBuf),
     2424            vrc = pProcess->i_readData(GUEST_PROC_OUT_H_STDOUT, sizeof(byBuf),
    24252425                                       GET_REMAINING_TIME,
    24262426                                       byBuf, sizeof(byBuf),
    … …  
    24392439                {
    24402440                    AssertPtr(pStrmBlkOut);
    2441                     vrc = getCurrentBlock(OUTPUT_HANDLE_ID_STDOUT, *pStrmBlkOut);
     2441                    vrc = getCurrentBlock(GUEST_PROC_OUT_H_STDOUT, *pStrmBlkOut);
    24422442
    24432443                    /* When successful, break out of the loop because we're done
    … …  
    24562456
    24572457            cbRead = 0;
    2458             vrc = pProcess->i_readData(OUTPUT_HANDLE_ID_STDERR, sizeof(byBuf),
     2458            vrc = pProcess->i_readData(GUEST_PROC_OUT_H_STDERR, sizeof(byBuf),
    24592459                                       GET_REMAINING_TIME,
    24602460                                       byBuf, sizeof(byBuf),
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette