Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-06-07 09:18:00 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

libc: add instrument api support

Browse Source 
Add registration function instrumentation API,
which can achieve instrumentation of entering and
exiting functions through the compiler's functionality.

We can use CONFIG_ARCH_INSTRUMENT_ALL to add instrumentation for all
source, or add '-finstrument-functions' to CFLAGS for Part of the
source.

Notice:
1. use CONFIG_ARCH_INSTRUMENT_ALL must mark _start or entry noinstrument_function,
   becuase bss not set.
2. Make sure your callbacks are not instrumented recursively.

use instrument_register to register entry function and exit function.
They will be called by the instrumented function

Signed-off-by: anjiahao <anjiahao@xiaomi.com>
This commit is contained in:
anjiahao
2023-10-08 18:20:43 +08:00
committed by Xiang Xiao
parent 404616d621
commit 7dfbd14eba
37 changed files with 403 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/nuttx/instrument.h
+68
View File
@@ -0,0 +1,68 @@
/****************************************************************************
* include/nuttx/instrument.h
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*
****************************************************************************/
#ifndef __INCLUDE_NUTTX_INSTRUMENT_H
#define __INCLUDE_NUTTX_INSTRUMENT_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/compiler.h>
#include <nuttx/queue.h>
/****************************************************************************
* Public Types
****************************************************************************/
typedef CODE void (instrument_fun_t)(FAR void *this_fn,
FAR void *call_site,
FAR void *arg);
struct instrument_s
{
sq_entry_t entry;
FAR instrument_fun_t *enter;
FAR instrument_fun_t *leave;
FAR void *arg;
};
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: instrument_register
*
* Description: register instrument, it will be called
* when function enter or exit.
*
* Input Parameters:
* entry - instrument entry structure.
* Notice:
* use CONFIG_ARCH_INSTRUMENT_ALL must mark _start or entry
* noinstrument_function, becuase bss not set.
* Make sure your callbacks are not instrumented recursively.
*
****************************************************************************/
void instrument_register(FAR struct instrument_s *entry);
#endif /* __INCLUDE_NUTTX_INSTRUMENT_H */