op_stat_reg()
摘要
返回一个可在进程模型内引用节点或模块统计量(局部或全局)的句柄。
语法
op_stat_reg (stat_name, stat_index, type)
| 参数 | 类型 | 说明 |
|---|---|---|
group_dot_stat_name |
const char* |
需要获取句柄的统计量的组名和名称,两者以句点分隔。 |
stat_index |
int |
目标统计量的数字索引;若统计量没有维度,则用 OPC_STAT_INDEX_NONE。参见表 79“Statistic Index Symbolic Constants“(第 24 页)。 |
type |
int |
全局统计量用 OPC_STAT_GLOBAL,局部统计量用 OPC_STAT_LOCAL。参见表 80“Statistic Type Symbolic Constants“(第 24 页)。 |
返回类型
Stathandle
可用于调用内核过程 op_stat_write() 和 op_stat_write_t() 的统计量句柄。
示例
/* register HTTP-related statistics. */
app_mgr_state_ptr->HTTP_NUM_PAGES = op_stat_reg("Client Http.Downloaded Pages",
OPC_STAT_INDEX_NONE, OPC_STAT_LOCAL);
app_mgr_state_ptr->HTTP_NUM_OBJECTS = op_stat_reg("Client Http.Downloaded Objects",
OPC_STAT_INDEX_NONE, OPC_STAT_LOCAL);
app_mgr_state_ptr->HTTP_ABORT_ACCOUNT =
op_stat_reg("Client Http.User Cancelled Connections", OPC_STAT_INDEX_NONE,
OPC_STAT_LOCAL);
/* The page response stat has been added recently to measure the time elapsed */
/* in completing the page request and getting its response. Earlier only the */
/* object response time was measured. */
app_mgr_state_ptr->HTTP_PAGE_RESPONSE_TIME =
op_stat_reg("Client Http.Page Response Time(sec)", OPC_STAT_INDEX_NONE,
OPC_STAT_LOCAL);
app_mgr_state_ptr->GLOBAL_HTTP_PAGE_RESP_TIME =
op_stat_reg("Http.Page Response Time (sec)", OPC_STAT_INDEX_NONE,
OPC_STAT_GLOBAL);
详情
该过程与 op_stat_obj_reg() 类似。主要区别在于:该过程只能在进程模块上下文中使用,并且可以注册局部和全局两种统计量。
仿真内核集中管理全局和局部统计量。每个统计量都维护一个组名、名称、索引、类型和输出向量。用户在首次通过 op_stat_reg() 注册统计量时指定其组名、名称、索引和类型。此后以已注册的组名和名称再次调用该内核过程,将与先前注册时创建的统计量“会合”(rendezvous),并返回同一个句柄。这使得多个进程可以访问同一个统计量,前提是它们有某种围绕名称同步的机制。同一模块内的进程可以在同一个局部统计量上会合。任何进程都可以在同一个全局统计量上会合。
维度化统计量提供一组输出统计量。Stathandle 指由索引指定的该组中的元素。对于无维度的统计量,索引值必须使用符号常量 OPC_STAT_INDEX_NONE。
全局统计量的一个典型例子是:模型中的所有进程共享一个输出向量,记录各自测量的端到端时延值。这与每个进程使用局部统计量记录自己的输出向量形成对比。
注册统计量需要根据名称和组在现有统计量集合中进行搜索。为了提升性能,每个用户应当只注册一次统计量,并把得到的统计量句柄缓存起来(例如存放在状态变量中)供后续使用。
用途
统计量注册为多个进程提供了一种机制,使其能够共享同一个输出向量来记录仿真度量。通过注册获得对统计量的访问后,进程只需围绕统计量名称进行协调。这一机制的独特优点在于能够轻松避免独立开发的模型之间的冲突。该函数返回一个统计量句柄,通过内核过程 op_stat_write() 和 op_stat_write_t() 向统计量写入新值时需要该句柄。
错误
- 程序中止(Program Abort):段错误。(由于无效或格式错误的
stat_name参数) - 可恢复错误(Recoverable Error):无法注册局部或全局统计量(
<stat_name>)。(由于统计量未声明) - 可恢复错误(Recoverable Error):无法注册统计量(
<stat_name>)。(由于可用内存不足) - 程序中止(Program Abort):该内核过程需要进程上下文。
- 可恢复错误(Recoverable Error):统计量索引(
<stat_index>)超出范围。
参考
- 使用内核过程 op_stat_obj_reg() 访问任何链路、路径、模块或子模块对象的统计量
- 使用内核过程 op_stat_write() 向输出统计量写入值,并以当前仿真时间标记
- 使用内核过程 op_stat_write_t() 向输出统计量写入值,并以指定仿真时间标记
- 使用内核过程 op_stat_scalar_write() 向标量统计量写入值