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 ParamDef ret_param;
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 TypeDef type_def;
49 private GenericParameters gen_params;
50 private Location start;
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.param_list = param_list;
62 this.type_def = type_def;
63 this.gen_params = gen_params;
64 this.ret_param = new ParamDef (PEAPI.ParamAttr.Default, "", ret_type);
65 this.start = (Location) start.Clone ();
67 inst_list = new ArrayList ();
68 label_table = new Hashtable ();
69 labelref_table = new Hashtable ();
70 label_list = new ArrayList ();
71 local_list = new ArrayList ();
72 named_local_table = new Hashtable ();
85 codegen.BeginMethodDef (this);
87 if (codegen.SymbolWriter != null)
88 source = codegen.SymbolWriter.BeginMethod (this, start);
95 public string Signature {
96 get { return signature; }
99 public BaseTypeRef RetType {
100 get { return ret_param.Type; }
103 public PEAPI.CallConv CallConv {
104 get { return call_conv; }
107 public PEAPI.MethodDef PeapiMethodDef {
108 get { return methoddef; }
111 public PEAPI.MethAttr Attributes {
112 get { return meth_attr; }
113 set { meth_attr = value; }
116 public bool IsVararg {
117 get { return (call_conv & PEAPI.CallConv.Vararg) != 0; }
120 public bool IsStatic {
121 get { return (meth_attr & PEAPI.MethAttr.Static) != 0; }
124 public bool IsVirtual {
125 get { return (meth_attr & PEAPI.MethAttr.Virtual) != 0; }
128 public bool IsAbstract {
129 get { return (meth_attr & PEAPI.MethAttr.Abstract) != 0; }
132 public Location StartLocation {
133 get { return start; }
136 public DeclSecurity DeclSecurity {
138 if (decl_sec == null)
139 decl_sec = new DeclSecurity ();
144 public BaseTypeRef[] ParamTypeList () {
146 if (param_list == null)
147 return new BaseTypeRef[0];
149 BaseTypeRef[] type_list = new BaseTypeRef[param_list.Count];
150 foreach (ParamDef param in param_list) {
151 type_list[count++] = param.Type;
156 public void AddPInvokeInfo (PEAPI.PInvokeAttr pinvoke_attr, ExternModule pinvoke_mod,
159 this.pinvoke_attr = pinvoke_attr;
160 this.pinvoke_mod = pinvoke_mod;
161 this.pinvoke_name = pinvoke_name;
165 public int GenParamCount {
166 get { return (gen_params != null ? gen_params.Count : 0); }
169 public GenericParameter GetGenericParam (string id)
171 if (gen_params == null)
174 return gen_params.GetGenericParam (id);
177 public GenericParameter GetGenericParam (int index)
179 if (gen_params == null || index < 0 || index >= gen_params.Count)
182 return gen_params [index];
185 public int GetGenericParamNum (string id)
187 if (gen_params == null)
190 return gen_params.GetGenericParamNum (id);
193 public void AddCustomAttribute (CustomAttr customattr)
195 if (customattr_list == null)
196 customattr_list = new ArrayList ();
198 customattr_list.Add (customattr);
201 public void AddRetTypeMarshalInfo (PEAPI.NativeType native_type)
203 this.ret_param.AddMarshalInfo (native_type);
206 public void AddLocals (ArrayList local_list)
208 int slot_pos = this.local_list.Count;
210 foreach (Local local in local_list) {
211 if (local.Slot == -1) {
212 local.Slot = slot_pos;
215 if (local.Name == null)
217 if(!named_local_table.Contains(local.Name))
218 named_local_table.Add (local.Name, local);
221 this.local_list.AddRange (local_list);
224 public Local GetNamedLocal (string name)
226 return (Local) named_local_table[name];
229 public int GetNamedLocalSlot (string name)
231 Local local = (Local) named_local_table[name];
236 public int GetNamedParamPos (string name)
239 if (param_list == null)
244 foreach (ParamDef param in param_list) {
246 if (param.Name.CompareTo (name) == 0)
253 /* index - 0: return type
254 * 1: params start from this
256 public ParamDef GetParam (int index)
261 if ((param_list == null) || (index < 0) || (index > param_list.Count))
264 index --; /* param_list has params zero-based */
266 if (param_list [index] != null)
267 return (ParamDef)param_list [index];
272 public void InitLocals ()
277 public void EntryPoint ()
280 Report.Error ("Non-static method as entrypoint.");
284 public void ZeroInit ()
289 public void SetMaxStack (int max_stack)
291 this.max_stack = max_stack;
294 public void ResolveGenParam (PEAPI.GenParam gpar)
296 if (gpar.Index != -1)
299 if (gpar.Type == PEAPI.GenParamType.MVar)
300 gpar.Index = GetGenericParamNum (gpar.Name);
302 gpar.Index = type_def.GetGenericParamNum (gpar.Name);
305 Report.Error (String.Format ("Invalid {0}type parameter '{1}'",
306 (gpar.Type == PEAPI.GenParamType.MVar ? "method " : ""),
310 public void ResolveGenParams ()
312 GenericParameters type_params = (type_def != null) ? type_def.TypeParameters : null;
314 if (gen_params == null && type_params == null)
317 if (gen_params != null)
318 gen_params.ResolveConstraints (type_params, gen_params);
320 BaseGenericTypeRef gtr = RetType as BaseGenericTypeRef;
322 gtr.Resolve (type_params, gen_params);
324 if (param_list == null)
327 foreach (ParamDef param in param_list) {
328 gtr = param.Type as BaseGenericTypeRef;
330 gtr.Resolve (type_params, gen_params);
334 public PEAPI.MethodDef Resolve (CodeGen code_gen)
336 return Resolve (code_gen, null);
339 public PEAPI.MethodDef Resolve (CodeGen code_gen, PEAPI.ClassDef classdef)
344 PEAPI.Param [] param_array = GenerateParams (code_gen);
346 ret_param.Define (code_gen);
348 if (classdef == null)
349 methoddef = code_gen.PEFile.AddMethod (meth_attr, impl_attr,
350 name, ret_param.PeapiParam, param_array);
352 methoddef = classdef.AddMethod (meth_attr, impl_attr,
353 name, ret_param.PeapiParam, param_array);
355 methoddef.AddCallConv (call_conv);
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 InternalErrorException ("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 = 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 (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 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)
562 Report.Error ("Duplicate label '" + name + "'");
564 label_info = new LabelInfo (name, inst_list.Count);
565 label_table [name] = label_info;
569 public LabelInfo AddLabelRef (string name)
571 LabelInfo label_info = (LabelInfo) label_table[name];
572 if (label_info != null)
574 label_info = (LabelInfo) labelref_table[name];
575 if (label_info != null)
577 label_info = new LabelInfo (name, -1);
578 labelref_table.Add (name, label_info);
582 public LabelInfo AddLabel (int offset)
584 // We go pos + 1 so this line is not counted
585 LabelInfo label_info = new LabelInfo (null, inst_list.Count+1, (uint) offset);
586 label_list.Add (label_info);
590 public LabelInfo AddLabel ()
592 LabelInfo label_info = new LabelInfo (null, inst_list.Count);
593 label_list.Add (label_info);
597 public PEAPI.CILLabel GetLabelDef (string name)
599 LabelInfo label_info = (LabelInfo) label_table[name];
601 return label_info.Label;
604 public PEAPI.CILLabel GetLabelDef (int pos)
606 foreach (LabelInfo li in label_list) {
613 private void CreateSignature ()
616 signature = CreateVarargSignature (RetType, name, param_list);
618 signature = CreateSignature (RetType, name, param_list, GenParamCount);
621 public static string CreateSignature (BaseTypeRef RetType, string name, IList param_list, int gen_param_count)
623 StringBuilder builder = new StringBuilder ();
625 builder.Append (RetType.FullName);
626 builder.Append (" ");
627 builder.Append (name);
628 if (gen_param_count > 0)
629 builder.AppendFormat ("`{0}", gen_param_count);
630 builder.Append ('(');
632 if (param_list != null) {
634 foreach (ParamDef paramdef in param_list) {
636 builder.Append (',');
637 builder.Append (paramdef.TypeName);
641 builder.Append (')');
643 return builder.ToString ();
646 public static string CreateVarargSignature (BaseTypeRef RetType, string name, IList param_list)
648 StringBuilder builder = new StringBuilder ();
649 ParamDef last = null;
651 builder.Append (RetType.FullName);
652 builder.Append (" ");
653 builder.Append (name);
654 builder.Append ('(');
657 if (param_list != null) {
658 foreach (ParamDef paramdef in param_list) {
660 builder.Append (',');
661 builder.Append (paramdef.TypeName);
664 last = (ParamDef) param_list[param_list.Count - 1];
668 if (last == null || !last.IsSentinel ()) {
670 builder.Append (',');
671 builder.Append ("...");
674 builder.Append (')');
676 return builder.ToString ();
679 public static string CreateVarargSignature (BaseTypeRef RetType, string name, BaseTypeRef [] param_list)
681 StringBuilder builder = new StringBuilder ();
682 BaseTypeRef last = null;
684 builder.Append (RetType.FullName);
685 builder.Append (" ");
686 builder.Append (name);
687 builder.Append ('(');
690 if (param_list != null && param_list.Length > 0) {
691 foreach (BaseTypeRef param in param_list) {
693 builder.Append (',');
694 builder.Append (param.FullName);
697 if (param is SentinelTypeRef)
703 if (last == null || !(last is SentinelTypeRef)) {
705 builder.Append (',');
706 builder.Append ("...");
709 builder.Append (')');
711 return builder.ToString ();
714 public static string CreateSignature (BaseTypeRef RetType, string name, BaseTypeRef[] param_list, int gen_param_count)
716 StringBuilder builder = new StringBuilder ();
718 builder.Append (RetType.FullName);
719 builder.Append (" ");
720 builder.Append (name);
721 if (gen_param_count > 0)
722 builder.AppendFormat ("`{0}", gen_param_count);
723 builder.Append ('(');
725 if (param_list != null) {
727 foreach (BaseTypeRef param in param_list) {
729 builder.Append (',');
730 builder.Append (param.FullName);
732 if (param is SentinelTypeRef)
736 builder.Append (')');
738 return builder.ToString ();
741 private void FixAttributes ()
743 if (name == ".ctor" || name == ".cctor")
744 meth_attr |= PEAPI.MethAttr.SpecialName | PEAPI.MethAttr.RTSpecialName;
745 // If methods aren't flagged as static they are instance
746 if ((PEAPI.MethAttr.Static & meth_attr) == 0)
747 call_conv |= PEAPI.CallConv.Instance;