SaberCheckerAPI.h

Go to the documentation of this file.

//===- SaberCheckerAPI.h -- API for checkers in Saber-------------------------//
//
//                     SVF: Static Value-Flow Analysis
//
// Copyright (C) <2013->  <Yulei Sui>
//
 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
 
// 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 Affero General Public License for more details.
 
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
//===----------------------------------------------------------------------===//
 
/*
 * SaberCheckerAPI.h
 *
 *  Created on: Apr 23, 2014
 *      Author: Yulei Sui
 */
 
#ifndef SABERCHECKERAPI_H_
#define SABERCHECKERAPI_H_
 
#include "Util/SVFUtil.h"
#include "Graphs/ICFGNode.h"
#include "SVFIR/SVFVariables.h" // add header
 
namespace SVF
{
 
/*
 * Saber Checker API class contains interfaces for various bug checking
 * memory leak detection e.g., alloc free
 * incorrect file operation detection, e.g., fopen, fclose
 */
class SaberCheckerAPI
{
 
public:
    enum CHECKER_TYPE
    {
        CK_DUMMY = 0,       
        CK_ALLOC,       
        CK_FREE,      
        CK_FOPEN,       
        CK_FCLOSE       
    };
 
    typedef Map<std::string, CHECKER_TYPE> TDAPIMap;
 
private:
    TDAPIMap tdAPIMap;
 
    SaberCheckerAPI ()
    {
        init();
    }
 
    void init();
 
    static SaberCheckerAPI* ckAPI;
 
    inline CHECKER_TYPE getType(const FunObjVar* F) const
    {
        if(F)
        {
            TDAPIMap::const_iterator it= tdAPIMap.find(F->getName());
            if(it != tdAPIMap.end())
                return it->second;
        }
        return CK_DUMMY;
    }
 
public:
    static SaberCheckerAPI* getCheckerAPI()
    {
        if(ckAPI == nullptr)
        {
            ckAPI = new SaberCheckerAPI();
        }
        return ckAPI;
    }
 
 
    inline bool isMemAlloc(const FunObjVar* fun) const
    {
        return getType(fun) == CK_ALLOC;
    }
    inline bool isMemAlloc(const CallICFGNode* cs) const
    {
        return isMemAlloc(cs->getCalledFunction());
    }
 
 
    inline bool isMemDealloc(const FunObjVar* fun) const
    {
        return getType(fun) == CK_FREE;
    }
    inline bool isMemDealloc(const CallICFGNode* cs) const
    {
        return isMemDealloc(cs->getCalledFunction());
    }
 
 
    inline bool isFOpen(const FunObjVar* fun) const
    {
        return getType(fun) == CK_FOPEN;
    }
    inline bool isFOpen(const CallICFGNode* cs) const
    {
        return isFOpen(cs->getCalledFunction());
    }
 
 
    inline bool isFClose(const FunObjVar* fun) const
    {
        return getType(fun) == CK_FCLOSE;
    }
    inline bool isFClose(const CallICFGNode* cs) const
    {
        return isFClose(cs->getCalledFunction());
    }
 
};
 
} // End namespace SVF
 
#endif /* SABERCHECKERAPI_H_ */