GeezerVison is showing github.com — livecode/libscript/src/script-validate.cpp.h at develop · livecode/livecode

This repository was archived by the owner on Aug 31, 2021. It is now read-only.

Expand file tree

script-validate.cpp.h

Copy path

More file actions

Latest commit

History

299 lines (239 loc) · 7.47 KB

script-validate.cpp.h

Copy path

File metadata and controls

299 lines (239 loc) · 7.47 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

295

296

297

298

299

This file is part of LiveCode.

LiveCode is free software; you can redistribute it and/or modify it under

the terms of the GNU General Public License v3 as published by the Free

Software Foundation.

LiveCode is distributed in the hope that it will be useful, but WITHOUT ANY

WARRANTY; without even the implied warranty of MERCHANTABILITY or

FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License

for more details.

You should have received a copy of the GNU General Public License

along with LiveCode. If not see <http://www.gnu.org/licenses/>. */

#include <libscript/script.h>

#include "script-private.h"

class MCScriptValidateContext

{

public:

// Constructors

MCScriptValidateContext(MCScriptModuleRef module,

MCScriptHandlerDefinition *definition,

uindex_t address,

uindex_t *arguments,

uindex_t argument_count);

// Return whether the context is valid.

bool IsValid(void) const;

// Return the maximum index of register used.

uindex_t GetRegisterLimit(void) const;

// Quering Methods

// These methods return information about the current bytecode operation

// being processed.

// Return the address of the current opcode

uindex_t GetAddress(void) const;

// Return the number of arguments to the current opcode

uindex_t GetArity(void) const;

// Get the argument at the given index as unsigned

uindex_t GetArgument(uindex_t index) const;

// Get the argument at the given index as signed

index_t GetSignedArgument(uindex_t index) const;

// Get the effective definition kind of the specified index

MCScriptDefinitionKind GetEffectiveKindOfDefinition(uindex_t index) const;

// Validating Methods

// These methods validate various aspects of the bytecode. The context

// stores whether a previous validation failed, and takes appropriate

// action. This means there is no need to check return values in a

// Validate method.

// Check the number of arguments is as specified, returning success or not.

void CheckArity(uindex_t expected_arity);

// Check the given address is valid - i.e. is within the current handler

// and targets the start of an opcode.

void CheckAddress(uindex_t target_address);

// Check the given index is a valid register.

// Note: At the point of checking, a maximum upper bound is used to check

// the register index is 'sane'. At the end of validation an extra check

// is performed to ensure that register indicies form a dense sequence from

// 0..n where n is the maximum register index specified in the bytecode.

void CheckRegister(uindex_t register_index);

// Check the given index is a valid constant index

void CheckValue(uindex_t constant_index);

// Check the given index is a valid handler index. A valid handler index

// can be of type Handler, ForeignHandler, or DefinitionGroup (of handlers).

void CheckHandler(uindex_t handler_index);

// Check the given index is a valid fetchable definition index. A fetchable

// definition can be of type Constant, Variable or Handler.

void CheckFetchable(uindex_t fetchable_index);

// Check the given index is a valid variable definition index.

void CheckVariable(uindex_t variable_index);

// Reporting Methods

// These report the validation errors which can occur.

void ReportInvalidArity(void);

void ReportInvalidAddress(void);

void ReportInvalidRegister(void);

void ReportInvalidValue(void);

void ReportInvalidDefinition(void);

void ReportInvalidHandler(void);

void ReportInvalidFetchable(void);

void ReportInvalidVariable(void);

private:

// Whilst validation of bytecode is successful, the error var remains

// false. When it becomes true, it means the bytecode at 'current_address'

// within the handler is invalid.

bool m_error;

// The module containins the handler being validated.

MCScriptModuleRef m_module;

// The handler being validated.

MCScriptHandlerDefinition *m_handler;

// The offset from the beginning of the module's bytecode to the current

// instruction being validated.

uindex_t m_current_address;

// The current instructions argument count.

uindex_t m_argument_count;

// The current instructions list of (decoded) arguments.

uindex_t m_arguments[256];

// The total number of registers required to run the bytecode.

uindex_t m_register_limit;

};

inline uindex_t MCScriptValidateContext::GetAddress(void) const

{

return m_current_address;

}

inline uindex_t MCScriptValidateContext::GetArity(void) const

{

return m_argument_count;

}

inline uindex_t MCScriptValidateContext::GetArgument(uindex_t p_index) const

{

__MCScriptAssert__(p_index < m_argument_count, "invalid argument index");

return m_arguments[p_index];

}

inline index_t MCScriptValidateContext::GetSignedArgument(uindex_t p_index) const

{

uindex_t t_unsigned_value = GetArgument(p_index);

index_t t_value;

if ((t_unsigned_value & 1) == 0)

t_value = (signed)(t_unsigned_value >> 1);

else

t_value = -(signed)(t_unsigned_value >> 1);

return t_value;

}

inline MCScriptDefinitionKind MCScriptValidateContext::GetEffectiveKindOfDefinition(uindex_t p_index) const

{

__MCScriptAssert__(p_index < m_module->definition_count, "invalid definition index");

if (m_module->definitions[p_index]->kind == kMCScriptDefinitionKindExternal)

{

MCScriptExternalDefinition *t_ext_def =

static_cast<MCScriptExternalDefinition *>(m_module->definitions[p_index]);

return m_module->imported_definitions[t_ext_def->index].kind;

}

return m_module->definitions[p_index]->kind;

}

inline void MCScriptValidateContext::CheckArity(uindex_t p_expected_arity)

{

if (m_error)

return;

if (GetArity() != p_expected_arity)

{

ReportInvalidArity();

return;

}

inline void MCScriptValidateContext::CheckAddress(uindex_t p_address)

{

if (m_error)

return;

if (p_address < m_handler->start_address)

{

ReportInvalidAddress();

return;

}

if (p_address >= m_handler->finish_address)

{

ReportInvalidAddress();

return;

}

inline void MCScriptValidateContext::CheckRegister(uindex_t p_register)

{

if (m_error)

{

return;

}

if (p_register >= m_register_limit)

{

m_register_limit = p_register + 1;

}

inline void MCScriptValidateContext::CheckValue(uindex_t p_index)

{

if (m_error)

{

return;

}

if (p_index > m_module->value_count)

{

ReportInvalidValue();

return;

}

inline void MCScriptValidateContext::CheckHandler(uindex_t p_index)

{

if (m_error)

{

return;

}

if (p_index > m_module->definition_count)

{

ReportInvalidDefinition();

return;

}

MCScriptDefinitionKind t_kind =

GetEffectiveKindOfDefinition(p_index);

if (t_kind != kMCScriptDefinitionKindHandler &&

t_kind != kMCScriptDefinitionKindForeignHandler)

{

ReportInvalidHandler();

return;

}

inline void MCScriptValidateContext::CheckFetchable(uindex_t p_index)

{

if (m_error)

{

return;

}

if (p_index > m_module->definition_count)

{

ReportInvalidDefinition();

return;

}

MCScriptDefinitionKind t_kind =

GetEffectiveKindOfDefinition(p_index);

if (t_kind != kMCScriptDefinitionKindConstant &&

t_kind != kMCScriptDefinitionKindVariable &&

t_kind != kMCScriptDefinitionKindHandler &&

t_kind != kMCScriptDefinitionKindForeignHandler)

{

ReportInvalidFetchable();

return;

}

inline void MCScriptValidateContext::CheckVariable(uindex_t p_index)

{

if (m_error)

{

return;

}

if (p_index > m_module->definition_count)

{

ReportInvalidDefinition();

return;

}

if (GetEffectiveKindOfDefinition(p_index) != kMCScriptDefinitionKindVariable)

{

ReportInvalidVariable();

return;

}