Remarks.h

Go to the documentation of this file.

/*===-- llvm-c/Remarks.h - Remarks Public C Interface -------------*- C -*-===*\
|*                                                                            *|
|* Part of the LLVM Project, under the Apache License v2.0 with LLVM          *|
|* Exceptions.                                                                *|
|* See https://llvm.org/LICENSE.txt for license information.                  *|
|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception                    *|
|*                                                                            *|
|*===----------------------------------------------------------------------===*|
|*                                                                            *|
|* This header provides a public interface to a remark diagnostics library.   *|
|* LLVM provides an implementation of this interface.                         *|
|*                                                                            *|
\*===----------------------------------------------------------------------===*/
 
#ifndef LLVM_C_REMARKS_H
#define LLVM_C_REMARKS_H
 
#include "llvm-c/ExternC.h"
#include "llvm-c/Types.h"
#ifdef __cplusplus
#include <cstddef>
#else
#include <stddef.h>
#endif /* !defined(__cplusplus) */
 
LLVM_C_EXTERN_C_BEGIN
 
// 0 -> 1: Bitstream remarks support.
#define REMARKS_API_VERSION 1
 
enum LLVMRemarkType {
  LLVMRemarkTypeUnknown,
  LLVMRemarkTypePassed,
  LLVMRemarkTypeMissed,
  LLVMRemarkTypeAnalysis,
  LLVMRemarkTypeAnalysisFPCommute,
  LLVMRemarkTypeAnalysisAliasing,
  LLVMRemarkTypeFailure
};
 
typedef struct LLVMRemarkOpaqueString *LLVMRemarkStringRef;
 
extern const char *LLVMRemarkStringGetData(LLVMRemarkStringRef String);
 
extern uint32_t LLVMRemarkStringGetLen(LLVMRemarkStringRef String);
 
typedef struct LLVMRemarkOpaqueDebugLoc *LLVMRemarkDebugLocRef;
 
extern LLVMRemarkStringRef
LLVMRemarkDebugLocGetSourceFilePath(LLVMRemarkDebugLocRef DL);
 
extern uint32_t LLVMRemarkDebugLocGetSourceLine(LLVMRemarkDebugLocRef DL);
 
extern uint32_t LLVMRemarkDebugLocGetSourceColumn(LLVMRemarkDebugLocRef DL);
 
typedef struct LLVMRemarkOpaqueArg *LLVMRemarkArgRef;
 
extern LLVMRemarkStringRef LLVMRemarkArgGetKey(LLVMRemarkArgRef Arg);
 
extern LLVMRemarkStringRef LLVMRemarkArgGetValue(LLVMRemarkArgRef Arg);
 
extern LLVMRemarkDebugLocRef LLVMRemarkArgGetDebugLoc(LLVMRemarkArgRef Arg);
 
typedef struct LLVMRemarkOpaqueEntry *LLVMRemarkEntryRef;
 
extern void LLVMRemarkEntryDispose(LLVMRemarkEntryRef Remark);
 
extern enum LLVMRemarkType LLVMRemarkEntryGetType(LLVMRemarkEntryRef Remark);
 
extern LLVMRemarkStringRef
LLVMRemarkEntryGetPassName(LLVMRemarkEntryRef Remark);
 
extern LLVMRemarkStringRef
LLVMRemarkEntryGetRemarkName(LLVMRemarkEntryRef Remark);
 
extern LLVMRemarkStringRef
LLVMRemarkEntryGetFunctionName(LLVMRemarkEntryRef Remark);
 
extern LLVMRemarkDebugLocRef
LLVMRemarkEntryGetDebugLoc(LLVMRemarkEntryRef Remark);
 
extern uint64_t LLVMRemarkEntryGetHotness(LLVMRemarkEntryRef Remark);
 
extern uint32_t LLVMRemarkEntryGetNumArgs(LLVMRemarkEntryRef Remark);
 
extern LLVMRemarkArgRef LLVMRemarkEntryGetFirstArg(LLVMRemarkEntryRef Remark);
 
extern LLVMRemarkArgRef LLVMRemarkEntryGetNextArg(LLVMRemarkArgRef It,
                                                  LLVMRemarkEntryRef Remark);
 
typedef struct LLVMRemarkOpaqueParser *LLVMRemarkParserRef;
 
extern LLVMRemarkParserRef LLVMRemarkParserCreateYAML(const void *Buf,
                                                      uint64_t Size);
 
extern LLVMRemarkParserRef LLVMRemarkParserCreateBitstream(const void *Buf,
                                                           uint64_t Size);
 
extern LLVMRemarkEntryRef LLVMRemarkParserGetNext(LLVMRemarkParserRef Parser);
 
extern LLVMBool LLVMRemarkParserHasError(LLVMRemarkParserRef Parser);
 
extern const char *LLVMRemarkParserGetErrorMessage(LLVMRemarkParserRef Parser);
 
extern void LLVMRemarkParserDispose(LLVMRemarkParserRef Parser);
 
extern uint32_t LLVMRemarkVersion(void);
 
LLVM_C_EXTERN_C_END
 
#endif /* LLVM_C_REMARKS_H */