TarsCpp/servant/libservant/ServantHandle.cpp

/**
 * Tencent is pleased to support the open source community by making Tars available.
 *
 * Copyright (C) 2016THL A29 Limited, a Tencent company. All rights reserved.
 *
 * Licensed under the BSD 3-Clause License (the "License"); you may not use this file except 
 * in compliance with the License. You may obtain a copy of the License at
 *
 * https://opensource.org/licenses/BSD-3-Clause
 *
 * Unless required by applicable law or agreed to in writing, software distributed 
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR 
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the 
 * specific language governing permissions and limitations under the License.
 */

#include "util/tc_thread_pool.h"
#include "util/tc_timeprovider.h"
#include "servant/ServantHandle.h"
#include "servant/Application.h"
#include "servant/ServantHelper.h"
#include "servant/AppProtocol.h"
#include "servant/BaseF.h"
#include "servant/KeepAliveNodeF.h"
#include "servant/Cookie.h"
#include "servant/Application.h"
#include "servant/KeepAliveNodeF.h"
// #ifdef TARS_OPENTRACKING
// #include "servant/text_map_carrier.h"
// #endif

namespace tars
{

/////////////////////////////////////////////////////////////////////////
//
ServantHandle::ServantHandle(Application *application)
: _application(application)
{
    
}

ServantHandle::~ServantHandle()
{
    {
        try
        {
			if(_servant)
			{
				_servant->destroy();
			}
        }
        catch(exception &ex)
        {
            TLOGERROR("[ServantHandle::destroy error:" << ex.what() << "]" << endl);
        }
        catch(...)
        {
            TLOGERROR("[ServantHandle::destroy unknown exception error]" << endl);
        }
    }
}

void ServantHandle::handleAsyncResponse()
{
    ReqMessagePtr resp;

	while (_servant->getResponseQueue().pop_front(resp))
	{
		try
		{
			if (resp->response->iRet == TARSSERVERSUCCESS)
			{
				_servant->doResponse(resp);
			}
			else if (resp->pObjectProxy == NULL)
			{
				_servant->doResponseNoRequest(resp);
			}
			else
			{
				_servant->doResponseException(resp);
			}
		}
		catch (exception& e)
		{
			TLOGERROR("[ServantHandle::doResponse ex:" << e.what() << "]" << endl);
		}
		catch (...)
		{
			TLOGERROR("[ServantHandle::doResponse error]" << endl);
		}
	}

	//业务处理附加的自有消息
	try
	{
		_servant->doCustomMessage(false);
		_servant->doCustomMessage();
	}
	catch (exception& e)
	{
		TLOGERROR("[ServantHandle::doCustemMessage ex:" << e.what() << "]" << endl);
	}
	catch (...)
	{
		TLOGERROR("[ServantHandle::doCustemMessage ex.]" << endl);
	}
}

void ServantHandle::handleCustomMessage(bool bExpectIdle)
{
    {
        //业务处理附加的自有消息
        try
        {
			_servant->doCustomMessage(bExpectIdle);
			_servant->doCustomMessage();
        }
        catch (exception& e)
        {
            TLOGERROR("[ServantHandle::doCustemMessage ex:" << e.what() << "]" << endl);
        }
        catch (...)
        {
            TLOGERROR("[ServantHandle::doCustemMessage ex.]" << endl);
        }
    }
}

bool ServantHandle::allFilterIsEmpty()
{
	{
		if (!_servant->getResponseQueue().empty())
		{
			return false;
		}
	}
	return true;
}

void ServantHandle::initialize()
{
	if(TC_CoroutineScheduler::scheduler())
	{
		ServantProxyThreadData::getData()->_sched = TC_CoroutineScheduler::scheduler();
	}

    _servant = _application->getServantHelper()->create(_bindAdapter->getName());

	if (!_servant)
	{
		if(_application->applicationConfig().checkBindAdapter)
		{
			TLOGERROR("[ServantHandle initialize createServant ret null, for adapter `" + _bindAdapter->getName() + "`]"
					<< endl);
			cerr << "ServantHandle initialize createServant ret null, for adapter `" + _bindAdapter->getName() + "`]"
				 << endl;

			RemoteNotify::getInstance()->report(
					"initialize createServant error: no adapter:" + _bindAdapter->getName());

			TC_Common::msleep(100);

			exit(-1);
		}
		else
		{
			return;
		}
	}

	try
	{
		_servant->setHandle(this);

		_servant->initialize();

		TLOGTARS("[" << _servant->getName() << " initialize]" << endl);
	}
	catch(exception &ex)
	{
		TLOGERROR("[initialize error:" << ex.what() << "]" << endl);

		RemoteNotify::getInstance()->report("initialize error:" + string(ex.what()));

		TC_Common::msleep(100);

		exit(-1);
	}
	catch(...)
	{
		TLOGERROR("[initialize unknown exception error]" << endl);

		RemoteNotify::getInstance()->report("initialize unknown exception error");

		TC_Common::msleep(100);

		exit(-1);
	}
}

void ServantHandle::heartbeat()
{
	time_t fcur = TNOW;

	if (abs(fcur - _bindAdapter->getHeartBeatTime()) > HEART_BEAT_INTERVAL)
	{
		_bindAdapter->setHeartBeatTime(fcur);

		this->_application->getNodeHelper()->keepAlive(_bindAdapter->getName());
//        TARS_KEEPALIVE(_bindAdapter->getName());

		//上报连接数 比率
		if (_bindAdapter->_pReportConRate)
		{
			_bindAdapter->_pReportConRate->report((int)(_bindAdapter->getNowConnection() * 1000 / _bindAdapter->getMaxConns()));
		}

		//有队列, 且队列长度>0才上报
		if (_bindAdapter->_pReportQueue)
		{
			_bindAdapter->_pReportQueue->report((int)_bindAdapter->getRecvBufferSize());
		}
	}
}

CurrentPtr ServantHandle::createCurrent(const shared_ptr<TC_EpollServer::RecvContext> &data)
{
	CurrentPtr current = new Current(this);

    try
    {
        current->initialize(data);
    }
    catch (TarsDecodeException &ex)
    {
        TLOGERROR("[ServantHandle::handle request protocol decode error:" << ex.what() << "]" << endl);
        close(data);
        return NULL;
    }

    //只有TARS协议才处理
    if(current->getBindAdapter()->isTarsProtocol())
    {
        int64_t now = TNOWMS;

		//数据在队列中的时间超过了客户端等待的时间(TARS协议)
		if (current->_request.iTimeout > 0 && (now - data->recvTimeStamp()) > current->_request.iTimeout)
		{
			//上报超时数目
			if (data->adapter()->_pReportTimeoutNum) 
				data->adapter()->_pReportTimeoutNum->report(1);

            TLOGERROR("[TARS][ServantHandle::handle queue timeout:"
                         << current->_request.sServantName << ", func:"
                         << current->_request.sFuncName << ", recv time:"
                         << data->recvTimeStamp()  << ", queue timeout:"
                         << data->adapter()->getQueueTimeout() << ", timeout:"
                         << current->_request.iTimeout << ", now:"
                         << now << ", ip:" << data->ip() << ", port:" << data->port() << "]" << endl);

            current->sendResponse(TARSSERVERQUEUETIMEOUT);

			return NULL;
		}
	}

	return current;
}

CurrentPtr ServantHandle::createCloseCurrent(const shared_ptr<TC_EpollServer::RecvContext> &data)
{
	CurrentPtr current = new Current(this);

	current->initializeClose(data);
	current->setReportStat(false);
	current->setCloseType(data->closeType());
	return current;
}

void ServantHandle::handleClose(const shared_ptr<TC_EpollServer::RecvContext> &data)
{
    TLOGTARS("[ServantHandle::handleClose,adapter:" << data->adapter()->getName() << ",peer:" << data->ip() << ":" << data->port() << "]"<< endl);

	CurrentPtr current = createCloseCurrent(data);

	try
	{
		//业务逻辑处理
		_servant->doClose(current);
	}
	catch (exception& ex)
	{
		TLOGERROR("[TARS]ServantHandle::handleClose " << ex.what() << endl);

		return;
	}
	catch (...)
	{
		TLOGERROR("[TARS]ServantHandle::handleClose unknown error" << endl);

		return;
	}
}

void ServantHandle::handleTimeout(const shared_ptr<TC_EpollServer::RecvContext> &data)
{
	CurrentPtr current = createCurrent(data);

	if (!current) return;

    //上报超时数目
    if(data->adapter()->_pReportTimeoutNum)
        data->adapter()->_pReportTimeoutNum->report(1);

    TLOGERROR("[ServantHandle::handleTimeout adapter '"
                 << data->adapter()->getName()
                 << "', recvtime:" << data->recvTimeStamp() << "|"
                 << ", timeout:" << data->adapter()->getQueueTimeout()
                 << ", id:" << current->getRequestId() << "]" << endl);

    if (current->getBindAdapter()->isTarsProtocol())
    {
        current->sendResponse(TARSSERVERQUEUETIMEOUT);
    }
}

void ServantHandle::handleOverload(const shared_ptr<TC_EpollServer::RecvContext> &data)
{
	CurrentPtr current = createCurrent(data);

	if (!current) return;

    TLOGERROR("[ServantHandle::handleOverload adapter '"
                 << data->adapter()->getName()
                 << "',overload:-1,queue capacity:"
                 << data->adapter()->getQueueCapacity()
                 << ",id:" << current->getRequestId() << "]" << endl);

    if (current->getBindAdapter()->isTarsProtocol())
    {
        current->sendResponse(TARSSERVEROVERLOAD);
    }
}

void ServantHandle::handle(const shared_ptr<TC_EpollServer::RecvContext> &data)
{
	CurrentPtr current = createCurrent(data);

	if (!current) return;

    if (current->getBindAdapter()->isTarsProtocol())
    {
        handleTarsProtocol(current);
    }
    else
    {
        handleNoTarsProtocol(current);
    }
}


// #ifdef TARS_OPENTRACKING
// void ServantHandle::processTracking(const TarsCurrentPtr &current)
// {
//     if(!(Application::getCommunicator()->_traceManager))
//     {
//         return;
//     }
//     ServantProxyThreadData * sptd = ServantProxyThreadData::getData();
//     assert(sptd);

//     if(!sptd)
//     {
//         return;
//     }

//     //提取packet中的span信息，更新为被调的span信息后设置到sptd->_trackInfoMap;
//     sptd->_trackInfoMap.clear();
    
//     if (IS_MSG_TYPE(current->getMessageType(), tars::TARSMESSAGETYPETRACK))
//     {
//         map<string, string>::const_iterator trackinfoIter = current->getRequestStatus().find(ServantProxy::STATUS_TRACK_KEY);
//         TLOGTARS("[TARS] servant got a tracking request, message_type set" << current->getMessageType() << endl);
//         if (trackinfoIter != current->getRequestStatus().end())
//         {
//             TLOGTARS("[TARS] servant got a tracking request, tracking key:" << trackinfoIter->second << endl);
//             string context = trackinfoIter->second;
//             char szBuffer[context.size() + 1];
//             memset(szBuffer, 0x00, context.size() + 1);
//             memcpy(szBuffer, context.c_str(), context.size());
            
//             std::unordered_map<std::string, std::string> text_map;
//             write_span_context(text_map, szBuffer);

//             TextMapCarrier carrier(text_map);
//             auto tracer = Application::getCommunicator()->_traceManager->_tracer;
//             auto span_context_maybe = tracer->Extract(carrier);
//             if(!span_context_maybe)
//             {
//                 //error
//                 TLOGERROR("[TARS] servant got a tracking request, but extract the span context fail");
//                 return ;
//             }

//             string funcName = current->getFuncName();
//             auto child_span = tracer->StartSpan(funcName, {opentracing::ChildOf(span_context_maybe->get())});
            
//             //text_map.clear();
//             auto err = tracer->Inject(child_span->context(), carrier);
//             assert(err);

//             sptd->_trackInfoMap = text_map;

//             _spanMap[current->getRequestId()].reset(child_span.release());

//             return ;

//         }
//     }

//     return ;

// }


// void ServantHandle::finishTracking(int ret, const TarsCurrentPtr &current)
// {
//     int requestId = current->getRequestId();
    
//     if(_spanMap.find(requestId) != _spanMap.end())
//     {
//         auto spanIter = _spanMap.find(requestId);
//         spanIter->second->SetTag("Retcode", ret);
//         spanIter->second->Finish();

//         _spanMap.erase(requestId);
//     }
// }

// #endif

bool ServantHandle::processDye(const CurrentPtr &current, string& dyeingKey)
{
	//当前线程的线程数据
	ServantProxyThreadData *sptd = ServantProxyThreadData::getData();

	if (sptd)
	{
		sptd->_data._dyeingKey = "";
	}

    //当前请求已经被染色, 需要打印染色日志
    map<string, string>::const_iterator dyeingIt = current->getRequestStatus().find(ServantProxy::STATUS_DYED_KEY);

    if (IS_MSG_TYPE(current->getMessageType(), tars::TARSMESSAGETYPEDYED))
    {
        TLOGTARS("[servant got a dyeing request, message_type set: " << current->getMessageType() << "]" << endl);

        if (dyeingIt != current->getRequestStatus().end())
        {
            TLOGTARS("[servant got a dyeing request, dyeing key: " << dyeingIt->second << "]" << endl);

            dyeingKey = dyeingIt->second;
        }
        return true;
    }

	//servant已经被染色, 开启染色日志
	if (_application->getServantHelper()->isDyeing())
	{
		map<string, string>::const_iterator dyeingKeyIt = current->getRequestStatus().find(ServantProxy::STATUS_GRID_KEY);

		if (dyeingKeyIt != current->getRequestStatus().end() &&
			_application->getServantHelper()->isDyeingReq(dyeingKeyIt->second, current->getServantName(), current->getFuncName()))
		{
			TLOGTARS("[TARS] dyeing servant got a dyeing req, key:" << dyeingKeyIt->second << endl);

			dyeingKey = dyeingKeyIt->second;

			return true;
		}
	}

	return false;
}

bool ServantHandle::processTrace(const CurrentPtr &current)
{
    //当前线程的线程数据
    ServantProxyThreadData* sptd = ServantProxyThreadData::getData();

    if (sptd)
    {
        sptd->_traceCall = false;
        sptd->_traceContext.reset();
    }

    // 如果调用链需要追踪，需要初始化线程私有追踪参数
    map<string, string>::const_iterator traceIt = current->getRequestStatus().find(ServantProxy::STATUS_TRACE_KEY);

    if (IS_MSG_TYPE(current->getMessageType(), tars::TARSMESSAGETYPETRACE))
    {
        TLOGTARS("[TARS] servant got a trace request, message_type set " << current->getMessageType() << endl);

        if (traceIt != current->getRequestStatus().end())
        {
            TLOGTARS("[TARS] servant got a trace request, trace key:" << traceIt->second << endl);

            if (sptd->initTrace(traceIt->second))
            {
                sptd->_traceCall = true;
                return true;
            }
            else
            {
                TLOGTARS("[TARS] servant got a trace request, but trace key is error:" << traceIt->second << endl);
            }
        }
    }
    return false;
}

bool ServantHandle::processCookie(const CurrentPtr &current, map<string, string> &cookie)
{
	const static string STATUS = "STATUS_";

	std::for_each(current->getRequestStatus().begin(), current->getRequestStatus().end(),[&](const map<string, string>::value_type& p){
		if(p.first.size() > STATUS.size() && TC_Port::strncasecmp(p.first.c_str(), STATUS.c_str(), STATUS.size()) == 0) {
			return;
		}
		cookie.insert(make_pair(p.first, p.second));
	});

	return !cookie.empty();
}

bool ServantHandle::checkValidSetInvoke(const CurrentPtr &current)
{
	/*是否允许检查合法性*/
	if (_application->applicationConfig().isCheckSet == 0)
	{
		//不检查
		return true;
	}

	auto clientConfig = _application->getThisCommunicator()->clientConfig();
    bool isSetInvoke = IS_MSG_TYPE(current->getMessageType(), tars::TARSMESSAGETYPESETNAME);
    //客户端按set规则调用且服务端启用set
    if (isSetInvoke && clientConfig.SetOpen)
    {
        /**
         * 合法性规则:
         * 1 客户端set名称与服务端set在同一分组,eg, test.s.1 <-> test.s.1
         * 2 客户端set名称与服务端set在同一地区,eg, test.s.* <-> test.s.1 | test.s.2 | test.s.*
         * 3 客户端set名称与服务端set属于不同名称,eg,test1.s.1 <->test2.n.2
         * 4 1,2,3条件都不满足，则认为该调用不合法
         */
        map<string, string>::const_iterator setIt = current->getRequestStatus().find(ServantProxy::STATUS_SETNAME_VALUE);
        string sSetName("");

        if (setIt != current->getRequestStatus().end())
        {
            TLOGTARS("[servant got a setname request, setname key:" << setIt->second << "]" << endl);

			sSetName = setIt->second;

            if (clientConfig.SetDivision == sSetName)
            {
                return true;
            }
            else
            {
                //属于同一地区是也属于合法调用
                string setArea1 = clientConfig.SetDivision.substr(0, clientConfig.SetDivision.find_last_of("."));
                string setArea2 = sSetName.substr(0,sSetName.find_last_of("."));
                if (setArea1 == setArea2)
                {
                    return true;
                }
                else if (clientConfig.SetDivision.substr(0, clientConfig.SetDivision.find_first_of(".")) !=
                         sSetName.substr(0,sSetName.find_first_of(".")))
                {
                    //属于不同的set之间调用也属于合法
                    return true;
                }
                else
                {
                    TLOGERROR("[ServantHandle::checkValidSetInvoke|"
                            << current->getIp() << "|"
                            << current->getMessageType() << "|"
                            << current->getServantName() << "|"
                            << current->getFuncName() << "|client:"
                            << clientConfig.SetDivision << "|server:"
                            << sSetName << "]" << endl);
                    current->sendResponse(TARSINVOKEBYINVALIDESET);
                    return false;
                }
            }
        }
        else
        {
            TLOGERROR("[ServantHandle::checkValidSetInvoke|"
                            << current->getIp() << "|"
                            << current->getMessageType() << "|"
                            << current->getServantName() << "|"
                            << current->getFuncName() << "|client:"
                            << clientConfig.SetDivision << "|server:"
                            << sSetName << "]" << endl);
            current->sendResponse(TARSINVOKEBYINVALIDESET);
            return false;
        }
    }

	//没有按set规则调用
	return true;
}

void ServantHandle::handleTarsProtocol(const CurrentPtr &current)
{
    TLOGTARS("[ServantHandle::handleTarsProtocol servant:" << _servant->getName()
				<< ", ip: " << current->getIp() << ":" << current->getPort()
				<< ", message: " << current->getMessageType()
				<< ", servant: " << current->getServantName()
				<< ", func:" << current->getFuncName()
				<< ", requestId: " << current->getRequestId()
				<< ", status:" << TC_Common::tostr(current->getRequestStatus()) << "]"<<endl);

	//检查set调用合法性
	if (!checkValidSetInvoke(current))
	{
		return;
	}

    //处理染色消息
    string dyeingKey = "";
    TarsDyeingSwitch dyeSwitch;
    if (processDye(current, dyeingKey))
    {
        dyeSwitch.enableDyeing(dyeingKey);
    }

    processTrace(current);

	//处理cookie
	map<string, string> cookie;
	CookieOp cookieOp;
	if (processCookie(current, cookie))
	{
		cookieOp.setCookie(cookie);
		current->setCookie(cookie);
	}

	ResponsePacket response;
	try
	{
		if (_servant->getName() != current->getServantName())
		{
			response.iRet = _servant->doNoServant(current, response.sBuffer);
		}
		else
		{
			//业务逻辑处理
			response.iRet = _servant->dispatch(current, response.sBuffer);
		}
	}
	catch (TarsDecodeException& ex)
	{
		TLOGERROR("[ServantHandle::handleTarsProtocol " << _servant->getName() << ", error:" << ex.what() << "]" << endl);

		response.iRet = TARSSERVERDECODEERR;

		response.sResultDesc = ex.what();
	}
	catch (TarsEncodeException& ex)
	{
		TLOGERROR("[ServantHandle::handleTarsProtocol " << _servant->getName() << ", error:" << ex.what() << "]" << endl);

		response.iRet = TARSSERVERENCODEERR;

		response.sResultDesc = ex.what();
	}
	catch (exception& ex)
	{
		TLOGERROR("[ServantHandle::handleTarsProtocol " << _servant->getName() << ", error:" << ex.what() << "]" << endl);

		response.iRet = TARSSERVERUNKNOWNERR;

		response.sResultDesc = ex.what();
	}
	catch (...)
	{
		TLOGERROR("[ServantHandle::handleTarsProtocol " << _servant->getName() << ", unknown error]"<< endl);

		response.iRet = TARSSERVERUNKNOWNERR;

		response.sResultDesc = "handleTarsProtocol unknown exception error";
	}

	if (response.iRet == TARSSERVERNOFUNCERR)
	{
		response.iRet = _servant->doNoFunc(current, response.sBuffer);
	}

    //单向调用或者业务不需要同步返回
    if (current->isResponse())
    {
        current->sendResponse(response);
    }

//#ifdef TARS_OPENTRACKING
//    finishTracking(ret, current);
//#endif
}

void ServantHandle::handleNoTarsProtocol(const TarsCurrentPtr &current)
{
    TLOGTARS("[ServantHandle::handleNoTarsProtocol current:"
        << current->getIp() << "|"
        << current->getPort() << "|"
        << current->getServantName() << "]" << endl);

	vector<char> buffer;

    try
    {
        //业务逻辑处理
		_servant->dispatch(current, buffer);
    }
    catch(exception &ex)
    {
        TLOGERROR("[ServantHandle::handleNoTarsProtocol " << ex.what() << "]" << endl);
    }
    catch(...)
    {
        TLOGERROR("[ServantHandle::handleNoTarsProtocol unknown error]" << endl);
    }

	if (current->isResponse() && !buffer.empty())
	{
		current->sendResponse((const char *)(buffer.data()), (uint32_t)buffer.size());
	}
}

////////////////////////////////////////////////////////////////////////////
}