ThreadAPI.h

Go to the documentation of this file.

//===- ThreadAPI.h -- API for threads-----------------------------------------//
//
//                     SVF: Static Value-Flow Analysis
//
// Copyright (C) <2013-2017>  <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/>.
//
//===----------------------------------------------------------------------===//
 
/*
 * ThreadAPI.h
 *
 *  Created on: Jan 21, 2014
 *      Author: Yulei Sui, dye
 */
 
#ifndef THREADAPI_H_
#define THREADAPI_H_
 
#include "Util/GeneralType.h"
 
namespace SVF
{
 
class ICFGNode;
class CallICFGNode;
class SVFVar;
class ValVar;
class ObjVar;
class FunObjVar;
class PointerAnalysis;
 
/*
 * ThreadAPI class contains interfaces for pthread programs
 */
class ThreadAPI
{
 
public:
    enum TD_TYPE
    {
        TD_DUMMY = 0,   
        TD_FORK,        
        TD_JOIN,        
        TD_DETACH,      
        TD_ACQUIRE,     
        TD_TRY_ACQUIRE, 
        TD_RELEASE,     
        TD_EXIT,        
        TD_CANCEL,      
        TD_COND_WAIT,   
        TD_COND_SIGNAL, 
        TD_COND_BROADCAST,  
        TD_MUTEX_INI,       
        TD_MUTEX_DESTROY,   
        TD_CONDVAR_INI,     
        TD_CONDVAR_DESTROY, 
        TD_BAR_INIT,        
        TD_BAR_WAIT,        
        HARE_PAR_FOR
    };
 
    typedef Map<std::string, TD_TYPE> TDAPIMap;
 
private:
    TDAPIMap tdAPIMap;
 
    ThreadAPI ()
    {
        init();
    }
 
    void init();
 
    static ThreadAPI* tdAPI;
 
    TD_TYPE getType(const FunObjVar* F) const;
 
public:
    static ThreadAPI* getThreadAPI()
    {
        if(tdAPI == nullptr)
        {
            tdAPI = new ThreadAPI();
        }
        return tdAPI;
    }
 
    static void destroy()
    {
        if(tdAPI != nullptr)
        {
            delete tdAPI;
            tdAPI = nullptr;
        }
    }
 
 
 
    const ValVar* getForkedThread(const CallICFGNode *inst) const;
    const ValVar* getForkedFun(const CallICFGNode *inst) const;
 
    const ValVar* getActualParmAtForkSite(const CallICFGNode *inst) const;
 
    const SVFVar* getFormalParmOfForkedFun(const FunObjVar* F) const;
 
 
 
 
    bool isTDFork(const CallICFGNode *inst) const;
 
 
    bool isTDJoin(const CallICFGNode *inst) const;
 
 
 
    const SVFVar* getJoinedThread(const CallICFGNode *inst) const;
    const SVFVar* getRetParmAtJoinedSite(const CallICFGNode *inst) const;
 
    struct ForkJoinAliasCache
    {
        Map<const SVFVar*, NodeBS> joinedThreadObjects;
    };
 
    bool isAliasedForkJoin(PointerAnalysis* pta, const SVFVar* forkArg,
                           const SVFVar* joinArg) const;
    bool isAliasedForkJoin(PointerAnalysis* pta, const SVFVar* forkArg,
                           const SVFVar* joinArg, ForkJoinAliasCache& cache) const;
 
 
 
    bool isTDExit(const CallICFGNode *inst) const;
 
 
    bool isTDAcquire(const CallICFGNode* inst) const;
 
 
    bool isTDRelease(const CallICFGNode *inst) const;
 
 
 
    const SVFVar* getLockVal(const ICFGNode *inst) const;
 
 
    bool isTDBarWait(const CallICFGNode *inst) const;
 
    void performAPIStat();
    void statInit(Map<std::string, u32_t>& tdAPIStatMap);
};
 
} // End namespace SVF
 
#endif /* THREADAPI_H_ */