1 /*
2 * Copyright (C) 2021 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 NSTACKX_FILE_LIST_H
17 #define NSTACKX_FILE_LIST_H
18
19 #include "nstackx_dfile.h"
20 #include "nstackx_list.h"
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24
25 #define NSTACKX_FLAGS_FILE_NAME_ACK 0x01
26 #define NSTACKX_FLAGS_FILE_NAME_RECEIVED 0x02
27 #define NSTACKX_FLAGS_FILE_RECEIVE_SUCCESS 0x04
28 #define NSTACKX_FLAGS_FILE_RECEIVE_FAIL 0x08
29 #define NSTACKX_FLAGS_FILE_SEND_SUCCESS 0x10
30 #define NSTACKX_FLAGS_LAST_BLOCK_RECEIVED 0x20
31
32 #define NSTACKX_FLAGS_USER_DATA_ACK 0x4
33
34 #define NOTICE_FILE_NAME_TYPE 0
35 #define NOTICE_FULL_FILE_NAME_TYPE 1
36 #define PATH_TYPE_PACKED_LEN 4
37
38 typedef struct {
39 uint16_t fileId;
40 uint8_t flags;
41 char fileName[NSTACKX_MAX_REMOTE_PATH_LEN];
42 char *fullFileName;
43 char *remotePath; /* just usefully for sender */
44 uint64_t fileSize;
45 uint64_t startOffset;
46 } FileListEntry;
47
48 typedef struct FileList {
49 FileListEntry *list;
50 char *userData;
51 uint32_t num;
52 uint8_t userDataFlag;
53 uint8_t noticeFileNameType; /* just usefully for sender */
54 uint16_t pathType;
55 uint8_t *packedUserData; /* just usefully for sender */
56 uint16_t packedUserDataLen; /* just usefully for sender */
57 uint8_t tarFlag;
58 uint8_t smallFlag;
59 uint8_t noSyncFlag;
60 char *tarFile;
61 uint8_t vtransFlag;
62 uint8_t isFirstVtransOfFile;
63 uint16_t vtransRealTransId;
64 uint16_t vtransTotalNum;
65 uint16_t vtransRealFileId;
66 uint16_t vtransTotalFileNum;
67 uint64_t vtransTotalFileSize;
68 } FileList;
69
70 typedef struct {
71 List list;
72 char **files; /* file name */
73 char **remotePath; /* remote file path */
74 uint64_t startOffset[NSTACKX_DFILE_MAX_FILE_NUM];
75 uint64_t fileSize[NSTACKX_DFILE_MAX_FILE_NUM];
76 char *userData;
77 uint32_t fileNum;
78 uint8_t tarFlag;
79 uint8_t smallFlag;
80 uint8_t noSyncFlag;
81 char *tarFile;
82 uint8_t noticeFileNameType;
83 uint16_t pathType;
84 uint8_t vtransFlag;
85 uint16_t vtransRealTransId;
86 uint16_t vtransTotalNum;
87 uint16_t vtransTotalFileNum;
88 uint16_t vtransRealFileId;
89 uint64_t vtransTotalFileSize;
90 } FileListInfo;
91
92 typedef struct {
93 const char **files; /* file name */
94 const char **remotePath; /* remote file path */
95 uint64_t *startOffset;
96 uint64_t *fileSize;
97 const char *userData;
98 uint32_t fileNum;
99 uint8_t tarFlag;
100 } FileListPara;
101
102 #define NEW_FILE_LIST_PARA(_files, _remotePath, _fileNum, _userData, _tarFlag, _startOffset, _fileSize) \
103 { \
104 .files = (_files), \
105 .remotePath = (_remotePath), \
106 .fileNum = (_fileNum), \
107 .userData = (_userData), \
108 .tarFlag = (_tarFlag), \
109 .startOffset = (_startOffset), \
110 .fileSize = (_fileSize), \
111 }
112
113 typedef struct {
114 uint16_t fileId;
115 const uint8_t *fileName;
116 size_t fileNameLength;
117 uint64_t fileSize;
118 uint64_t startOffset;
119 } FilePara;
FileListGetRemotePath(FileList * fileList,uint16_t fileId)120 static inline char *FileListGetRemotePath(FileList *fileList, uint16_t fileId)
121 {
122 return (fileList)->list[(fileId) - 1].remotePath;
123 }
124
FileListGetFileName(FileList * fileList,uint16_t fileId)125 static inline char *FileListGetFileName(FileList *fileList, uint16_t fileId)
126 {
127 return (fileList)->list[(fileId) - 1].fileName;
128 }
129
FileListGetFileSize(FileList * fileList,uint16_t fileId)130 static inline uint64_t FileListGetFileSize(FileList *fileList, uint16_t fileId)
131 {
132 return (fileList)->list[(fileId) - 1].fileSize;
133 }
134
FileListGetNum(const FileList * fileList)135 static inline uint16_t FileListGetNum(const FileList *fileList)
136 {
137 return (uint16_t)fileList->num;
138 }
139
FileListGetPathType(FileList * fileList)140 static inline uint16_t FileListGetPathType(FileList *fileList)
141 {
142 return (fileList)->pathType;
143 }
144
145 void FileListSetFileNameAcked(FileList *fileList, uint16_t fileId);
146 uint8_t FileListGetFileNameAcked(FileList *fileList, uint16_t fileId);
147
FileListGetFileNameReceived(FileList * fileList,uint16_t fileId)148 static inline uint8_t FileListGetFileNameReceived(FileList *fileList, uint16_t fileId)
149 {
150 return (fileList)->list[(fileId) - 1].flags & NSTACKX_FLAGS_FILE_NAME_RECEIVED;
151 }
152
FileListSetLastBlockReceived(FileList * fileList,uint16_t fileId)153 static inline void FileListSetLastBlockReceived(FileList *fileList, uint16_t fileId)
154 {
155 (fileList)->list[(fileId) - 1].flags |= NSTACKX_FLAGS_LAST_BLOCK_RECEIVED;
156 return;
157 }
158
FileListGetLastBlockReceived(FileList * fileList,uint16_t fileId)159 static inline uint8_t FileListGetLastBlockReceived(FileList *fileList, uint16_t fileId)
160 {
161 return (fileList)->list[(fileId) - 1].flags & NSTACKX_FLAGS_LAST_BLOCK_RECEIVED;
162 }
163
FileListSetFileReceiveSuccess(FileList * fileList,uint16_t fileId)164 static inline void FileListSetFileReceiveSuccess(FileList *fileList, uint16_t fileId)
165 {
166 (fileList)->list[(fileId) - 1].flags |= NSTACKX_FLAGS_FILE_RECEIVE_SUCCESS;
167 return;
168 }
169
FileListSetFileReceiveFail(FileList * fileList,uint16_t fileId)170 static inline void FileListSetFileReceiveFail(FileList *fileList, uint16_t fileId)
171 {
172 (fileList)->list[(fileId) - 1].flags |= NSTACKX_FLAGS_FILE_RECEIVE_FAIL;
173 return;
174 }
175
FileListSetFileSendSuccess(FileList * fileList,uint16_t fileId)176 static inline void FileListSetFileSendSuccess(FileList *fileList, uint16_t fileId)
177 {
178 (fileList)->list[(fileId) - 1].flags |= NSTACKX_FLAGS_FILE_SEND_SUCCESS;
179 return;
180 }
181
182 uint8_t FileListAllFileNameAcked(const FileList *fileList);
183 uint8_t FileListAllFileNameReceived(const FileList *fileList);
184 uint8_t FileListAllFileReceived(const FileList *fileList);
185 int32_t FileListSetSendFileList(FileList *fileList, FileListInfo *fileListInfo);
186 int32_t FileListSetRecvFileList(FileList *fileList, const char *files[], uint32_t fileNum);
187 /* To get all the file names. */
188 void FileListGetNames(FileList *fileList, char *files[], uint32_t *fileNum, uint8_t isFullFile);
189 /* To get all the files that received successfully, which may be less than FileListGetNames() */
190 void FileListGetReceivedFiles(FileList *fileList, char *files[], uint32_t *fileNum);
191 /* To get all the files that sent successfully, which may be less than FileListGetNames() */
192 void FileListGetSentFiles(FileList *fileList, char *files[], uint32_t *fileNum);
193 void FileListGetReceivedFileIdList(FileList *fileList, uint16_t fileIdList[], uint32_t *fileNum);
194
195 int32_t FileListSetNum(FileList *fileList, uint32_t fileNum);
196 int32_t FileListAddFile(FileList *fileList, uint16_t fileId, const uint8_t *fileName, size_t fileNameLength,
197 uint64_t fileSize);
198 int32_t FileListAddUserData(FileList *fileList, const uint8_t *userData, size_t userDataLength, uint8_t flag);
199 int32_t FileListAddExtraInfo(FileList *fileList, uint16_t pathType, uint8_t noticeFileNameType, char *userData);
200 int32_t FileListRenameFile(FileList *fileList, uint16_t fileId, const char *newFileName);
201 FileList *FileListCreate(void);
202 void FileListDestroy(FileList *fileList);
203 uint64_t GetFilesTotalBytes(FileList *fileList);
204 FileListInfo *CreateFileListInfo(FileListPara *fileListPara);
205 void DestroyFileListInfo(FileListInfo *fileListInfo);
206 #ifdef __cplusplus
207 }
208 #endif
209
210 #endif /* #ifndef NSTACKX_FILE_LIST_H */
211