summaryrefslogtreecommitdiff
path: root/source/utilities/BulkHandler.cpp
blob: 5eebd61e58f39a651fc3923144be6062050c70b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
/******************************************************************************
*
* Copyright (C) ST-Ericsson SA 2011
* License terms: 3-clause BSD license
*
******************************************************************************/

#include "BulkHandler.h"
#include "LCDriverMethods.h"
#include "Buffers.h"
#include "LcmInterface.h"
#include "Logger.h"
#include "Error.h"
#include "lcdriver_error_codes.h"
#include <string>
#include <cstdio>
using namespace std;

/// <summary>
/// BulkHandler constructor
/// </summary>
BulkHandler::BulkHandler(CLCDriverMethods *methods, Buffers *buffers, LcmInterface *lcmInterface, Logger *logger):
    m_Methods(methods),
    m_ReceiveQueue(32),
    m_pBuffers(buffers),
    m_pLcmInterface(lcmInterface),
    m_pLogger(logger),
    m_State(BULK_INACTIVE),
    m_pFileWriteThread(0),
    m_pBulkVector(0)
{
}

/// <summary>
/// BulkHandler destructor
/// </summary>
BulkHandler::~BulkHandler()
{
    TL_BulkVectorList_t *bulkVector = 0;

    while (true) {
        RemoveResult result = m_ReceiveQueue.RemoveHead(reinterpret_cast<void **>(&bulkVector), 0);

        if (REMOVE_TIMEOUT == result) {
            break;
        } else if (REMOVE_CANCEL == result) {
            continue;
        }

        m_pLcmInterface->BulkDestroyVector(bulkVector, true);
#ifdef _BULKDEBUG
        m_pLogger->log("BULK: Vector destroyed BulkVector = 0x%x", m_pBulkVector);
#endif
    }
}

int BulkHandler::Send(const string &sourceFile)
{
    if (BULK_INACTIVE != m_State) {
        return BULK_ALREADY_IN_PROGRESS;
    }

    m_sFilePath = sourceFile;
    m_State = BULK_TX;
    return 0;
}

int BulkHandler::Receive(const string &destinationFile)
{
    if (BULK_INACTIVE != m_State) {
        return BULK_ALREADY_IN_PROGRESS;
    }

    m_sFilePath = destinationFile;

    // truncate the file for receiving
    FILE *file = fopen(m_sFilePath.c_str(), "wb");

    if (!file) {
        return FILE_OPENING_ERROR;
    }

    fclose(file);

    m_State = BULK_RX;

    // start bulk file write thread
    m_pFileWriteThread = new CThreadWrapper(FileWriteThreadFunction, this);
    m_pFileWriteThread->ResumeThread();

    return 0;
}

void BulkHandler::Finish(bool ForceFinish)
{
    if (BULK_RX == m_State) {
        m_State = BULK_INACTIVE;
        m_ReceiveQueue.SignalEvent();
        m_pFileWriteThread->WaitToDie(INFINITE);
    } else if (m_State != BULK_INACTIVE) {
        m_State = BULK_INACTIVE;

        if (ForceFinish) {
            m_pBulkVector->State = CANCEL_BULK;
        }
    }
}

void BulkHandler::HandleCommandRequest(uint16 session, uint32 chunkSize, uint64 offset, uint32 length, bool acknowledge)
{
    switch (SELECT_COMMAND(m_State, acknowledge)) {
    case BULK_WRITE_REQUEST:
        HandleWriteRequest(session, chunkSize, offset, length);
        break;

    case BULK_READ_REQUEST:
        HandleReadRequest(session, chunkSize, offset, length);
        break;

    case BULK_RX_SESSION_END:
        HandleRxSessionEnd(session, chunkSize, offset, length);
        break;

    case BULK_TX_SESSION_END:
        HandleTxSessionEnd(session, chunkSize, offset, length);
        break;

    default:
        break;
    }
}

void BulkHandler::HandleWriteRequest(uint16 session, uint32 chunkSize, uint64 offset, uint32 length)
{
    int ReturnValue = E_SUCCESS;

    uint32 VectorID = m_pLcmInterface->BulkOpenSession(session, BULK_RECEIVE, length);
    VERIFY(BULK_ERROR != VectorID, BULK_VECTOR_ID_ERROR);
#ifdef _BULKDEBUG
    m_pLogger->log("BULK: Session opened with VectorID = %u", VectorID);
#endif
    m_pBulkVector = m_pLcmInterface->BulkCreateVector(VectorID, length, chunkSize, NULL);
    VERIFY_SUCCESS(m_pLcmInterface->BulkStartSession(m_pBulkVector, offset));
#ifdef _BULKDEBUG
    m_pLogger->log("BULK: Session %u started with BulkVector = 0x%x", session, m_pBulkVector);
#endif

ErrorExit:

    if (E_SUCCESS != ReturnValue) {
        m_Methods->SignalError(ReturnValue);
    }
}

void BulkHandler::HandleReadRequest(uint16 session, uint32 chunkSize, uint64 offset, uint32 length)
{
    int ReturnValue = E_SUCCESS;

    uint32 VectorID = m_pLcmInterface->BulkOpenSession(session, BULK_SEND, length);
    VERIFY(BULK_ERROR != VectorID, BULK_VECTOR_ID_ERROR);
#ifdef _BULKDEBUG
    m_pLogger->log("BULK: Session opened with VectorID = %u", VectorID);
#endif
    m_pBulkVector = m_pLcmInterface->BulkCreateVector(VectorID, length, chunkSize, NULL);

    VERIFY_SUCCESS(m_pBuffers->AllocateBulkVector(m_pBulkVector, chunkSize, offset, length));
    VERIFY_SUCCESS(m_pLcmInterface->BulkStartSession(m_pBulkVector, offset));
#ifdef _BULKDEBUG
    m_pLogger->log("BULK: Session %u started with BulkVector = 0x%x", session, m_pBulkVector);
#endif

ErrorExit:

    if (E_SUCCESS != ReturnValue) {
        m_Methods->SignalError(ReturnValue);
    }
}

void BulkHandler::HandleRxSessionEnd(uint16 session, uint32 chunkSize, uint64 offset, uint32 length)
{
    int ReturnValue = E_SUCCESS;

    m_ReceiveQueue.AddTail(m_pBulkVector);

    VERIFY_SUCCESS(m_pLcmInterface->BulkCloseSession(m_pBulkVector));
#ifdef _BULKDEBUG
    m_pLogger->log("BULK: Session closed Session = %u", session);
#endif

    m_Methods->UpdateBulkProgress();

ErrorExit:

    if (E_SUCCESS != ReturnValue) {
        m_Methods->SignalError(ReturnValue);
    }
}

void BulkHandler::HandleTxSessionEnd(uint16 session, uint32 chunkSize, uint64 offset, uint32 length)
{
    int ReturnValue = E_SUCCESS;

    m_pBuffers->ReleaseBulkVector(m_pBulkVector);

    VERIFY_SUCCESS(m_pLcmInterface->BulkDestroyVector(m_pBulkVector, false));
#ifdef _BULKDEBUG
    m_pLogger->log("BULK: Vector destroyed BulkVector = 0x%x", m_pBulkVector);
#endif

    m_Methods->UpdateBulkProgress();

ErrorExit:

    if (E_SUCCESS != ReturnValue) {
        m_Methods->SignalError(ReturnValue);
    }
}

void BulkHandler::FlushReceiveQueue()
{
#ifdef _BULKDEBUG
    m_pLogger->log("BULK: Flush receive queue");
#endif
    TL_BulkVectorList_t *bulkVector = 0;

    while (true) {
        RemoveResult result = m_ReceiveQueue.RemoveHead(reinterpret_cast<void **>(&bulkVector), 0);

        if (REMOVE_TIMEOUT == result) {
            break;
        } else if (REMOVE_CANCEL == result) {
            continue;
        }

        WriteBulkVector(bulkVector);

        m_pLcmInterface->BulkDestroyVector(bulkVector, true);
#ifdef _BULKDEBUG
        m_pLogger->log("BULK: Vector destroyed BulkVector = 0x%x", bulkVector);
#endif
    }
}

void BulkHandler::WriteBulkVector(TL_BulkVectorList_t *bulkVector)
{
    FILE *file = fopen(m_sFilePath.c_str(), "ab");

    if (file) {
        for (size_t i = 0; i != bulkVector->Buffers; ++i) {
            uint32 currentChunkSize = bulkVector->ChunkSize;

            if (i + 1 == bulkVector->Buffers) { //lastchunk
                currentChunkSize = bulkVector->Length - (i * bulkVector->ChunkSize);
            }

            fwrite(bulkVector->Entries[i].Payload_p, currentChunkSize, 1, file);
        }

        fclose(file);
#ifdef _BULKDEBUG
        m_pLogger->log("BULK: Vector written BulkVector = 0x%x", m_pBulkVector);
#endif
    }
}

#ifdef _WIN32
unsigned int WINAPI BulkHandler::FileWriteThreadFunction(void *arg)
#else
void *BulkHandler::FileWriteThreadFunction(void *arg)
#endif
{
    BulkHandler *pThis = static_cast<BulkHandler *>(arg);

    TL_BulkVectorList_t *bulkVector = 0;

    while (true) {
        RemoveResult result = pThis->m_ReceiveQueue.RemoveHead(reinterpret_cast<void **>(&bulkVector), INFINITE);

        if (REMOVE_SUCCESS == result) {
            pThis->WriteBulkVector(bulkVector);

            pThis->m_pLcmInterface->BulkDestroyVector(bulkVector, true);
#ifdef _BULKDEBUG
            pThis->m_pLogger->log("BULK: Vector destroyed BulkVector = 0x%x", bulkVector);
#endif
        } else {
            break;
        }
    }

    pThis->FlushReceiveQueue();

    return 0;
}