2 // Mono.ILASM.MethodDef
5 // Jackson Harper (Jackson@LatitudeGeo.com)
7 // (C) 2003 Jackson Harper, All rights reserved
13 using System.Collections;
14 using System.Security;
16 namespace Mono.ILASM {
18 public class MethodDef : ICustomAttrTarget, IDeclSecurityTarget {
20 private PEAPI.MethAttr meth_attr;
21 private PEAPI.CallConv call_conv;
22 private PEAPI.ImplAttr impl_attr;
24 private string signature;
25 private Hashtable vararg_sig_table;
26 private BaseTypeRef ret_type;
27 private ArrayList param_list;
28 private ArrayList inst_list;
29 private ArrayList customattr_list;
30 private DeclSecurity decl_sec;
31 private Hashtable label_table;
32 private Hashtable labelref_table;
33 private ArrayList label_list;
34 private PEAPI.MethodDef methoddef;
35 private bool entry_point;
36 private bool zero_init;
37 private bool is_resolved;
38 private bool is_defined;
39 private ArrayList local_list;
40 private Hashtable named_local_table;
41 private bool init_locals;
42 private int max_stack;
43 private bool pinvoke_info;
44 private ExternModule pinvoke_mod;
45 private string pinvoke_name;
46 private PEAPI.PInvokeAttr pinvoke_attr;
47 private SourceMethod source;
48 private PEAPI.NativeType ret_native_type;
49 private TypeDef type_def;
50 private GenericParameters gen_params;
52 public MethodDef (CodeGen codegen, PEAPI.MethAttr meth_attr,
53 PEAPI.CallConv call_conv, PEAPI.ImplAttr impl_attr,
54 string name, BaseTypeRef ret_type, ArrayList param_list,
55 Location start, GenericParameters gen_params, TypeDef type_def)
57 this.meth_attr = meth_attr;
58 this.call_conv = call_conv;
59 this.impl_attr = impl_attr;
61 this.ret_type = ret_type;
62 this.param_list = param_list;
63 this.type_def = type_def;
64 this.gen_params = gen_params;
66 inst_list = new ArrayList ();
67 label_table = new Hashtable ();
68 labelref_table = new Hashtable ();
69 label_list = new ArrayList ();
70 local_list = new ArrayList ();
71 named_local_table = new Hashtable ();
84 codegen.BeginMethodDef (this);
86 if (codegen.SymbolWriter != null)
87 source = codegen.SymbolWriter.BeginMethod (this, start);
94 public string Signature {
95 get { return signature; }
98 public BaseTypeRef RetType {
99 get { return ret_type; }
102 public PEAPI.CallConv CallConv {
103 get { return call_conv; }
106 public PEAPI.MethodDef PeapiMethodDef {
107 get { return methoddef; }
110 public PEAPI.MethAttr Attributes {
111 get { return meth_attr; }
112 set { meth_attr = value; }
115 public bool IsVararg {
116 get { return (call_conv & PEAPI.CallConv.Vararg) != 0; }
119 public bool IsStatic {
120 get { return (meth_attr & PEAPI.MethAttr.Static) != 0; }
123 public bool IsVirtual {
124 get { return (meth_attr & PEAPI.MethAttr.Virtual) != 0; }
127 public bool IsAbstract {
128 get { return (meth_attr & PEAPI.MethAttr.Abstract) != 0; }
131 public BaseTypeRef[] ParamTypeList () {
133 if (param_list == null)
134 return new BaseTypeRef[0];
136 BaseTypeRef[] type_list = new BaseTypeRef[param_list.Count];
137 foreach (ParamDef param in param_list) {
138 type_list[count++] = param.Type;
143 public void AddPInvokeInfo (PEAPI.PInvokeAttr pinvoke_attr, ExternModule pinvoke_mod,
146 this.pinvoke_attr = pinvoke_attr;
147 this.pinvoke_mod = pinvoke_mod;
148 this.pinvoke_name = pinvoke_name;
152 public int GenParamCount {
153 get { return (gen_params != null ? gen_params.Count : 0); }
156 public GenericParameter GetGenericParam (string id)
158 if (gen_params == null)
161 return gen_params.GetGenericParam (id);
164 public GenericParameter GetGenericParam (int index)
166 if (gen_params == null || index < 0 || index >= gen_params.Count)
169 return gen_params [index];
172 public int GetGenericParamNum (string id)
174 if (gen_params == null)
177 return gen_params.GetGenericParamNum (id);
180 public void AddParamDefaultValue (int index, PEAPI.Constant defval)
182 if (param_list [index] != null) {
183 ((ParamDef)param_list [index]).AddDefaultValue (defval);
187 public void AddCustomAttribute (CustomAttr customattr)
189 if (customattr_list == null)
190 customattr_list = new ArrayList ();
192 customattr_list.Add (customattr);
195 public void AddPermissionSet (PEAPI.SecurityAction sec_action, PermissionSet ps)
197 if (decl_sec == null)
198 decl_sec = new DeclSecurity ();
200 decl_sec.AddPermissionSet (sec_action, ps);
203 public void AddPermission (PEAPI.SecurityAction sec_action, IPermission iper)
205 if (decl_sec == null)
206 decl_sec = new DeclSecurity ();
208 decl_sec.AddPermission (sec_action, iper);
211 public void AddRetTypeMarshalInfo (PEAPI.NativeType native_type)
213 this.ret_native_type = native_type;
216 public void AddLocals (ArrayList local_list)
218 int slot_pos = this.local_list.Count;
220 foreach (Local local in local_list) {
221 if (local.Slot == -1) {
222 local.Slot = slot_pos;
225 if (local.Name == null)
227 if(!named_local_table.Contains(local.Name))
228 named_local_table.Add (local.Name, local);
231 this.local_list.AddRange (local_list);
234 public Local GetNamedLocal (string name)
236 return (Local) named_local_table[name];
239 public int GetNamedLocalSlot (string name)
241 Local local = (Local) named_local_table[name];
246 public int GetNamedParamPos (string name)
251 foreach (ParamDef param in param_list) {
253 if (param.Name.CompareTo (name) == 0)
260 public ParamDef GetParam (int index)
262 if (param_list [index] != null)
263 return (ParamDef)param_list [index];
268 public void InitLocals ()
273 public void EntryPoint ()
276 throw new Exception ("Non-static method as entrypoint.");
280 public void ZeroInit ()
285 public void SetMaxStack (int max_stack)
287 this.max_stack = max_stack;
290 public void ResolveGenParam (PEAPI.GenParam gpar)
292 if (gpar.Index != -1)
295 if (gpar.Type == PEAPI.GenParamType.MVar)
296 gpar.Index = GetGenericParamNum (gpar.Name);
298 gpar.Index = type_def.GetGenericParamNum (gpar.Name);
301 /* TODO: Report error */
302 throw new Exception (String.Format ("Invalid {0}type parameter '{1}'",
303 (gpar.Type == PEAPI.GenParamType.MVar ? "method " : ""),
307 public void ResolveGenParams ()
309 GenericParameters type_params = (type_def != null) ? type_def.TypeParameters : null;
311 if (gen_params == null && type_params == null)
314 if (gen_params != null)
315 gen_params.ResolveConstraints (type_params, gen_params);
317 BaseGenericTypeRef gtr = ret_type as BaseGenericTypeRef;
319 gtr.Resolve (type_params, gen_params);
321 if (param_list == null)
324 foreach (ParamDef param in param_list) {
325 gtr = param.Type as BaseGenericTypeRef;
327 gtr.Resolve (type_params, gen_params);
331 public PEAPI.MethodDef Resolve (CodeGen code_gen)
333 return Resolve (code_gen, null);
336 public PEAPI.MethodDef Resolve (CodeGen code_gen, PEAPI.ClassDef classdef)
341 PEAPI.Param [] param_array = GenerateParams (code_gen);
343 ret_type.Resolve (code_gen);
345 if (classdef == null)
346 methoddef = code_gen.PEFile.AddMethod (meth_attr, impl_attr,
347 name, ret_type.PeapiType, param_array);
349 methoddef = classdef.AddMethod (meth_attr, impl_attr,
350 name, ret_type.PeapiType, param_array);
352 methoddef.AddCallConv (call_conv);
354 if (ret_native_type != null)
355 methoddef.AddRetTypeMarshallInfo (ret_native_type);
362 private PEAPI.Param [] GenerateParams (CodeGen code_gen)
364 PEAPI.Param[] param_array;
366 if (param_list != null && param_list.Count > 0) {
367 int param_count = param_list.Count;
369 // Remove the last param if its the sentinel, not sure what
370 // should happen with more then one sentinel
371 ParamDef last = (ParamDef) param_list [param_count-1];
372 if (last.IsSentinel ())
375 param_array = new PEAPI.Param [param_count];
376 for (int i = 0; i < param_count; i++) {
377 ParamDef paramdef = (ParamDef) param_list [i];
378 paramdef.Define (code_gen);
379 param_array [i] = paramdef.PeapiParam;
383 param_array = new PEAPI.Param [0];
389 public PEAPI.MethodRef GetVarargSig (PEAPI.Type[] opt)
392 throw new Exception ("Methods must be resolved before a vararg sig can be created.");
394 PEAPI.MethodRef methref = null;
395 StringBuilder sigbuilder = new StringBuilder ();
397 foreach (PEAPI.Type t in opt)
398 sigbuilder.Append (opt + ", ");
399 sig = sigbuilder.ToString ();
401 if (vararg_sig_table == null) {
402 vararg_sig_table = new Hashtable ();
404 methref = vararg_sig_table [sig] as PEAPI.MethodRef;
407 if (methref == null) {
408 methref = methoddef.MakeVarArgSignature (opt);
409 vararg_sig_table [sig] = methref;
416 /// Define a member method
418 public void Define (CodeGen code_gen)
423 if (type_def == null)
425 Resolve (code_gen, null);
427 Resolve (code_gen, (PEAPI.ClassDef) type_def.ClassDef);
429 WriteCode (code_gen, methoddef);
431 //code_gen.Report.Message (String.Format ("Assembled method {0}::{1}", typedef.FullName, name));
435 public void AddInstr (IInstr instr)
437 inst_list.Add (instr);
440 protected void WriteCode (CodeGen code_gen, PEAPI.MethodDef methoddef)
442 /// Add the custrom attributes to this method
443 if (customattr_list != null)
444 foreach (CustomAttr customattr in customattr_list) {
445 customattr.AddTo (code_gen, methoddef);
446 if (customattr.IsSuppressUnmanaged (code_gen))
447 methoddef.AddMethAttribute (PEAPI.MethAttr.HasSecurity);
450 /// Add declarative security to this method
451 if (decl_sec != null) {
452 decl_sec.AddTo (code_gen, methoddef);
453 methoddef.AddMethAttribute (PEAPI.MethAttr.HasSecurity);
456 // Generic type parameters
457 if (gen_params != null)
458 gen_params.Resolve (code_gen, methoddef);
464 methoddef.DeclareEntryPoint ();
466 if (local_list.Count > 0) {
467 int ec = code_gen.Report.ErrorCount;
468 PEAPI.Local[] local_array = new PEAPI.Local[local_list.Count];
470 foreach (Local local in local_list)
471 local_array[local.Slot] = local.GetPeapiLocal (code_gen);
473 if (code_gen.Report.ErrorCount > ec)
479 methoddef.AddLocals (local_array, init_locals);
482 /// Nothing seems to work if maxstack is not set,
483 /// i need to find out if this NEEDs to be set
484 /// and what its default value should be
487 methoddef.SetMaxStack (max_stack);
490 methoddef.AddPInvokeInfo (pinvoke_mod.ModuleRef,
491 (pinvoke_name != null ? pinvoke_name : name), pinvoke_attr);
494 if (inst_list.Count < 1)
497 PEAPI.CILInstructions cil = methoddef.CreateCodeBuffer ();
498 /// Create all the labels
499 /// TODO: Most labels don't actually need to be created so we could
500 /// probably only create the ones that need to be
501 LabelInfo[] label_info = new LabelInfo[label_table.Count + label_list.Count];
502 label_table.Values.CopyTo (label_info, 0);
503 label_list.CopyTo (label_info, label_table.Count);
504 int previous_pos = -1;
505 LabelInfo previous_label = null;
506 Array.Sort (label_info);
508 foreach (LabelInfo label in label_info) {
509 if (label.UseOffset) {
510 label.Define (new PEAPI.CILLabel (label.Offset));
513 if (label.Pos == previous_pos)
514 label.Label = previous_label.Label;
516 label.Define (cil.NewLabel ());
518 previous_label = label;
519 previous_pos = label.Pos;
522 // Set all the label refs
523 foreach (LabelInfo label in labelref_table.Values) {
524 LabelInfo def = (LabelInfo) label_table[label.Name];
526 code_gen.Report.Error ("Undefined Label: " + label);
529 label.Label = def.Label;
533 int next_label_pos = (label_info.Length > 0 ? label_info[0].Pos : -1);
535 for (int i=0; i<inst_list.Count; i++) {
536 IInstr instr = (IInstr) inst_list[i];
537 if (next_label_pos == i) {
538 cil.CodeLabel (label_info[label_pos].Label);
539 if (label_pos < label_info.Length) {
540 while (next_label_pos == i && ++label_pos < label_info.Length) {
541 if (label_info[label_pos].UseOffset)
542 cil.CodeLabel (label_info[label_pos].Label);
543 next_label_pos = label_info[label_pos].Pos;
546 if (label_pos >= label_info.Length)
550 source.MarkLocation (instr.Location.line, cil.Offset);
551 instr.Emit (code_gen, this, cil);
555 source.MarkLocation (source.EndLine, cil.Offset);
558 public LabelInfo AddLabel (string name)
560 LabelInfo label_info = (LabelInfo) label_table[name];
561 if (label_info != null)
563 label_info = new LabelInfo (name, inst_list.Count);
564 label_table.Add (name, label_info);
568 public LabelInfo AddLabelRef (string name)
570 LabelInfo label_info = (LabelInfo) label_table[name];
571 if (label_info != null)
573 label_info = (LabelInfo) labelref_table[name];
574 if (label_info != null)
576 label_info = new LabelInfo (name, -1);
577 labelref_table.Add (name, label_info);
581 public LabelInfo AddLabel (int offset)
583 // We go pos + 1 so this line is not counted
584 LabelInfo label_info = new LabelInfo (null, inst_list.Count+1, (uint) offset);
585 label_list.Add (label_info);
589 public LabelInfo AddLabel ()
591 LabelInfo label_info = new LabelInfo (null, inst_list.Count);
592 label_list.Add (label_info);
596 public PEAPI.CILLabel GetLabelDef (string name)
598 LabelInfo label_info = (LabelInfo) label_table[name];
600 return label_info.Label;
603 public PEAPI.CILLabel GetLabelDef (int pos)
605 foreach (LabelInfo li in label_list) {
612 private void CreateSignature ()
615 signature = CreateVarargSignature (RetType, name, param_list);
617 signature = CreateSignature (RetType, name, param_list, GenParamCount);
620 public static string CreateSignature (BaseTypeRef RetType, string name, IList param_list, int gen_param_count)
622 StringBuilder builder = new StringBuilder ();
624 builder.Append (RetType.FullName);
625 builder.Append (" ");
626 builder.Append (name);
627 if (gen_param_count > 0)
628 builder.AppendFormat ("`{0}", gen_param_count);
629 builder.Append ('(');
631 if (param_list != null) {
633 foreach (ParamDef paramdef in param_list) {
635 builder.Append (',');
636 builder.Append (paramdef.TypeName);
640 builder.Append (')');
642 return builder.ToString ();
645 public static string CreateVarargSignature (BaseTypeRef RetType, string name, IList param_list)
647 StringBuilder builder = new StringBuilder ();
648 ParamDef last = null;
650 builder.Append (RetType.FullName);
651 builder.Append (" ");
652 builder.Append (name);
653 builder.Append ('(');
656 if (param_list != null) {
657 foreach (ParamDef paramdef in param_list) {
659 builder.Append (',');
660 builder.Append (paramdef.TypeName);
663 last = (ParamDef) param_list[param_list.Count - 1];
667 if (last == null || !last.IsSentinel ()) {
669 builder.Append (',');
670 builder.Append ("...");
673 builder.Append (')');
675 return builder.ToString ();
678 public static string CreateVarargSignature (BaseTypeRef RetType, string name, BaseTypeRef [] param_list)
680 StringBuilder builder = new StringBuilder ();
681 BaseTypeRef last = null;
683 builder.Append (RetType.FullName);
684 builder.Append (" ");
685 builder.Append (name);
686 builder.Append ('(');
689 if (param_list != null && param_list.Length > 0) {
690 foreach (BaseTypeRef param in param_list) {
692 builder.Append (',');
693 builder.Append (param.FullName);
696 if (param is SentinelTypeRef)
702 if (last == null || !(last is SentinelTypeRef)) {
704 builder.Append (',');
705 builder.Append ("...");
708 builder.Append (')');
710 return builder.ToString ();
713 public static string CreateSignature (BaseTypeRef RetType, string name, BaseTypeRef[] param_list, int gen_param_count)
715 StringBuilder builder = new StringBuilder ();
717 builder.Append (RetType.FullName);
718 builder.Append (" ");
719 builder.Append (name);
720 if (gen_param_count > 0)
721 builder.AppendFormat ("`{0}", gen_param_count);
722 builder.Append ('(');
724 if (param_list != null) {
726 foreach (BaseTypeRef param in param_list) {
728 builder.Append (',');
729 builder.Append (param.FullName);
731 if (param is SentinelTypeRef)
735 builder.Append (')');
737 return builder.ToString ();
740 private void FixAttributes ()
742 if (name == ".ctor" || name == ".cctor")
743 meth_attr |= PEAPI.MethAttr.SpecialName | PEAPI.MethAttr.RTSpecialName;
744 // If methods aren't flagged as static they are instance
745 if ((PEAPI.MethAttr.Static & meth_attr) == 0)
746 call_conv |= PEAPI.CallConv.Instance;