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