summaryrefslogtreecommitdiff
path: root/mobicore/MobiCoreDriverLib/ClientLib/Session.h
blob: b376a1893228c011c806f40d06f6221540a73b3e (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
/*
 * Copyright (c) 2013-2014 TRUSTONIC LIMITED
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the TRUSTONIC LIMITED nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef SESSION_H_
#define SESSION_H_

#include <stdint.h>
#include <list>

#include "Connection.h"
#include "CMcKMod.h"
#include "CMutex.h"


class BulkBufferDescriptor
{
public:
    addr_t    virtAddr; /**< The virtual address of the Bulk buffer*/
    uint32_t  sVirtualAddr; /**< The secure virtual address of the Bulk buffer*/
    uint32_t  len; /**< Length of the Bulk buffer*/
    uint32_t  handle;

    BulkBufferDescriptor(
        addr_t    virtAddr,
        uint32_t  sVirtAddr,
        uint32_t  len,
        uint32_t  handle
    ) :
        virtAddr(virtAddr),
        sVirtualAddr(sVirtAddr),
        len(len),
        handle(handle)
    {};

};

typedef std::list<BulkBufferDescriptor *>  bulkBufferDescrList_t;
typedef bulkBufferDescrList_t::iterator   bulkBufferDescrIterator_t;


/** Session states.
 * At the moment not used !!.
 */
typedef enum {
    SESSION_STATE_INITIAL,
    SESSION_STATE_OPEN,
    SESSION_STATE_TRUSTLET_DEAD
} sessionState_t;

#define SESSION_ERR_NO      0 /**< No session error */

/** Session information structure.
 * The information structure is used to hold the state of the session, which will limit further actions for the session.
 * Also the last error code will be stored till it's read.
 */
typedef struct {
    sessionState_t state;       /**< Session state */
    int32_t        lastErr;     /**< Last error of session */
} sessionInformation_t;


class Session
{
private:
    CMcKMod *mcKMod;
    CMutex workLock;
    bulkBufferDescrList_t bulkBufferDescriptors; /**< Descriptors of additional bulk buffer of a session */
    sessionInformation_t sessionInfo; /**< Informations about session */
public:
    uint32_t sessionId;
    Connection *notificationConnection;

    Session(uint32_t sessionId, CMcKMod *mcKMod, Connection *connection);

    virtual ~Session(void);

    /**
     * Add address information of additional bulk buffer memory to session and
     * register virtual memory in kernel module.
     *
     * @attention The virtual address can only be added one time. If the virtual address already exist, MC_DRV_ERR_BUFFER_ALREADY_MAPPED is returned.
     *
     * @param buf The virtual address of bulk buffer.
     * @param len Length of bulk buffer.
     * @param blkBuf pointer of the actual Bulk buffer descriptor with all address information.
     *
     * @return MC_DRV_OK on success
     * @return MC_DRV_ERR_BUFFER_ALREADY_MAPPED
     */
    mcResult_t addBulkBuf(addr_t buf, uint32_t len, BulkBufferDescriptor **blkBuf);

    /**
     * Just register the buffer previously created to the session
     *
     * @attention The virtual address can only be added one time. If the virtual address already exist, MC_DRV_ERR_BUFFER_ALREADY_MAPPED is returned.
     *
     * @param blkBuf pointer of the actual Bulk buffer descriptor with all address information.
     *
     */
    void addBulkBuf(BulkBufferDescriptor *blkBuf);

    /**
     * Remove address information of additional bulk buffer memory from session and
     * unregister virtual memory in kernel module
     *
     * @param buf The virtual address of the bulk buffer.
     *
     * @return true on success.
     */
    mcResult_t removeBulkBuf(addr_t buf);

    /**
     * Return the Kmod handle of the bulk buff
     *
     * @param buf The secure virtual address of the bulk buffer.
     *
     * @return the Handle or 0 for failure
     */
    uint32_t getBufHandle(uint32_t sVirtAddr, uint32_t sVirtualLen);

    /**
     * Set additional error information of the last error that occured.
     *
     * @param errorCode The actual error.
     */
    void setErrorInfo(int32_t err);

    /**
     * Get additional error information of the last error that occured.
     *
     * @attention After request the information is set to SESSION_ERR_NO.
     *
     * @return Last stored error code or SESSION_ERR_NO.
     */
    int32_t getLastErr(void);

    /**
     * Lock session for operation
     */
    void lock() {
        workLock.lock();
    }

    /**
     * Unlock session for operation
     */
    void unlock()  {
        workLock.unlock();
    }
};

typedef std::list<Session *>            sessionList_t;
typedef sessionList_t::iterator        sessionIterator_t;

#endif /* SESSION_H_ */