RTP 记录 log 该机制

我们 RCV 在这里，经常跑concurrent request RTP: Receiving Transaction Processor, 它主要是用来处理 RCV_TRANSACTIONS_INTERFACE 内的数据.

这个 concurrent program 里面包括很多文件, 比較重要的有:

ident RVCTP
RVCTP:
     $Header: rvctp.oc  120.0.12000000.1 2007/01/16 23:53:49 appldev ship $
     $Header: rvtbm.lpc 120.13.12010000.10 2013/03/15 02:51:16 zhlee ship $ 
     $Header: rvtpt.lpc 120.28.12010000.33 2013/07/15 07:12:37 smai ship $
     $Header: rvtvq.lpc 120.8.12010000.17 2013/04/03 11:40:30 wayin ship $
     $Header: rvtuq.lpc 120.9.12000000.7 2009/07/07 09:47:49 YUZZHANG01 ship $
     $Header: pouer.lpc 120.2 2006/06/14 07:57:02 arudas noship $
     $Header: rvtlo.lpc 120.1.12010000.7 2013/01/05 16:02:14 gke ship $
     $Header: rvtoc.lpc 120.1.12010000.5 2013/03/28 22:38:31 vthevark ship $
     $Header: rvtpa.lc  120.6.12010000.3 2009/07/07 08:58:22 ksivasa ship $
     $Header: rvtpd.lc  120.1.12010000.3 2009/07/07 09:03:17 ksivasa ship $
     $Header: rvtsh.lpc 120.10.12010000.3 2009/03/06 22:09:40 vthevark ship $
     $Header: rvtth.lpc 120.29.12010000.9 2012/05/30 15:50:03 gke ship $
     $Header: rvtvt.lpc 120.9.12010000.10 2013/03/28 18:19:11 vthevark ship $
     $Header: rvsco.lpc 120.4.12010000.12 2012/09/27 23:10:24 vthevark ship $
     $Header: rvsrv.lpc 120.4.12010000.16 2013/02/04 07:34:37 zhizheng ship $
     $Header: rvsit.lpc 120.5.12010000.6 2013/02/04 07:26:30 zhizheng ship $
     $Header: rvsdl.lpc 120.5.12010000.17 2011/11/28 05:19:19 xiameng ship $
     $Header: rvssh.lpc 120.2.12010000.3 2009/07/07 09:56:26 ksivasa ship $
     $Header: rvsut.lpc 120.3.12010000.14 2012/05/28 04:53:57 gke ship $
     $Header: rvtcl.lpc 120.6.12010000.3 2009/07/07 09:15:25 ksivasa ship $
     $Header: rvtii.lpc 120.19.12010000.27 2013/08/14 09:58:23 gke ship $
     $Header: rvtls.lpc 120.7.12010000.14 2012/01/30 12:31:22 ksivasa ship $
     $Header: rvtoo.lpc 120.3.12010000.3 2009/07/07 09:08:40 ksivasa ship $
     $Header: rvsrq.lpc 120.5.12010000.3 2009/07/07 09:53:56 ksivasa ship $
     $Header: rvspo.lpc 120.3.12010000.3 2009/07/07 09:53:12 ksivasa ship $

这些文件是在 RTP log 里面常常见到的. 这里我们主要看看, 在这些文件里是用如何的机制写 log 的.

首先, 要在要写日志的函数里面声明一个变量:

text     strbuf[BUFLEN+1];

然后用以下的语句:

    strcpy((char *)strbuf,"");
    sprintf((char *)strbuf,"RVTUQ:370 req_line_id %ld
", (long)req_line_id);
    Debug(strbuf,TRUE,TRUE);

第一句把 strbuf 清空, 然后把后面的字符串和整型数写入 strbuf, 第三句 Debug 把 strbuf 写入日志. Debug 后面有两个參数:

#define Debug(message,check_sql_error,no_rows_is_error)

第二个參数 check_sql_error 表示假设希望检查 SQL error, 就设为 TRUE, 否则设为 FALSE. no_rows_is_error 表示是不是把 NO_DATA_FOUND 当做一个 error. 假设是, 设为TRUE.

Concurrent Request 里面的文件都是 .c 的代码, 假设里面要写SQL, 就要写一句:

    EXEC SQL

然后以下写上 SQL. 这句 SQL 有可能会出错, 这时须要一个方法把错误消息写到 log 里面去. 比方:

       EXEC SQL
       select transaction_id,
              unit_of_measure
         into :parent_trx_id,
              :rec_uom
         from rcv_transactions
        where transaction_type in ('RECEIVE','MATCH')
        start with transaction_id = :p_trx_id 
   connect by transaction_id = prior parent_transaction_id;

为了捕获这句SQL 可能发生的错误, 我们在这句后面写一句:

pouersql("RVTUQ", "134", FALSE )

pouersql() 这个函数是在 pouer.lpc 文件 (po user error) 中定义的, 假设上面的SQL 发生了错误, 那么就会把 error message 写入 message stack. 而且返回 true.

这里面有三个參数, routine, location, no_rows_is_err.

routine 表示SQL 错误发生的文件名称, 上面的样例中是 RVTUQ.

location 表示SQL 错误发生的位置, 上面的样例中是 134. 这样我们看到日志里面的这个位置就非常easy定位到这句SQL.

no_rows_is_err 表示是不是把 NO_DATA_FOUND 当做 error 来处理. 上面的样例中我们没有当做 error.

在 pouersql 这个函数的内部, 会去sqlca 里面提取 sqlcode. sqlca 全称是: sql communications area, 是一个用来记录SQL 运行信息的地方. 每次运行一个SQL 都会返回 sqlcode. 假设sqlcode = 0, 那么表示没有错误. 假设 sqlcode > 0, 表示有exception, 假设 sqlcode < 0, 表示发生 error, 要rollback. 我们平时接触的error 都是小于0 的, 可是 NO_DATA_FOUND 是大于0 的, 代码 1403. pousersql() 函数会去 sqlca 里面提取 sqlcode, 然后推断是否 sqlcode < 0 还是 sqlcode > 0, 假设推断小于0, 那么才把错误消息写入 message stack. 假设大于0, 而且參数里面 no_rows_is_err 设为 TRUE, 那么也会写如message stack.

每次运行一次 SQL 就会更新一次 sqlca, 所以这个结构仅仅记录近期一次运行SQL 的信息 . 错误消息是记录在sqlca.sqlerrm.sqlerrmc 里面的. 所以会把这个里面的字符串写入message stack. 可是sqlerrmc 最多仅仅能记录70 个字符, 所以假设错误消息非常长的话, 就会被截断.

上面的SQL 错误发生的话, pouersql () 返回值为 TRUE. 那么在调用这个函数的地方, 比方 rvtpt.lpc 文件里, 就会捕捉到这个返回值, 推断返回值之后确定发生error 了, 就会调用:

pouertrace( "RVTUQ", "000", "rvtuqdebitmemo()" )

pouertrace () 这个函数也是在pouer.lpc 文件里定义的, 这个函数的返回值总是 false. 它的主要作用也是把错误消息写入 message stack. 三个參数分别为:

file: 表示错误发生的文件
location: 表示错误的位置
subroutine: 表示错误发生的函数.

上面我们提到, sqlerrmc 仅仅能保存70 个字符. 假设错误消息多余70 个字符, 想要得到全部的错误消息的话, 就须要用 sqlglm() 函数. 在使用这个函数之前, 我们要确保 sqlcode < 0, 否则取出来的错误消息是前面的SQL 的消息.

if (pouersql("RVTUQ","019",TRUE))
{                           
   char msg[510];
   size_t buf_len, msg_len;
   buf_len = sizeof (msg);
   sqlglm(msg, &buf_len, &msg_len);
                
   strcpy((char *)strbuf,"");
   sprintf((char *)strbuf,"RVTUQ:001 YU SQL ERROR %s 
", (text *) msg);
   Debug(strbuf,TRUE,TRUE);
   return( FALSE );
}

sqlglm() 函数把错误消息写入 msg, 然后仅仅要把 msg 用 Debug() 函数写入日志就能够了. sqlglm() 函数对字数也有限制, 最大为512 个字符. 相比 sqlerrmc 的70 个字符多非常多了.