Class: MachO::Headers::MachHeader

Inherits:
MachOStructure show all
Defined in:
lib/macho/headers.rb

Overview

32-bit Mach-O file header structure

Direct Known Subclasses

MachHeader64

Constant Summary collapse

FORMAT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

"L=7".freeze
SIZEOF =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

28

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from MachOStructure

bytesize, new_from_bin

Constructor Details

#initialize(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds, flags) ⇒ MachHeader

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of MachHeader.



555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/macho/headers.rb', line 555

def initialize(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds,
               flags)
  @magic = magic
  @cputype = cputype
  # For now we're not interested in additional capability bits also to be
  # found in the `cpusubtype` field. We only care about the CPU sub-type.
  @cpusubtype = cpusubtype & ~CPU_SUBTYPE_MASK
  @filetype = filetype
  @ncmds = ncmds
  @sizeofcmds = sizeofcmds
  @flags = flags
end

Instance Attribute Details

#cpusubtype ⇒ Integer (readonly)

Returns the CPU subtype of the Mach-O.

Returns:

  • (Integer) —

    the CPU subtype of the Mach-O



532
533
534
 
# File 'lib/macho/headers.rb', line 532

def cpusubtype
  @cpusubtype
end

#cputype ⇒ Integer (readonly)

Returns the CPU type of the Mach-O.

Returns:

  • (Integer) —

    the CPU type of the Mach-O



529
530
531
 
# File 'lib/macho/headers.rb', line 529

def cputype
  @cputype
end

#filetype ⇒ Integer (readonly)

Returns the file type of the Mach-O.

Returns:

  • (Integer) —

    the file type of the Mach-O



535
536
537
 
# File 'lib/macho/headers.rb', line 535

def filetype
  @filetype
end

#flags ⇒ Integer (readonly)

Returns the header flags associated with the Mach-O.

Returns:

  • (Integer) —

    the header flags associated with the Mach-O



544
545
546
 
# File 'lib/macho/headers.rb', line 544

def flags
  @flags
end

#magic ⇒ Integer (readonly)

Returns the magic number.

Returns:

  • (Integer) —

    the magic number



526
527
528
 
# File 'lib/macho/headers.rb', line 526

def magic
  @magic
end

#ncmds ⇒ Integer (readonly)

Returns the number of load commands in the Mach-O.

Returns:

  • (Integer) —

    the number of load commands in the Mach-O



538
539
540
 
# File 'lib/macho/headers.rb', line 538

def ncmds
  @ncmds
end

#sizeofcmds ⇒ Integer (readonly)

Returns the size of all load commands, in bytes, in the Mach-O.

Returns:

  • (Integer) —

    the size of all load commands, in bytes, in the Mach-O



541
542
543
 
# File 'lib/macho/headers.rb', line 541

def sizeofcmds
  @sizeofcmds
end

Instance Method Details

#alignment ⇒ Integer

Returns the file's internal alignment.

Returns:

  • (Integer) —

    the file's internal alignment



639
640
641
 
# File 'lib/macho/headers.rb', line 639

def alignment
  magic32? ? 4 : 8
end

#bundle? ⇒ Boolean

Returns whether or not the file is of type MH_BUNDLE.

Returns:

  • (Boolean) —

    whether or not the file is of type MH_BUNDLE



614
615
616
 
# File 'lib/macho/headers.rb', line 614

def bundle?
  filetype == Headers::MH_BUNDLE
end

#core? ⇒ Boolean

Returns whether or not the file is of type MH_CORE.

Returns:

  • (Boolean) —

    whether or not the file is of type MH_CORE



594
595
596
 
# File 'lib/macho/headers.rb', line 594

def core?
  filetype == Headers::MH_CORE
end

#dsym? ⇒ Boolean

Returns whether or not the file is of type MH_DSYM.

Returns:

  • (Boolean) —

    whether or not the file is of type MH_DSYM



619
620
621
 
# File 'lib/macho/headers.rb', line 619

def dsym?
  filetype == Headers::MH_DSYM
end

#dylib? ⇒ Boolean

Returns whether or not the file is of type MH_DYLIB.

Returns:

  • (Boolean) —

    whether or not the file is of type MH_DYLIB



604
605
606
 
# File 'lib/macho/headers.rb', line 604

def dylib?
  filetype == Headers::MH_DYLIB
end

#dylinker? ⇒ Boolean

Returns whether or not the file is of type MH_DYLINKER.

Returns:

  • (Boolean) —

    whether or not the file is of type MH_DYLINKER



609
610
611
 
# File 'lib/macho/headers.rb', line 609

def dylinker?
  filetype == Headers::MH_DYLINKER
end

#executable? ⇒ Boolean

Returns whether or not the file is of type MH_EXECUTE.

Returns:

  • (Boolean) —

    whether or not the file is of type MH_EXECUTE



584
585
586
 
# File 'lib/macho/headers.rb', line 584

def executable?
  filetype == Headers::MH_EXECUTE
end

#flag?(flag) ⇒ Boolean

Returns true if flag is present in the header's flag section.

Examples:

puts "this mach-o has position-independent execution" if header.flag?(:MH_PIE)

Parameters:

  • flag (Symbol) —

    a mach header flag symbol

Returns:

  • (Boolean) —

    true if flag is present in the header's flag section



572
573
574
575
576
 
# File 'lib/macho/headers.rb', line 572

def flag?(flag)
  flag = MH_FLAGS[flag]
  return false if flag.nil?
  flags & flag == flag
end

#fvmlib? ⇒ Boolean

Returns whether or not the file is of type MH_FVMLIB.

Returns:

  • (Boolean) —

    whether or not the file is of type MH_FVMLIB



589
590
591
 
# File 'lib/macho/headers.rb', line 589

def fvmlib?
  filetype == Headers::MH_FVMLIB
end

#kext? ⇒ Boolean

Returns whether or not the file is of type MH_KEXT_BUNDLE.

Returns:

  • (Boolean) —

    whether or not the file is of type MH_KEXT_BUNDLE



624
625
626
 
# File 'lib/macho/headers.rb', line 624

def kext?
  filetype == Headers::MH_KEXT_BUNDLE
end

#magic32? ⇒ Boolean

Returns true if the Mach-O has 32-bit magic, false otherwise.

Returns:

  • (Boolean) —

    true if the Mach-O has 32-bit magic, false otherwise



629
630
631
 
# File 'lib/macho/headers.rb', line 629

def magic32?
  Utils.magic32?(magic)
end

#magic64? ⇒ Boolean

Returns true if the Mach-O has 64-bit magic, false otherwise.

Returns:

  • (Boolean) —

    true if the Mach-O has 64-bit magic, false otherwise



634
635
636
 
# File 'lib/macho/headers.rb', line 634

def magic64?
  Utils.magic64?(magic)
end

#object? ⇒ Boolean

Returns whether or not the file is of type MH_OBJECT.

Returns:

  • (Boolean) —

    whether or not the file is of type MH_OBJECT



579
580
581
 
# File 'lib/macho/headers.rb', line 579

def object?
  filetype == Headers::MH_OBJECT
end

#preload? ⇒ Boolean

Returns whether or not the file is of type MH_PRELOAD.

Returns:

  • (Boolean) —

    whether or not the file is of type MH_PRELOAD



599
600
601
 
# File 'lib/macho/headers.rb', line 599

def preload?
  filetype == Headers::MH_PRELOAD
end