• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2021-2025 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef SOFTBUS_UTILS_H
17 #define SOFTBUS_UTILS_H
18 
19 #include "softbus_def.h"
20 
21 #ifdef __cplusplus
22 #if __cplusplus
23 extern "C" {
24 #endif
25 #endif
26 
27 #define HEXIFY_UNIT_LEN 2
28 #define UN_HEXIFY_LEN(len) ((len) / HEXIFY_UNIT_LEN)
29 #define HEXIFY_LEN(len) ((len) * HEXIFY_UNIT_LEN + 1)
30 #define HEX_MAX_NUM 16
31 #define DEC_MAX_NUM 10
32 #define HEX_MAX_BIT_NUM 4
33 #define MAX_QUERY_LEN 64
34 #define INT64_TO_STR_MAX_LEN 21
35 
36 #define TIMER_TIMEOUT 1000 // 1s
37 #define BT_MAC_NO_COLON_LEN 13
38 #define TRANS_CAPABILITY_TLV_OFFSET 0
39 #define TRANS_CHANNEL_INNER_ENCRYPT_OFFSET 1
40 #define TRANS_CHANNEL_SINK_GENERATE_KEY_OFFSET 2
41 #define TRANS_CHANNEL_SINK_KEY_ENCRYPT_OFFSET 3
42 #define TRANS_CHANNEL_ACL_CHECK_OFFSET 4
43 #define TRANS_CHANNEL_INNER_ENCRYPT (1u << TRANS_CHANNEL_INNER_ENCRYPT_OFFSET) /* bit1 */
44 #define TRANS_CHANNEL_CAPABILITY 0x17 /* bit0 & bit1 & bit2 & bit4 */
45 
46 #define MAC_DELIMITER ':'
47 #define IP_DELIMITER '.'
48 #define ID_DELIMITER ' '
49 
50 typedef void (*TimerFunCallback)(void);
51 
52 typedef enum {
53     SOFTBUS_CONN_TIMER_FUN,
54     SOFTBUS_AUTHEN_TIMER_FUN,
55     SOFTBUS_SESSION_TIMER_FUN,
56     SOFTBUS_PROXYCHANNEL_TIMER_FUN,
57     SOFTBUS_PROXYSLICE_TIMER_FUN,
58     SOFTBUS_TCP_DIRECTCHANNEL_TIMER_FUN,
59     SOFTBUS_UDP_CHANNEL_TIMER_FUN,
60     SOFTBUS_TIME_SYNC_TIMER_FUN,
61     SOFTBUS_PROXY_SENDFILE_TIMER_FUN,
62     SOFTBUS_NIP_NODE_AGING_TIMER_FUN,
63     SOFTBUS_TRNAS_IDLE_TIMEOUT_TIMER_FUN,
64     SOFTBUS_TRNAS_REQUEST_TIMEOUT_TIMER_FUN,
65     SOFTBUS_TRANS_ASYNC_SENDBYTES_TIMER_FUN,
66     SOFTBUS_TRANS_PAGING_TIMER_FUN,
67     SOFTBUS_DDOS_TIMER_FUN,
68     SOFTBUS_MAX_TIMER_FUN_NUM
69 } SoftBusTimerFunEnum;
70 
71 int32_t RegisterTimeoutCallback(int32_t timerFunId, TimerFunCallback callback);
72 
73 int32_t UnRegisterTimeoutCallback(int32_t timerFunId);
74 
75 int32_t SoftBusTimerInit(void);
76 
77 void SoftBusTimerDeInit(void);
78 SoftBusList *CreateSoftBusList(void);
79 
80 void DestroySoftBusList(SoftBusList *list);
81 
82 int32_t ConvertBytesToHexString(char *outBuf, uint32_t outBufLen, const unsigned char *inBuf, uint32_t inLen);
83 
84 int32_t ConvertBtMacToStrNoColon(char *strMac, uint32_t strMacLen, const uint8_t *binMac,
85     uint32_t binMacLen);
86 
87 int32_t ConvertHexStringToBytes(unsigned char *outBuf, uint32_t outBufLen, const char *inBuf, uint32_t inLen);
88 
89 int32_t ConvertBytesToUpperCaseHexString(char *outBuf, uint32_t outBufLen,
90     const unsigned char *inBuf, uint32_t inLen);
91 
92 int32_t GenerateRandomStr(char *str, uint32_t size);
93 
94 bool IsValidString(const char *input, uint32_t maxLen);
95 
96 int32_t ConvertBtMacToBinary(const char *strMac, uint32_t strMacLen, uint8_t *binMac, uint32_t binMacLen);
97 
98 int32_t ConvertBtMacToStr(char *strMac, uint32_t strMacLen, const uint8_t *binMac, uint32_t binMacLen);
99 
100 int32_t ConvertReverseBtMacToStr(char *strMac, uint32_t strMacLen, const uint8_t *binMac, uint32_t binMacLen);
101 
102 int32_t ConvertBtMacToU64(const char *strMac, uint32_t strMacLen, uint64_t *u64Mac);
103 
104 int32_t ConvertU64MacToStr(uint64_t u64Mac, char *strMac, uint32_t strMacLen);
105 
106 bool Int64ToString(int64_t src, char *buf, uint32_t bufLen);
107 int32_t StrCmpIgnoreCase(const char *str1, const char *str2);
108 
109 int32_t StringToUpperCase(const char *str, char *buf, int32_t size);
110 
111 int32_t StringToLowerCase(const char *str, char *buf, int32_t size);
112 
113 int32_t WriteInt32ToBuf(uint8_t *buf, uint32_t dataLen, int32_t *offSet, int32_t data);
114 
115 int32_t WriteUint8ToBuf(uint8_t *buf, uint32_t dataLen, int32_t *offSet, uint8_t data);
116 
117 int32_t WriteUint64ToBuf(uint8_t *buf, uint32_t bufLen, int32_t *offSet, uint64_t data);
118 
119 int32_t WriteStringToBuf(uint8_t *buf, uint32_t bufLen, int32_t *offSet, char *data, uint32_t dataLen);
120 
121 int32_t ReadInt32FromBuf(uint8_t *buf, uint32_t dataLen, int32_t *offSet, int32_t *data);
122 
123 int32_t ReadUint8FromBuf(uint8_t *buf, uint32_t dataLen, int32_t *offSet, uint8_t *data);
124 
125 int32_t ReadUint64FromBuf(uint8_t *buf, uint32_t dataLen, int32_t *offSet, uint64_t *data);
126 
127 int32_t ReadStringLenFormBuf(uint8_t *buf, uint32_t bufLen, int32_t *offSet, uint32_t *len);
128 
129 int32_t ReadStringFromBuf(uint8_t *buf, uint32_t bufLen, int32_t *offSet, char *data, uint32_t dataLen);
130 
131 int32_t CalculateMbsTruncateSize(const char *multiByteStr, uint32_t capacity, uint32_t *truncatedSize);
132 
133 void SetSignalingMsgSwitchOn(void);
134 void SetSignalingMsgSwitchOff(void);
135 bool GetSignalingMsgSwitch(void);
136 
137 /**
138  * @brief Intercept signaling messages of specified length and print.
139  * @param[in] distinguish Distinguish the sending and receiving of ble, COAP and P2P signaling messages.
140  * @param[in] data Signaling message.
141  * @param[in] dataLen Length of the signaling message.
142  * @param[in] module softbus log module.
143  */
144 void SignalingMsgPrint(const char *distinguish, unsigned char *data, unsigned char dataLen, uint32_t module);
145 
146 void DataMasking(const char *data, uint32_t length, char delimiter, char *container);
147 int32_t GenerateStrHashAndConvertToHexString(const unsigned char *str, uint32_t len, unsigned char *hashStr,
148     uint32_t hashStrLen);
149 
150 void EnableCapabilityBit(uint32_t *value, uint32_t offSet);
151 
152 void DisableCapabilityBit(uint32_t *value, uint32_t offSet);
153 
154 bool GetCapabilityBit(uint32_t value, uint32_t offSet);
155 
156 void SoftbusDumpBytes(const char *message, const uint8_t *data, uint32_t dataLen);
157 
158 int32_t AddNumberToSocketName(uint32_t num, const char *prefix, uint32_t preLen, char *socketName);
159 
160 #ifdef __cplusplus
161 #if __cplusplus
162 }
163 #endif /* __cplusplus */
164 #endif /* __cplusplus */
165 
166 #endif /* SOFTBUS_UTILS_H */
167