transform插件用于修改POST請(qǐng)求的body和http響應(yīng)的body，可以理解為一個(gè)過濾器，或者nginx的body_filter。

有兩個(gè)地方可以添加transform回調(diào)函數(shù)，TS_HTTP_REQUEST_TRANSFORM_HOOK和TS_HTTP_RESPONSE_TRANSFORM_HOOK，分別是過濾POST請(qǐng)求的body和http響應(yīng)的body。在適當(dāng)?shù)膆ook點(diǎn)判斷是否需要使transform邏輯生效，需要的話在相應(yīng)的transform hook點(diǎn)添加回調(diào)函數(shù)。比如這樣一個(gè)場(chǎng)景，在緩存查詢結(jié)束的時(shí)候判斷查詢結(jié)果是hit還是miss，miss的話需要在http響應(yīng)body末尾添加一些內(nèi)容，這樣響應(yīng)的內(nèi)容連同被添加的內(nèi)容會(huì)當(dāng)成整個(gè)的響應(yīng)內(nèi)容被緩存住，后續(xù)的請(qǐng)求如果在緩存查詢結(jié)束判斷查詢結(jié)果是hit就會(huì)將transform后的結(jié)果響應(yīng)出去。

有兩個(gè)vio，input_vio(write vio)和output_vio(read vio)。每個(gè)vio都有配套的TSIOBuffer和TSIOBufferReader一起工作。

數(shù)據(jù)的流向是input_vio->分片插件->output_vio。transform插件對(duì)應(yīng)一個(gè)continuation和一個(gè)回調(diào)函數(shù)，假設(shè)這個(gè)回調(diào)函數(shù)叫plutin_handler，plutin_handler根據(jù)不同的event有不同的邏輯。分片插件每transform一些東西，都會(huì)觸發(fā)上游的TS_EVENT_VCONN_WRITE_READY事件通知上游可以繼續(xù)發(fā)送東西過來，并且觸發(fā)下游的TS_EVENT_IMMEDIATE事件通知下游有東西可以讀了。如果分片插件判斷已經(jīng)沒有數(shù)據(jù)需要繼續(xù)處理了，會(huì)觸發(fā)上游的TS_EVENT_VCONN_WRITE_COMPLETE事件，并且觸發(fā)下游的TS_EVENT_IMMEDIATE事件。或者可以這樣理解。整個(gè)流程分為三部分，上游，分片插件，下游。下游處理完數(shù)據(jù)會(huì)通過TSContCall觸發(fā)上游的TS_EVENT_VCONN_WRITE_READY或TS_EVENT_VCONN_WRITE_COMPLETE事件，上游準(zhǔn)備好了數(shù)據(jù)會(huì)通過TSVIOReenable觸發(fā)下游的TS_EVENT_IMMEDIATE事件。

ats插件的編譯：tsxs -o hello-world.so -c hello-world.c，注意tsxs要使用與其它可執(zhí)行文件配套一起生成的，不然的話會(huì)出錯(cuò)。

重點(diǎn)函數(shù)：

TSVConnWrite：

tsapi TSVIO TSVConnWrite(TSVConn connp, TSCont contp, TSIOBufferReader readerp, int64_t nbytes);

生成一個(gè)vio，有什么操作的話會(huì)觸發(fā)contp，要寫的字節(jié)數(shù)就是nbytes

TSVConnWriteVIOGet：

tsapi TSVIO TSVConnWriteVIOGet(TSVConn connp);

獲取一個(gè)VConnection的input_vio(write_vio)，VConnection是input_vio的實(shí)施者

TSVIOContGet:

tsapi TSCont TSVIOContGet(TSVIO viop);

獲取一個(gè)vio的continuation，continuation是vio的使用者，是transform的上游

TSTransformOutputVConnGet:

tsapi TSVConn TSTransformOutputVConnGet(TSVConn connp);

獲取一個(gè)下游的VConnection

TSVIONDoneGet：

tsapi TSIOBuffer TSVIOBufferGet(TSVIO viop);

獲取一個(gè)vio已經(jīng)操作完成的字節(jié)數(shù)

TSVIONBytesSet：

tsapi void TSVIONBytesSet(TSVIO viop, int64_t nbytes);

設(shè)置這個(gè)vio將要處理的字節(jié)數(shù)，第二個(gè)參數(shù)要比TSVIONDoneGet得到的結(jié)果大

TSVIONBytesGet:

tsapi int64_t TSVIONBytesGet(TSVIO viop);

獲取這個(gè)vio將要處理的字節(jié)數(shù)

TSIOBufferCopy：

tsapi int64_t TSIOBufferCopy(TSIOBuffer bufp, TSIOBufferReader readerp, int64_t length, int64_t offset);

將內(nèi)容從一個(gè)TSIOBufferReader拷貝到一個(gè)TSIOBuffer，拷貝的字節(jié)數(shù)是length，偏移量是offset

TSIOBufferReaderConsume：

tsapi void TSIOBufferReaderConsume(TSIOBufferReader readerp, int64_t nbytes);

拷貝操作結(jié)束后要執(zhí)行這個(gè)函數(shù)，要消費(fèi)input_vio指定字節(jié)數(shù)

TSVIONDoneSet：

tsapi void TSVIONDoneSet(TSVIO viop, int64_t ndone);

拷貝操作結(jié)束后要執(zhí)行這個(gè)函數(shù)，要告知input_vio已經(jīng)消費(fèi)了多少字節(jié)

TSVConnClosedGet：

tsapi int TSVConnClosedGet(TSVConn connp);

判斷connp是否已經(jīng)被關(guān)閉，connp是transform插件本身的contiuation

如下是一個(gè)完整的transform插件，實(shí)現(xiàn)的功能是在讀源站的響應(yīng)頭時(shí)添加transform插件。如果緩存查詢結(jié)果是hit則不需要回源，也就不會(huì)添加transform插件了。插件的邏輯是在響應(yīng)末尾添加"hello world\n"字符串。

#include?<limits.h> #include?<stdio.h> #include?<string.h> #include?<ts/ts.h>#define?ASSERT_SUCCESS(_x)?TSAssert?((_x)?==?TS_SUCCESS)typedef?struct?{TSVIO?output_vio;TSIOBuffer?output_buffer;TSIOBufferReader?output_reader;int?append_needed; }?MyData;static?TSIOBuffer?append_buffer; static?TSIOBufferReader?append_buffer_reader; static?int?append_buffer_length;static?MyData?* my_data_alloc()?{MyData?*data;data?=?(MyData?*)?TSmalloc(sizeof(MyData));TSReleaseAssert(data);data->output_vio?=?NULL;data->output_buffer?=?NULL;data->output_reader?=?NULL;data->append_needed?=?1;return?data; }static?void?my_data_destroy(MyData?*?data)?{if?(data)?{if?(data->output_buffer)TSIOBufferDestroy(data->output_buffer);TSfree(data);} }static?void?handle_transform(TSCont?contp)?{TSVConn?output_conn;TSVIO?write_vio;MyData?*data;int64_t?towrite;int64_t?avail;/*獲取transform插件的下游VConnection，這個(gè)VConnection會(huì)接收transform插件的處理完的數(shù)據(jù)這個(gè)VConnection會(huì)觸發(fā)contp的TS_EVENT_VCONN_WRITE_READY，TS_EVENT_VCONN_WRITE_COMPLETE或TS_EVENT_ERROR事件*/output_conn?=?TSTransformOutputVConnGet(contp);/*獲取input_vio，通過input_vio可以獲取到input_buffer*/write_vio?=?TSVConnWriteVIOGet(contp);/*獲取這個(gè)contp的數(shù)據(jù)，沒有的話初始化并且TSContDataSet*/data?=?TSContDataGet(contp);if?(!data)?{towrite?=?TSVIONBytesGet(write_vio);if?(towrite?!=?INT64_MAX)?{towrite?+=?append_buffer_length;}data?=?my_data_alloc();data->output_buffer?=?TSIOBufferCreate();data->output_reader?=?TSIOBufferReaderAlloc(data->output_buffer);/*獲取output_vio，并且指定要向其傳送的字節(jié)數(shù)，字節(jié)數(shù)就是http響應(yīng)body的長度加上"hello?world\n"的長度*/data->output_vio?=?TSVConnWrite(output_conn,?contp,?data->output_reader,?towrite);TSContDataSet(contp,?data);}/*如果input_buffer已經(jīng)為空，說明上游不會(huì)再有數(shù)據(jù)傳到transform插件*/if?(!TSVIOBufferGet(write_vio))?{if?(data->append_needed)?{data->append_needed?=?0;TSIOBufferCopy(TSVIOBufferGet(data->output_vio),?append_buffer_reader,?append_buffer_length,?0);}TSVIONBytesSet(data->output_vio,?TSVIONDoneGet(write_vio)?+?append_buffer_length);TSVIOReenable(data->output_vio);return;}/*獲取還有多少數(shù)據(jù)需要處理，也即還有多少東西會(huì)從上游發(fā)送來到transform插件*/towrite?=?TSVIONTodoGet(write_vio);if?(towrite?>?0)?{avail?=?TSIOBufferReaderAvail(TSVIOReaderGet(write_vio));if?(towrite?>?avail)?{towrite?=?avail;}if?(towrite?>?0)?{TSIOBufferCopy(TSVIOBufferGet(data->output_vio),?TSVIOReaderGet(write_vio),?towrite,?0);TSIOBufferReaderConsume(TSVIOReaderGet(write_vio),?towrite);TSVIONDoneSet(write_vio,?TSVIONDoneGet(write_vio)?+?towrite);}}/*獲取還有多少數(shù)據(jù)需要處理，也即還有多少東西會(huì)從上游發(fā)送來到transform插件*/if?(TSVIONTodoGet(write_vio)?>?0)?{/*如果上游還有數(shù)據(jù)需要傳送*/if?(towrite?>?0)?{/*通知下游可以讀數(shù)據(jù)了*/TSVIOReenable(data->output_vio);/*如果上游尚有數(shù)據(jù)會(huì)發(fā)送過來，需要通知上游可以繼續(xù)發(fā)送數(shù)據(jù)了*/TSContCall(TSVIOContGet(write_vio),?TS_EVENT_VCONN_WRITE_READY,?write_vio);}}else?{/*如果上游已經(jīng)沒有更多的數(shù)據(jù)，需要執(zhí)行append的邏輯了，也即將"hello?world\n"添加到響應(yīng)數(shù)據(jù)末尾*/if?(data->append_needed)?{data->append_needed?=?0;TSIOBufferCopy(TSVIOBufferGet(data->output_vio),?append_buffer_reader,?append_buffer_length,?0);}/*設(shè)置output_vio需要處理的字節(jié)數(shù)，這樣output_vio處理完這些內(nèi)容就可以發(fā)送TS_EVENT_VCONN_WRITE_COMPLETE給transform插件了*/TSVIONBytesSet(data->output_vio,?TSVIONDoneGet(write_vio)?+?append_buffer_length);/*通知下游可以讀數(shù)據(jù)了*/TSVIOReenable(data->output_vio);/*如果上游尚有數(shù)據(jù)會(huì)發(fā)送過來，需要通知上游可以繼續(xù)發(fā)送數(shù)據(jù)了*/TSContCall(TSVIOContGet(write_vio),?TS_EVENT_VCONN_WRITE_COMPLETE,?write_vio);} }static?int?append_transform(TSCont?contp,?TSEvent?event,?void?*edata)?{/*如果transform插件已經(jīng)被關(guān)閉，需要釋放資源*/if?(TSVConnClosedGet(contp))?{my_data_destroy(TSContDataGet(contp));TSContDestroy(contp);return?0;}?else?{switch?(event)?{case?TS_EVENT_ERROR:?{TSVIO?write_vio;write_vio?=?TSVConnWriteVIOGet(contp);/*通知上游出錯(cuò)了*/TSContCall(TSVIOContGet(write_vio),?TS_EVENT_ERROR,?write_vio);}break;case?TS_EVENT_VCONN_WRITE_COMPLETE:/*如果下游觸發(fā)了TS_EVENT_VCONN_WRITE_COMPLETE事件，需要關(guān)閉下游的VConnection*/TSVConnShutdown(TSTransformOutputVConnGet(contp),?0,?1);break;case?TS_EVENT_VCONN_WRITE_READY:default:handle_transform(contp);break;}}return?0; }static?int?transformable(TSHttpTxn?txnp)?{TSMBuffer?bufp;TSMLoc?hdr_loc;TSHttpStatus?resp_status;TSHttpTxnServerRespGet(txnp,?&bufp,?&hdr_loc);//判斷源站給的狀態(tài)碼，只有源站返回200時(shí)才會(huì)執(zhí)行transform邏輯if?(TS_HTTP_STATUS_OK?==?(resp_status?=?TSHttpHdrStatusGet(bufp,?hdr_loc)))?{ASSERT_SUCCESS(TSHandleMLocRelease(bufp,?TS_NULL_MLOC,?hdr_loc));return?1;}?else?{ASSERT_SUCCESS(TSHandleMLocRelease(bufp,?TS_NULL_MLOC,?hdr_loc));return?0;} }static?int?transform_plugin(TSCont?contp,?TSEvent?event,?void?*edata)?{TSHttpTxn?txnp?=?(TSHttpTxn)?edata;switch?(event)?{case?TS_EVENT_HTTP_READ_RESPONSE_HDR://只有緩存查詢結(jié)果為miss的時(shí)候才會(huì)回源，才會(huì)執(zhí)行這個(gè)case的邏輯if(transformable(txnp)){TSVConn?connp;connp?=?TSTransformCreate(append_transform,?txnp);TSHttpTxnHookAdd(txnp,?TS_HTTP_RESPONSE_TRANSFORM_HOOK,?connp);}TSHttpTxnReenable(txnp,?TS_EVENT_HTTP_CONTINUE);return?0;default:break;}return?0; }static?int?data_prepared()?{append_buffer?=?TSIOBufferCreate();append_buffer_reader?=?TSIOBufferReaderAlloc(append_buffer);TSIOBufferWrite(append_buffer,?"hello?world\n",?sizeof("hello?world\n")?-?1);append_buffer_length?=?TSIOBufferReaderAvail(append_buffer_reader);return?1; }int?check_ts_version()?{const?char?*ts_version?=?TSTrafficServerVersionGet();int?result?=?0;if?(ts_version)?{int?major_ts_version?=?0;int?minor_ts_version?=?0;int?patch_ts_version?=?0;if?(sscanf(ts_version,?"%d.%d.%d",?&major_ts_version,?&minor_ts_version,?&patch_ts_version)?!=?3)?{return?0;}if?(major_ts_version?>=?2)?{result?=?1;}}return?result; }void?TSPluginInit(int?argc,?const?char?*argv[])?{TSPluginRegistrationInfo?info;info.plugin_name?=?"append-transform";info.vendor_name?=?"MyCompany";info.support_email?=?"ts-api-support@MyCompany.com";if?(TSPluginRegister(TS_SDK_VERSION_3_0,?&info)?!=?TS_SUCCESS)?{TSError("Plugin?registration?failed.\n");goto?Lerror;}if?(!check_ts_version())?{TSError("Plugin?requires?Traffic?Server?3.0?or?later\n");goto?Lerror;}if?(!data_prepared())?{TSError("[append-transform]?Failed?to?prepared?data\n");goto?Lerror;}TSHttpHookAdd(TS_HTTP_READ_RESPONSE_HDR_HOOK,TSContCreate(transform_plugin,?NULL));return;Lerror:TSError("[append-transform]?Unable?to?initialize?plugin\n"); }

轉(zhuǎn)載于:https://blog.51cto.com/11490450/1876931

總結(jié)

以上是生活随笔為你收集整理的transform插件的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。