/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */ /* camel-stream-mem.c: memory buffer based stream */ /* * Authors: Bertrand Guiheneuf * Michael Zucchi * * Copyright 1999, 2000 Ximian, Inc. (www.ximian.com) * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA */ #ifdef HAVE_CONFIG_H #include #endif #include #include #include #include #include #include "camel-stream-mem.h" static CamelSeekableStreamClass *parent_class = NULL; /* Returns the class for a CamelStreamMem */ #define CSM_CLASS(so) CAMEL_STREAM_MEM_CLASS(CAMEL_OBJECT_GET_CLASS(so)) static ssize_t stream_read (CamelStream *stream, char *buffer, size_t n); static ssize_t stream_write (CamelStream *stream, const char *buffer, size_t n); static gboolean stream_eos (CamelStream *stream); static off_t stream_seek (CamelSeekableStream *stream, off_t offset, CamelStreamSeekPolicy policy); static void camel_stream_mem_finalize (CamelObject *object); static void camel_stream_mem_class_init (CamelStreamMemClass *camel_stream_mem_class) { CamelSeekableStreamClass *camel_seekable_stream_class = CAMEL_SEEKABLE_STREAM_CLASS (camel_stream_mem_class); CamelStreamClass *camel_stream_class = CAMEL_STREAM_CLASS (camel_stream_mem_class); parent_class = CAMEL_SEEKABLE_STREAM_CLASS( camel_type_get_global_classfuncs( CAMEL_SEEKABLE_STREAM_TYPE ) ); /* virtual method overload */ camel_stream_class->read = stream_read; camel_stream_class->write = stream_write; camel_stream_class->eos = stream_eos; camel_seekable_stream_class->seek = stream_seek; } static void camel_stream_mem_init (CamelObject *object) { CamelStreamMem *stream_mem = CAMEL_STREAM_MEM (object); stream_mem->owner = FALSE; stream_mem->buffer = 0; } CamelType camel_stream_mem_get_type (void) { static CamelType camel_stream_mem_type = CAMEL_INVALID_TYPE; if (camel_stream_mem_type == CAMEL_INVALID_TYPE) { camel_stream_mem_type = camel_type_register( CAMEL_SEEKABLE_STREAM_TYPE, "CamelStreamMem", sizeof( CamelStreamMem ), sizeof( CamelStreamMemClass ), (CamelObjectClassInitFunc) camel_stream_mem_class_init, NULL, (CamelObjectInitFunc) camel_stream_mem_init, (CamelObjectFinalizeFunc) camel_stream_mem_finalize ); } return camel_stream_mem_type; } CamelStream * camel_stream_mem_new (void) { return camel_stream_mem_new_with_byte_array (g_byte_array_new ()); } CamelStream * camel_stream_mem_new_with_buffer (const char *buffer, size_t len) { GByteArray *ba; ba = g_byte_array_new (); g_byte_array_append (ba, (const guint8 *)buffer, len); return camel_stream_mem_new_with_byte_array (ba); } CamelStream * camel_stream_mem_new_with_byte_array (GByteArray *byte_array) { CamelStreamMem *stream_mem; stream_mem = CAMEL_STREAM_MEM( camel_object_new (CAMEL_STREAM_MEM_TYPE) ); stream_mem->buffer = byte_array; stream_mem->owner = TRUE; return CAMEL_STREAM (stream_mem); } /* note: with these functions the caller is the 'owner' of the buffer */ void camel_stream_mem_set_byte_array (CamelStreamMem *s, GByteArray *buffer) { if (s->buffer && s->owner) g_byte_array_free(s->buffer, TRUE); s->owner = FALSE; s->buffer = buffer; } void camel_stream_mem_set_buffer (CamelStreamMem *s, const char *buffer, size_t len) { GByteArray *ba; ba = g_byte_array_new (); g_byte_array_append(ba, (const guint8 *)buffer, len); camel_stream_mem_set_byte_array(s, ba); s->owner = TRUE; } static void camel_stream_mem_finalize (CamelObject *object) { CamelStreamMem *stream_mem = CAMEL_STREAM_MEM (object); if (stream_mem->buffer && stream_mem->owner) g_byte_array_free (stream_mem->buffer, TRUE); /* Will be called automagically in the Camel Type System! * Wheeee! * G_TK_OBJECT_CLASS (parent_class)->finalize (object); */ } static ssize_t stream_read (CamelStream *stream, char *buffer, size_t n) { CamelStreamMem *camel_stream_mem = CAMEL_STREAM_MEM (stream); CamelSeekableStream *seekable = CAMEL_SEEKABLE_STREAM (stream); ssize_t nread; if (seekable->bound_end != CAMEL_STREAM_UNBOUND) n = MIN(seekable->bound_end - seekable->position, n); nread = MIN (n, camel_stream_mem->buffer->len - seekable->position); if (nread > 0) { memcpy (buffer, camel_stream_mem->buffer->data + seekable->position, nread); seekable->position += nread; } else nread = 0; return nread; } static ssize_t stream_write (CamelStream *stream, const char *buffer, size_t n) { CamelStreamMem *stream_mem = CAMEL_STREAM_MEM (stream); CamelSeekableStream *seekable = CAMEL_SEEKABLE_STREAM (stream); ssize_t nwrite = n; if (seekable->bound_end != CAMEL_STREAM_UNBOUND) nwrite = MIN(seekable->bound_end - seekable->position, n); #ifndef NO_WARNINGS #warning "g_byte_arrays use g_malloc and so are totally unsuitable for this object" #endif if (seekable->position == stream_mem->buffer->len) { g_byte_array_append(stream_mem->buffer, (const guint8 *)buffer, nwrite); } else { g_byte_array_set_size(stream_mem->buffer, nwrite + stream_mem->buffer->len); memcpy(stream_mem->buffer->data + seekable->position, buffer, nwrite); } seekable->position += nwrite; return nwrite; } static gboolean stream_eos (CamelStream *stream) { CamelStreamMem *stream_mem = CAMEL_STREAM_MEM (stream); CamelSeekableStream *seekable_stream = CAMEL_SEEKABLE_STREAM (stream); return stream_mem->buffer->len <= seekable_stream->position; } static off_t stream_seek (CamelSeekableStream *stream, off_t offset, CamelStreamSeekPolicy policy) { off_t position; CamelStreamMem *stream_mem = CAMEL_STREAM_MEM (stream); switch (policy) { case CAMEL_STREAM_SET: position = offset; break; case CAMEL_STREAM_CUR: position = stream->position + offset; break; case CAMEL_STREAM_END: position = (stream_mem->buffer)->len + offset; break; default: position = offset; break; } if (stream->bound_end != CAMEL_STREAM_UNBOUND) position = MIN (position, stream->bound_end); if (stream->bound_start != CAMEL_STREAM_UNBOUND) position = MAX (position, 0); else position = MAX (position, stream->bound_start); if (position > stream_mem->buffer->len) { int oldlen = stream_mem->buffer->len; g_byte_array_set_size (stream_mem->buffer, position); memset (stream_mem->buffer->data + oldlen, 0, position - oldlen); } stream->position = position; return position; } 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
/*
    This file is part of solidity.

    solidity is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    solidity 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with solidity.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
 * @author Federico Bond <federicobond@gmail.com>
 * @date 2016
 * Static analyzer and checker.
 */

#include <libsolidity/analysis/StaticAnalyzer.h>
#include <libsolidity/analysis/ConstantEvaluator.h>
#include <libsolidity/ast/AST.h>
#include <libsolidity/interface/ErrorReporter.h>
#include <memory>

using namespace std;
using namespace dev;
using namespace dev::solidity;

bool StaticAnalyzer::analyze(SourceUnit const& _sourceUnit)
{
    _sourceUnit.accept(*this);
    return Error::containsOnlyWarnings(m_errorReporter.errors());
}

bool StaticAnalyzer::visit(ContractDefinition const& _contract)
{
    m_library = _contract.isLibrary();
    m_currentContract = &_contract;
    return true;
}

void StaticAnalyzer::endVisit(ContractDefinition const&)
{
    m_library = false;
    m_currentContract = nullptr;
}

bool StaticAnalyzer::visit(FunctionDefinition const& _function)
{
    if (_function.isImplemented())
        m_currentFunction = &_function;
    else
        solAssert(!m_currentFunction, "");
    solAssert(m_localVarUseCount.empty(), "");
    m_constructor = _function.isConstructor();
    return true;
}

void StaticAnalyzer::endVisit(FunctionDefinition const&)
{
    m_currentFunction = nullptr;
    m_constructor = false;
    for (auto const& var: m_localVarUseCount)
        if (var.second == 0)
        {
            if (var.first.second->isCallableParameter())
                m_errorReporter.warning(
                    var.first.second->location(),
                    "Unused function parameter. Remove or comment out the variable name to silence this warning."
                );
            else
                m_errorReporter.warning(var.first.second->location(), "Unused local variable.");
        }

    m_localVarUseCount.clear();
}

bool StaticAnalyzer::visit(Identifier const& _identifier)
{
    if (m_currentFunction)
        if (auto var = dynamic_cast<VariableDeclaration const*>(_identifier.annotation().referencedDeclaration))
        {
            solAssert(!var->name().empty(), "");
            if (var->isLocalVariable())
                m_localVarUseCount[make_pair(var->id(), var)] += 1;
        }
    return true;
}

bool StaticAnalyzer::visit(VariableDeclaration const& _variable)
{
    if (m_currentFunction)
    {
        solAssert(_variable.isLocalVariable(), "");
        if (_variable.name() != "")
            // This is not a no-op, the entry might pre-exist.
            m_localVarUseCount[make_pair(_variable.id(), &_variable)] += 0;
    }
    else if (_variable.isStateVariable())
    {
        set<StructDefinition const*> structsSeen;
        if (structureSizeEstimate(*_variable.type(), structsSeen) >= bigint(1) << 64)
            m_errorReporter.warning(
                _variable.location(),
                "Variable covers a large part of storage and thus makes collisions likely. "
                "Either use mappings or dynamic arrays and allow their size to be increased only "
                "in small quantities per transaction."
            );
    }
    return true;
}

bool StaticAnalyzer::visit(Return const& _return)
{
    // If the return has an expression, it counts as
    // a "use" of the return parameters.
    if (m_currentFunction && _return.expression())
        for (auto const& var: m_currentFunction->returnParameters())
            if (!var->name().empty())
                m_localVarUseCount[make_pair(var->id(), var.get())] += 1;
    return true;
}

bool StaticAnalyzer::visit(ExpressionStatement const& _statement)
{
    if (_statement.expression().annotation().isPure)
        m_errorReporter.warning(
            _statement.location(),
            "Statement has no effect."
        );

    return true;
}

bool StaticAnalyzer::visit(MemberAccess const& _memberAccess)
{
    if (MagicType const* type = dynamic_cast<MagicType const*>(_memberAccess.expression().annotation().type.get()))
    {
        if (type->kind() == MagicType::Kind::Message && _memberAccess.memberName() == "gas")
            m_errorReporter.typeError(
                _memberAccess.location(),
                "\"msg.gas\" has been deprecated in favor of \"gasleft()\""
            );
        else if (type->kind() == MagicType::Kind::Block && _memberAccess.memberName() == "blockhash")
            m_errorReporter.typeError(
                _memberAccess.location(),
                "\"block.blockhash()\" has been deprecated in favor of \"blockhash()\""
            );
    }

    if (_memberAccess.memberName() == "callcode")
        if (auto const* type = dynamic_cast<FunctionType const*>(_memberAccess.annotation().type.get()))
            if (type->kind() == FunctionType::Kind::BareCallCode)
                m_errorReporter.typeError(
                    _memberAccess.location(),
                    "\"callcode\" has been deprecated in favour of \"delegatecall\"."
                );

    if (m_constructor)
    {
        auto const* expr = &_memberAccess.expression();
        while(expr)
        {
            if (auto id = dynamic_cast<Identifier const*>(expr))
            {
                if (id->name() == "this")
                    m_errorReporter.warning(
                        id->location(),
                        "\"this\" used in constructor. "
                        "Note that external functions of a contract "
                        "cannot be called while it is being constructed.");
                break;
            }
            else if (auto tuple = dynamic_cast<TupleExpression const*>(expr))
            {
                if (tuple->components().size() == 1)
                    expr = tuple->components().front().get();
                else
                    break;
            }
            else
                break;
        }
    }

    return true;
}

bool StaticAnalyzer::visit(InlineAssembly const& _inlineAssembly)
{
    if (!m_currentFunction)
        return true;

    for (auto const& ref: _inlineAssembly.annotation().externalReferences)
    {
        if (auto var = dynamic_cast<VariableDeclaration const*>(ref.second.declaration))
        {
            solAssert(!var->name().empty(), "");
            if (var->isLocalVariable())
                m_localVarUseCount[make_pair(var->id(), var)] += 1;
        }
    }

    return true;
}

bool StaticAnalyzer::visit(BinaryOperation const& _operation)
{
    if (
        _operation.rightExpression().annotation().isPure &&
        (_operation.getOperator() == Token::Div || _operation.getOperator() == Token::Mod)
    )
        if (auto rhs = dynamic_pointer_cast<RationalNumberType const>(
            ConstantEvaluator(m_errorReporter).evaluate(_operation.rightExpression())
        ))
            if (rhs->isZero())
                m_errorReporter.typeError(
                    _operation.location(),
                    (_operation.getOperator() == Token::Div) ? "Division by zero." : "Modulo zero."
                );

    return true;
}

bool StaticAnalyzer::visit(FunctionCall const& _functionCall)
{
    if (_functionCall.annotation().kind == FunctionCallKind::FunctionCall)
    {
        auto functionType = dynamic_pointer_cast<FunctionType const>(_functionCall.expression().annotation().type);
        solAssert(functionType, "");
        if (functionType->kind() == FunctionType::Kind::AddMod || functionType->kind() == FunctionType::Kind::MulMod)
        {
            solAssert(_functionCall.arguments().size() == 3, "");
            if (_functionCall.arguments()[2]->annotation().isPure)
                if (auto lastArg = dynamic_pointer_cast<RationalNumberType const>(
                    ConstantEvaluator(m_errorReporter).evaluate(*(_functionCall.arguments())[2])
                ))
                    if (lastArg->isZero())
                        m_errorReporter.typeError(
                            _functionCall.location(),
                            "Arithmetic modulo zero."
                        );
        }
    }
    return true;
}

bigint StaticAnalyzer::structureSizeEstimate(Type const& _type, set<StructDefinition const*>& _structsSeen)
{
    switch (_type.category())
    {
    case Type::Category::Array:
    {
        auto const& t = dynamic_cast<ArrayType const&>(_type);
        return structureSizeEstimate(*t.baseType(), _structsSeen) * (t.isDynamicallySized() ? 1 : t.length());
    }
    case Type::Category::Struct:
    {
        auto const& t = dynamic_cast<StructType const&>(_type);
        bigint size = 1;
        if (!_structsSeen.count(&t.structDefinition()))
        {
            _structsSeen.insert(&t.structDefinition());
            for (auto const& m: t.members(nullptr))
                size += structureSizeEstimate(*m.type, _structsSeen);
        }
        return size;
    }
    case Type::Category::Mapping:
    {
        return structureSizeEstimate(*dynamic_cast<MappingType const&>(_type).valueType(), _structsSeen);
    }
    default:
        break;
    }
    return bigint(1);
}