This repository was archived by the owner on Jun 5, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
Expand file tree
/
Copy pathModuleTests.cs
More file actions
489 lines (434 loc) · 20.6 KB
/
Copy pathModuleTests.cs
File metadata and controls
489 lines (434 loc) · 20.6 KB
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
using System;
using System.IO;
using System.Linq;
using Llvm.NET.Instructions;
using Llvm.NET.Values;
using Llvm.NETTests;
using Microsoft.VisualStudio.TestTools.UnitTesting;
namespace Llvm.NET.Tests
{
[TestClass]
public class ModuleTests
{
private const string StructTestName = "struct.Test";
private const string TestModuleName = "test";
[TestMethod]
public void DefaultConstructorTest( )
{
using( var module = new NativeModule( ) )
{
Assert.AreSame( string.Empty, module.Name );
Assert.IsNotNull( module );
Assert.IsNotNull( module.Context );
Assert.AreSame( string.Empty, module.DataLayoutString );
Assert.IsNull( module.Layout );
Assert.AreSame( string.Empty, module.TargetTriple );
Assert.IsNotNull( module.DIBuilder );
// until explicitly created DICompileUnit should be null
Assert.IsNull( module.DICompileUnit );
// Functions collection should be valid but empty
Assert.IsNotNull( module.Functions );
Assert.IsFalse( module.Functions.Any( ) );
// Globals collection should be valid but empty
Assert.IsNotNull( module.Globals );
Assert.IsFalse( module.Globals.Any( ) );
}
}
[TestMethod]
public void ConstructorTestWithName( )
{
using( var module = new NativeModule( TestModuleName ) )
{
Assert.AreEqual( TestModuleName, module.Name );
Assert.IsNotNull( module );
Assert.IsNotNull( module.Context );
Assert.AreSame( string.Empty, module.DataLayoutString );
Assert.IsNull( module.Layout );
Assert.AreSame( string.Empty, module.TargetTriple );
Assert.IsNotNull( module.DIBuilder );
// until explicitly created DICompileUnit should be null
Assert.IsNull( module.DICompileUnit );
// Functions collection should be valid but empty
Assert.IsNotNull( module.Functions );
Assert.IsFalse( module.Functions.Any( ) );
// Globals collection should be valid but empty
Assert.IsNotNull( module.Globals );
Assert.IsFalse( module.Globals.Any( ) );
}
}
[TestMethod]
public void ConstructorTestWithNameAndCompileUnit( )
{
using( var module = new NativeModule( TestModuleName, DebugInfo.SourceLanguage.C99, "test.c", "unitTest", false, string.Empty, 0 ) )
{
Assert.AreEqual( TestModuleName, module.Name );
Assert.IsNotNull( module );
Assert.IsNotNull( module.Context );
Assert.AreSame( string.Empty, module.DataLayoutString );
Assert.IsNull( module.Layout );
Assert.AreSame( string.Empty, module.TargetTriple );
Assert.IsNotNull( module.DIBuilder );
Assert.IsNotNull( module.DICompileUnit );
// Functions collection should be valid but empty
Assert.IsNotNull( module.Functions );
Assert.IsFalse( module.Functions.Any( ) );
// Globals collection should be valid but empty
Assert.IsNotNull( module.Globals );
Assert.IsFalse( module.Globals.Any( ) );
}
}
[TestMethod]
public void DisposeTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
}
}
[TestMethod]
public void BasicLinkTest( )
{
// verifies linked modules can be disposed
using( var ctx = new Context( ) )
using( var module = new NativeModule( TestModuleName, ctx ) )
using( var otherModule = new NativeModule( "Other", ctx ) )
{
module.Link( otherModule );
Assert.IsNull( otherModule.Context );
}
}
[TestMethod]
[ExpectedArgumentException( "otherModule", ExpectedExceptionMessage = "Linking modules with different contexts is not allowed" )]
public void MultiContextLinkTest( )
{
using( var mergedMod = new NativeModule( ) )
using( var m1 = CreateSimpleModule( "module1" ) )
using( var m2 = CreateSimpleModule( "module2" ) )
{
Assert.AreNotSame( mergedMod.Context, m1.Context );
Assert.AreNotSame( mergedMod.Context, m2.Context );
mergedMod.Link( m1 ); // exception expected here.
}
}
[TestMethod]
public void ModuleCloneInContextTest( )
{
var m1 = CreateSimpleModule( "module1" );
using( var context = new Context( ) )
{
var m2 = m1.Clone( context );
Assert.AreNotSame( context, m1 );
Assert.IsNotNull( m2 );
Assert.AreSame( context, m2.Context );
}
}
[TestMethod]
public void MultiContextCloneLinkTest( )
{
using( var mergedMod = new NativeModule( ) )
using( var m1 = CreateSimpleModule( "module1" ) )
using( var m2 = CreateSimpleModule( "module2" ) )
{
Assert.AreNotSame( mergedMod.Context, m1.Context );
Assert.AreNotSame( mergedMod.Context, m2.Context );
var clone1 = m1.Clone( mergedMod.Context );
var clone2 = m2.Clone( mergedMod.Context );
GC.Collect( GC.MaxGeneration, GCCollectionMode.Forced, true );
mergedMod.Link( clone1 );
GC.Collect( GC.MaxGeneration, GCCollectionMode.Forced, true );
Assert.IsTrue( mergedMod.Verify( out string errMsg ), errMsg );
Assert.AreEqual( 1, mergedMod.Functions.Count( ) );
mergedMod.Link( clone2 );
GC.Collect( GC.MaxGeneration, GCCollectionMode.Forced, true );
Assert.IsTrue( mergedMod.Verify( out errMsg ), errMsg );
Assert.AreEqual( 2, mergedMod.Functions.Count( ) );
}
}
[TestMethod]
public void VerifyValidModuleTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
Function testFunc = CreateSimpleVoidNopTestFunction( module, "foo" );
// verify basics
Assert.IsNotNull( testFunc );
bool isValid = module.Verify( out string msg );
Assert.IsTrue( isValid );
Assert.AreEqual( string.Empty, msg );
}
}
[TestMethod]
public void VerifyInvalidModuleTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
Function testFunc = CreateInvalidFunction( module, "badfunc" );
// verify basics
Assert.IsNotNull( testFunc );
bool isValid = module.Verify( out string msg );
Assert.IsFalse( isValid );
Assert.IsNotNull( msg );
/* while verifying the contents of the message might be a normal test
it comes from the underlying wrapped LLVM and is subject to change
by the LLVM team and is therefore outside the control of LLVM.NET
*/
}
}
[TestMethod]
public void AddFunctionGetFunctionTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
Function testFunc = CreateSimpleVoidNopTestFunction( module, "foo" );
// verify basics
Assert.IsNotNull( testFunc );
Assert.AreSame( module, testFunc.ParentModule );
Assert.AreEqual( "foo", testFunc.Name );
// Verify the function is in the module
var funcFromModule = module.GetFunction( "foo" );
Assert.AreSame( testFunc, funcFromModule );
}
}
[TestMethod]
public void WriteToFileTest( )
{
string path = Path.GetTempFileName( );
try
{
using( var module = new NativeModule( TestModuleName ) )
{
Function testFunc = CreateSimpleVoidNopTestFunction( module, "foo" );
module.WriteToFile( path );
}
using( var ctx = new Context( ) )
using( var module2 = NativeModule.LoadFrom( path, ctx ) )
{
Function testFunc = module2.GetFunction( "foo" );
// verify basics
Assert.IsNotNull( testFunc );
string txt = module2.WriteToString( );
Assert.IsFalse( string.IsNullOrWhiteSpace( txt ) );
string expectedText = File.ReadAllText( "TestModuleAsString.ll" )
.Replace( "; ModuleID = 'test'", $"; ModuleID = '{path}'" );
Assert.AreEqual( expectedText, txt );
}
}
finally
{
File.Delete( path );
}
}
[TestMethod]
public void AsStringTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
Function testFunc = CreateSimpleVoidNopTestFunction( module, "foo" );
// verify basics
Assert.IsNotNull( testFunc );
string txt = module.WriteToString( );
Assert.IsFalse( string.IsNullOrWhiteSpace( txt ) );
string expectedText = File.ReadAllText( "TestModuleAsString.ll" );
Assert.AreEqual( expectedText, txt );
}
}
[TestMethod]
public void AddAliasGetAliasTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
Function testFunc = CreateSimpleVoidNopTestFunction( module, "_test" );
var alias = module.AddAlias( testFunc, TestModuleName );
Assert.AreSame( alias, module.GetAlias( TestModuleName ) );
Assert.AreSame( module, alias.ParentModule );
Assert.AreSame( testFunc, alias.Aliasee );
Assert.AreEqual( TestModuleName, alias.Name );
Assert.AreEqual( Linkage.External, alias.Linkage );
Assert.AreSame( testFunc.NativeType, alias.NativeType );
// alias.Operands[ 0 ] is just another way to get alias.Aliasee
Assert.AreEqual( 1, alias.Operands.Count );
Assert.AreSame( testFunc, alias.Operands[ 0 ] );
Assert.IsFalse( alias.IsNull );
Assert.IsFalse( alias.IsUndefined );
Assert.IsFalse( alias.IsZeroValue );
}
}
[TestMethod]
public void AddGlobalTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
module.AddGlobal( module.Context.Int32Type, "TestInt" );
GlobalVariable globalVar = module.GetNamedGlobal( "TestInt" );
Assert.AreEqual( "TestInt", globalVar.Name );
Assert.AreSame( module.Context.Int32Type.CreatePointerType( ), globalVar.NativeType );
}
}
[TestMethod]
public void AddGlobalTest1( )
{
using( var module = new NativeModule( TestModuleName ) )
{
// unnamed global
module.AddGlobal( module.Context.Int32Type, true, Linkage.WeakODR, module.Context.CreateConstant( 0x12345678 ) );
var globalVar = module.Globals.First( ) as GlobalVariable;
Assert.IsNotNull( globalVar );
Assert.IsTrue( string.IsNullOrWhiteSpace( globalVar.Name ) );
Assert.AreSame( module.Context.Int32Type.CreatePointerType( ), globalVar.NativeType );
Assert.AreSame( module.Context.Int32Type, globalVar.Initializer.NativeType );
Assert.AreEqual( Linkage.WeakODR, globalVar.Linkage );
Assert.IsTrue( globalVar.IsConstant );
Assert.IsInstanceOfType( globalVar.Initializer, typeof( ConstantInt ) );
var constInt = ( ConstantInt )globalVar.Initializer;
Assert.AreEqual( 0x12345678, constInt.SignExtendedValue );
}
}
[TestMethod]
public void AddGlobalTest2( )
{
using( var module = new NativeModule( TestModuleName ) )
{
module.AddGlobal( module.Context.Int32Type, true, Linkage.WeakODR, module.Context.CreateConstant( 0x12345678 ), "TestInt" );
GlobalVariable globalVar = module.GetNamedGlobal( "TestInt" );
Assert.AreEqual( "TestInt", globalVar.Name );
Assert.AreSame( module.Context.Int32Type.CreatePointerType( ), globalVar.NativeType );
Assert.AreSame( module.Context.Int32Type, globalVar.Initializer.NativeType );
Assert.AreEqual( Linkage.WeakODR, globalVar.Linkage );
Assert.IsTrue( globalVar.IsConstant );
Assert.IsInstanceOfType( globalVar.Initializer, typeof( ConstantInt ) );
var constInt = ( ConstantInt )globalVar.Initializer;
Assert.AreEqual( 0x12345678, constInt.SignExtendedValue );
}
}
[TestMethod]
public void GetTypeByNameTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
// while GetTypeByName is exposed on the module it isn't really specific to the module
// That is, the type belongs to the context and GetTypeByName() is just a convenience
// wrapper to access types for a module.
var type = module.GetTypeByName( StructTestName );
Assert.IsNull( type );
var expectedType = module.Context.CreateStructType( StructTestName );
var actualType = module.GetTypeByName( StructTestName );
Assert.AreSame( expectedType, actualType );
}
}
[TestMethod]
public void AddModuleFlagTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
module.AddModuleFlag( ModuleFlagBehavior.Warning, NativeModule.DwarfVersionValue, 4 );
module.AddModuleFlag( ModuleFlagBehavior.Warning, NativeModule.DebugVersionValue, NativeModule.DebugMetadataVersion );
module.AddModuleFlag( ModuleFlagBehavior.Error, "wchar_size", 4 );
module.AddModuleFlag( ModuleFlagBehavior.Error, "min_enum_size", 4 );
module.AddVersionIdentMetadata( "unit-tests 1.0" );
// currently no exposed means to get module level flags...
// so at this point as long as adding the flags doesn't throw an exception
// assume things are OK.
}
}
[TestMethod]
public void AddNamedMetadataOperandTest( )
{
Assert.Inconclusive( );
}
[TestMethod]
public void AddVersionIdentMetadataTest( )
{
Assert.Inconclusive( );
}
[TestMethod]
public void LoadFromTest( )
{
Assert.Inconclusive( );
}
[TestMethod]
public void ComdatDataTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
const string comdatName = "testcomdat";
const string globalName = "globalwithcomdat";
module.Comdats.Add( comdatName, ComdatKind.SameSize );
Assert.AreEqual( 1, module.Comdats.Count );
module.AddGlobal( module.Context.Int32Type, globalName )
.Linkage( Linkage.LinkOnceAny )
.Comdat( globalName );
Assert.AreEqual( 2, module.Comdats.Count, "Unsaved module should have all comdats even if unused" );
Assert.IsTrue( module.Comdats.Contains( comdatName ) );
Assert.IsTrue( module.Comdats.Contains( globalName ) );
Assert.AreEqual( comdatName, module.Comdats[ comdatName ].Name );
Assert.AreEqual( globalName, module.Comdats[ globalName ].Name );
Assert.AreEqual( ComdatKind.SameSize, module.Comdats[ comdatName ].Kind );
Assert.AreEqual( ComdatKind.Any, module.Comdats[ globalName ].Kind );
using( var context2 = new Context( ) )
{
var clone = module.Clone( context2 );
Assert.AreEqual( 1, clone.Comdats.Count, "Comdat count should contain the one and only referenced comdat after save/clone" );
Assert.IsTrue( clone.Comdats.Contains( globalName ), "Cloned module should have the referenced comdat" );
var clonedGlobal = clone.GetNamedGlobal( globalName );
Assert.AreEqual( globalName, clonedGlobal.Comdat.Name, "Name of the comdat on the cloned global should match the one set in the original module" );
Assert.AreEqual( ComdatKind.Any, module.Comdats[ globalName ].Kind );
}
}
}
[TestMethod]
public void ComdatFunctionTest( )
{
using( var module = new NativeModule( TestModuleName ) )
{
const string comdatName = "testcomdat";
const string globalName = "globalwithcomdat";
Comdat comdat = module.Comdats.Add( comdatName, ComdatKind.SameSize );
Assert.AreEqual( comdatName, comdat.Name );
Assert.AreEqual( ComdatKind.SameSize, comdat.Kind );
Assert.AreEqual( 1, module.Comdats.Count );
CreateSimpleVoidNopTestFunction( module, globalName )
.Linkage( Linkage.LinkOnceODR )
.Comdat( globalName );
Assert.AreEqual( 2, module.Comdats.Count, "Unsaved module should have all comdats even if unused" );
Assert.IsTrue( module.Comdats.Contains( comdatName ) );
Assert.IsTrue( module.Comdats.Contains( globalName ) );
Assert.AreEqual( comdatName, module.Comdats[ comdatName ].Name );
Assert.AreEqual( globalName, module.Comdats[ globalName ].Name );
Assert.AreEqual( ComdatKind.SameSize, module.Comdats[ comdatName ].Kind );
Assert.AreEqual( ComdatKind.Any, module.Comdats[ globalName ].Kind );
using( var context2 = new Context( ) )
{
var clone = module.Clone( context2 );
Assert.AreEqual( 1, clone.Comdats.Count, "Comdat count should contain the one and only referenced comdat after save/clone" );
Assert.IsTrue( clone.Comdats.Contains( globalName ), "Cloned module should have the referenced comdat" );
var clonedGlobal = clone.GetFunction( globalName );
Assert.AreEqual( globalName, clonedGlobal.Comdat.Name, "Name of the comdat on the cloned global should match the one set in the original module" );
Assert.AreEqual( ComdatKind.Any, module.Comdats[ globalName ].Kind );
}
}
}
private NativeModule CreateSimpleModule( string name, Context ctx = null )
{
var retVal = new NativeModule( name, ctx );
CreateSimpleVoidNopTestFunction( retVal, name );
return retVal;
}
private static Function CreateSimpleVoidNopTestFunction( NativeModule module, string name )
{
var ctx = module.Context;
Assert.IsNotNull( ctx );
var testFunc = module.AddFunction( name, ctx.GetFunctionType( ctx.VoidType ) );
testFunc.AppendBasicBlock( "entry" );
var irBuilder = new InstructionBuilder( testFunc.EntryBlock );
irBuilder.Return( );
return testFunc;
}
private static Function CreateInvalidFunction( NativeModule module, string name )
{
var ctx = module.Context;
var testFunc = module.AddFunction( name, ctx.GetFunctionType( ctx.VoidType ) );
testFunc.AppendBasicBlock( "entry" );
// UNTERMINATED BLOCK INTENTIONAL
return testFunc;
}
}
}