syscall_return.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __SIM_SYSCALLRETURN_HH__
#define __SIM_SYSCALLRETURN_HH__
 
#include <cassert>
#include <cinttypes>
 
namespace gem5
{

class SyscallReturn
{
  public:

    SyscallReturn(int64_t v) : _value(v), _count(1) {}

    SyscallReturn() : _count(0) {}

    SyscallReturn(int64_t v1, int64_t v2) :
        _value(v1), _value2(v2), _count(2)
    {}

    static SyscallReturn
    retry()
    {
        SyscallReturn s(0);
        s.retryFlag = true;
        return s;
    }
 
    ~SyscallReturn() {}

    bool
    successful() const
    {
        return (_value >= 0 || _value <= -4096);
    }

    bool needsRetry() const { return retryFlag; }

    bool suppressed() const { return _count == 0; }

    int count() const { return _count; }

    int64_t
    returnValue() const
    {
        assert(successful());
        return _value;
    }

    int
    errnoValue() const
    {
        assert(!successful());
        return -_value;
    }

    int64_t encodedValue() const { return _value; }
    int64_t value2() const { return _value2; }
 
  private:
    int64_t _value, _value2;
    int _count;
 
    bool retryFlag = false;
};
 
} // namespace gem5
 
#endif