X-Git-Url: http://wien.tomnetworks.com/gitweb/?a=blobdiff_plain;f=JVM%2FClassFile.hs;h=343d956d2c6bf0e9c32b1be822af194b2a9fd2bb;hb=ab7df4b6e9518cbedb49df5e510c3ababb64dada;hp=ef4916cfc4f5f14e12b909bc59eb0d6257a25d54;hpb=e3c3550bcddba61a4a6e7c5f3715f0385fb4d739;p=hs-java.git diff --git a/JVM/ClassFile.hs b/JVM/ClassFile.hs index ef4916c..343d956 100644 --- a/JVM/ClassFile.hs +++ b/JVM/ClassFile.hs @@ -1,26 +1,69 @@ -{-# LANGUAGE RecordWildCards, BangPatterns #-} +{-# LANGUAGE RecordWildCards, BangPatterns, TypeFamilies, StandaloneDeriving, FlexibleContexts, FlexibleInstances, UndecidableInstances, TypeSynonymInstances #-} -- | This module declares (low-level) data types for Java .class files -- structures, and Binary instances to read/write them. module JVM.ClassFile - (ClassFile (..), - CpInfo (..), - FieldInfo (..), - MethodInfo (..), - AttributeInfo (..), - FieldType, - FieldSignature, MethodSignature (..), ReturnSignature (..) + (-- * About + -- $about + -- + -- + -- * Internal class file structures + Attribute (..), + FieldType (..), + -- * Signatures + FieldSignature, MethodSignature (..), ReturnSignature (..), + ArgumentSignature (..), + -- * Stage types + File, Direct, + -- * Staged structures + Pool, Link, + Method (..), Field (..), Class (..), + Constant (..), + AccessFlag (..), AccessFlags, + Attributes (..), + defaultClass, + -- * Misc + HasSignature (..), HasAttributes (..), + NameType (..), + fieldNameType, methodNameType, + lookupField, lookupMethod, + long, + toString, + className, + apsize, arsize, arlist ) where import Control.Monad +import Control.Monad.Trans (lift) import Control.Applicative +import qualified Control.Monad.State as St import Data.Binary import Data.Binary.IEEE754 import Data.Binary.Get import Data.Binary.Put import Data.Char import Data.List +import Data.Default +import qualified Data.Set as S +import qualified Data.Map as M import qualified Data.ByteString.Lazy as B +import Codec.Binary.UTF8.String hiding (encode, decode) + +-- $about +-- +-- Java .class file uses constants pool, which stores almost all source-code-level +-- constants (strings, integer literals etc), and also all identifiers (class, +-- method, field names etc). All other structures contain indexes of constants in +-- the pool instead of constants theirself. +-- +-- It's not convient to use that indexes programmatically. So, .class file is represented +-- at two stages: File and Direct. At File stage, all data structures contain only indexes, +-- not constants theirself. When we read a class from a file, we get structure at File stage. +-- We only can write File stage structure to file. +-- +-- At Direct stage, structures conain constants, not indexes. Convertion functions (File <-> Direct) +-- are located in the JVM.Converter module. +-- -- | Read one-byte Char getChar8 :: Get Char @@ -28,34 +71,196 @@ getChar8 = do x <- getWord8 return $ chr (fromIntegral x) +toString :: B.ByteString -> String +toString bstr = decodeString $ map (chr . fromIntegral) $ B.unpack bstr + +-- | File stage +data File = File + +-- | Direct representation stage +data Direct = Direct + +-- | Link to some object +type family Link stage a + +-- | At File stage, Link contain index of object in the constants pool. +type instance Link File a = Word16 + +-- | At Direct stage, Link contain object itself. +type instance Link Direct a = a + +-- | Object (class, method, field …) access flags +type family AccessFlags stage + +-- | At File stage, access flags are represented as Word16 +type instance AccessFlags File = Word16 + +-- | At Direct stage, access flags are represented as set of flags. +type instance AccessFlags Direct = S.Set AccessFlag + +-- | Object (class, method, field) attributes +data family Attributes stage + +-- | At File stage, attributes are represented as list of Attribute structures. +data instance Attributes File = AP {attributesList :: [Attribute]} + deriving (Eq, Show) + +instance Default (Attributes File) where + def = AP [] + +-- | At Direct stage, attributes are represented as a Map. +data instance Attributes Direct = AR (M.Map B.ByteString B.ByteString) + deriving (Eq, Show) + +instance Default (Attributes Direct) where + def = AR M.empty + +-- | Size of attributes set at Direct stage +arsize :: Attributes Direct -> Int +arsize (AR m) = M.size m + +-- | Associative list of attributes at Direct stage +arlist :: Attributes Direct -> [(B.ByteString, B.ByteString)] +arlist (AR m) = M.assocs m + +-- | Size of attributes set at File stage +apsize :: Attributes File -> Int +apsize (AP list) = length list + +-- | Access flags. Used for classess, methods, variables. +data AccessFlag = + ACC_PUBLIC -- ^ 0x0001 Visible for all + | ACC_PRIVATE -- ^ 0x0002 Visible only for defined class + | ACC_PROTECTED -- ^ 0x0004 Visible only for subclasses + | ACC_STATIC -- ^ 0x0008 Static method or variable + | ACC_FINAL -- ^ 0x0010 No further subclassing or assignments + | ACC_SYNCHRONIZED -- ^ 0x0020 Uses monitors + | ACC_VOLATILE -- ^ 0x0040 Could not be cached + | ACC_TRANSIENT -- ^ 0x0080 + | ACC_NATIVE -- ^ 0x0100 Implemented in other language + | ACC_INTERFACE -- ^ 0x0200 Class is interface + | ACC_ABSTRACT -- ^ 0x0400 + deriving (Eq, Show, Ord, Enum) + +-- | Fields and methods have signatures. +class (Binary (Signature a), Show (Signature a), Eq (Signature a)) + => HasSignature a where + type Signature a + +instance HasSignature Field where + type Signature Field = FieldSignature + +instance HasSignature Method where + type Signature Method = MethodSignature + +-- | Name and signature pair. Used for methods and fields. +data NameType a = NameType { + ntName :: B.ByteString, + ntSignature :: Signature a } + +instance (HasSignature a) => Show (NameType a) where + show (NameType n t) = toString n ++ ": " ++ show t + +deriving instance HasSignature a => Eq (NameType a) + +instance HasSignature a => Binary (NameType a) where + put (NameType n t) = putLazyByteString n >> put t + + get = NameType <$> get <*> get + +-- | Constant pool item +data Constant stage = + CClass (Link stage B.ByteString) + | CField (Link stage B.ByteString) (Link stage (NameType Field)) + | CMethod (Link stage B.ByteString) (Link stage (NameType Method)) + | CIfaceMethod (Link stage B.ByteString) (Link stage (NameType Method)) + | CString (Link stage B.ByteString) + | CInteger Word32 + | CFloat Float + | CLong Word64 + | CDouble Double + | CNameType (Link stage B.ByteString) (Link stage B.ByteString) + | CUTF8 {getString :: B.ByteString} + | CUnicode {getString :: B.ByteString} + +-- | Name of the CClass. Error on any other constant. +className :: Constant Direct -> B.ByteString +className (CClass s) = s +className x = error $ "Not a class: " ++ show x + +instance Show (Constant Direct) where + show (CClass name) = "class " ++ toString name + show (CField cls nt) = "field " ++ toString cls ++ "." ++ show nt + show (CMethod cls nt) = "method " ++ toString cls ++ "." ++ show nt + show (CIfaceMethod cls nt) = "interface method " ++ toString cls ++ "." ++ show nt + show (CString s) = "String \"" ++ toString s ++ "\"" + show (CInteger x) = show x + show (CFloat x) = show x + show (CLong x) = show x + show (CDouble x) = show x + show (CNameType name tp) = toString name ++ ": " ++ toString tp + show (CUTF8 s) = "UTF8 \"" ++ toString s ++ "\"" + show (CUnicode s) = "Unicode \"" ++ toString s ++ "\"" + +-- | Constant pool +type Pool stage = M.Map Word16 (Constant stage) + -- | Generic .class file format -data ClassFile = ClassFile { +data Class stage = Class { magic :: Word32, -- ^ Magic value: 0xCAFEBABE minorVersion :: Word16, majorVersion :: Word16, constsPoolSize :: Word16, -- ^ Number of items in constants pool - constsPool :: [CpInfo], -- ^ Constants pool itself - accessFlags :: Word16, -- ^ See @JVM.Types.AccessFlag@ - thisClass :: Word16, -- ^ Constants pool item index for this class - superClass :: Word16, -- ^ --/-- for super class, zero for java.lang.Object + constsPool :: Pool stage, -- ^ Constants pool itself + accessFlags :: AccessFlags stage, -- ^ See @JVM.Types.AccessFlag@ + thisClass :: Link stage B.ByteString, -- ^ Constants pool item index for this class + superClass :: Link stage B.ByteString, -- ^ --/-- for super class, zero for java.lang.Object interfacesCount :: Word16, -- ^ Number of implemented interfaces - interfaces :: [Word16], -- ^ Constants pool item indexes for implemented interfaces + interfaces :: [Link stage B.ByteString], -- ^ Constants pool item indexes for implemented interfaces classFieldsCount :: Word16, -- ^ Number of class fileds - classFields :: [FieldInfo], -- ^ Class fields + classFields :: [Field stage], -- ^ Class fields classMethodsCount :: Word16, -- ^ Number of class methods - classMethods :: [MethodInfo], -- ^ Class methods + classMethods :: [Method stage], -- ^ Class methods classAttributesCount :: Word16, -- ^ Number of class attributes - classAttributes :: [AttributeInfo] -- ^ Class attributes + classAttributes :: Attributes stage -- ^ Class attributes } - deriving (Eq, Show) -instance Binary ClassFile where - put (ClassFile {..}) = do +deriving instance Eq (Class File) +deriving instance Eq (Class Direct) +deriving instance Show (Class File) +deriving instance Show (Class Direct) + +deriving instance Eq (Constant File) +deriving instance Eq (Constant Direct) +deriving instance Show (Constant File) + +-- | Default (empty) class file definition. +defaultClass :: (Default (AccessFlags stage), Default (Link stage B.ByteString), Default (Attributes stage)) + => Class stage +defaultClass = Class { + magic = 0xCAFEBABE, + minorVersion = 0, + majorVersion = 50, + constsPoolSize = 0, + constsPool = def, + accessFlags = def, + thisClass = def, + superClass = def, + interfacesCount = 0, + interfaces = [], + classFieldsCount = 0, + classFields = [], + classMethodsCount = 0, + classMethods = [], + classAttributesCount = 0, + classAttributes = def } + +instance Binary (Class File) where + put (Class {..}) = do put magic put minorVersion put majorVersion - put constsPoolSize - forM_ constsPool put + putPool constsPool put accessFlags put thisClass put superClass @@ -66,27 +271,32 @@ instance Binary ClassFile where put classMethodsCount forM_ classMethods put put classAttributesCount - forM_ classAttributes put + forM_ (attributesList classAttributes) put get = do magic <- get + when (magic /= 0xCAFEBABE) $ + fail $ "Invalid .class file MAGIC value: " ++ show magic minor <- get major <- get - poolsize <- get - pool <- replicateM (fromIntegral poolsize - 1) get - af <- get + when (major > 50) $ + fail $ "Too new .class file format: " ++ show major + poolsize <- getWord16be + pool <- getPool (poolsize - 1) + af <- get this <- get super <- get interfacesCount <- get ifaces <- replicateM (fromIntegral interfacesCount) get - classFieldsCount <- get + classFieldsCount <- getWord16be classFields <- replicateM (fromIntegral classFieldsCount) get classMethodsCount <- get classMethods <- replicateM (fromIntegral classMethodsCount) get asCount <- get - as <- replicateM (fromIntegral $ asCount - 1) get - return $ ClassFile magic minor major poolsize pool af this super - interfacesCount ifaces classFieldsCount classFields classMethodsCount classMethods asCount as + as <- replicateM (fromIntegral $ asCount) get + return $ Class magic minor major poolsize pool af this super + interfacesCount ifaces classFieldsCount classFields + classMethodsCount classMethods asCount (AP as) -- | Field signature format data FieldType = @@ -98,8 +308,8 @@ data FieldType = | LongInt -- ^ J | ShortInt -- ^ S | BoolType -- ^ Z - | ObjectType String -- ^ L - | Array (Maybe Int) FieldType -- ^ [ + | ObjectType String -- ^ L @{class name}@ + | Array (Maybe Int) FieldType -- ^ @[{type}@ deriving (Eq) instance Show FieldType where @@ -136,6 +346,9 @@ getInt = do return (c: next) else return [] +putString :: String -> Put +putString str = forM_ str put + instance Binary FieldType where put SignedByte = put 'B' put CharByte = put 'C' @@ -145,7 +358,7 @@ instance Binary FieldType where put LongInt = put 'J' put ShortInt = put 'S' put BoolType = put 'Z' - put (ObjectType name) = put 'L' >> put name + put (ObjectType name) = put 'L' >> putString name >> put ';' put (Array Nothing sig) = put '[' >> put sig put (Array (Just n) sig) = put '[' >> put (show n) >> put sig @@ -248,101 +461,152 @@ whileJust m = do return (x: next) Nothing -> return [] --- | Constant pool item format -data CpInfo = - CONSTANT_Class {nameIndex :: Word16} -- ^ 7 - | CONSTANT_Fieldref {classIndex :: Word16, nameAndTypeIndex :: Word16} -- ^ 9 - | CONSTANT_Methodref {classIndex :: Word16, nameAndTypeIndex :: Word16} -- ^ 10 - | CONSTANT_InterfaceMethodref {classIndex :: Word16, nameAndTypeIndex :: Word16}-- ^ 11 - | CONSTANT_String {stringIndex :: Word16} -- ^ 8 - | CONSTANT_Integer {fourBytes :: Word32} -- ^ 3 - | CONSTANT_Float Float -- ^ 4 - | CONSTANT_Long Word64 -- ^ 5 - | CONSTANT_Double Double -- ^ 6 - | CONSTANT_NameAndType {nameIndex :: Word16, signatureIndex :: Word16} -- ^ 12 - | CONSTANT_Utf8 {stringLength :: Word16, stringBytes :: B.ByteString} -- ^ 1 - | CONSTANT_Unicode {stringLength :: Word16, stringBytes :: B.ByteString} -- ^ 2 - deriving (Eq, Show) - -instance Binary CpInfo where - put (CONSTANT_Class i) = putWord8 7 >> put i - put (CONSTANT_Fieldref i j) = putWord8 9 >> put i >> put j - put (CONSTANT_Methodref i j) = putWord8 10 >> put i >> put j - put (CONSTANT_InterfaceMethodref i j) = putWord8 11 >> put i >> put j - put (CONSTANT_String i) = putWord8 8 >> put i - put (CONSTANT_Integer x) = putWord8 3 >> put x - put (CONSTANT_Float x) = putWord8 4 >> putFloat32be x - put (CONSTANT_Long x) = putWord8 5 >> put x - put (CONSTANT_Double x) = putWord8 6 >> putFloat64be x - put (CONSTANT_NameAndType i j) = putWord8 12 >> put i >> put j - put (CONSTANT_Utf8 l bs) = putWord8 1 >> put l >> putLazyByteString bs - put (CONSTANT_Unicode l bs) = putWord8 2 >> put l >> putLazyByteString bs - - get = do - !offset <- bytesRead - tag <- getWord8 - case tag of - 1 -> do - l <- get - bs <- getLazyByteString (fromIntegral l) - return $ CONSTANT_Utf8 l bs - 2 -> do - l <- get - bs <- getLazyByteString (fromIntegral l) - return $ CONSTANT_Unicode l bs - 3 -> CONSTANT_Integer <$> get - 4 -> CONSTANT_Float <$> getFloat32be - 5 -> CONSTANT_Long <$> get - 6 -> CONSTANT_Double <$> getFloat64be - 7 -> CONSTANT_Class <$> get - 8 -> CONSTANT_String <$> get - 9 -> CONSTANT_Fieldref <$> get <*> get - 10 -> CONSTANT_Methodref <$> get <*> get - 11 -> CONSTANT_InterfaceMethodref <$> get <*> get - 12 -> CONSTANT_NameAndType <$> get <*> get - _ -> fail $ "Unknown constants pool entry tag: " ++ show tag +long :: Constant stage -> Bool +long (CLong _) = True +long (CDouble _) = True +long _ = False + +putPool :: Pool File -> Put +putPool pool = do + let list = M.elems pool + d = length $ filter long list + putWord16be $ fromIntegral (M.size pool + d + 1) + forM_ list putC + where + putC (CClass i) = putWord8 7 >> put i + putC (CField i j) = putWord8 9 >> put i >> put j + putC (CMethod i j) = putWord8 10 >> put i >> put j + putC (CIfaceMethod i j) = putWord8 11 >> put i >> put j + putC (CString i) = putWord8 8 >> put i + putC (CInteger x) = putWord8 3 >> put x + putC (CFloat x) = putWord8 4 >> putFloat32be x + putC (CLong x) = putWord8 5 >> put x + putC (CDouble x) = putWord8 6 >> putFloat64be x + putC (CNameType i j) = putWord8 12 >> put i >> put j + putC (CUTF8 bs) = do + putWord8 1 + put (fromIntegral (B.length bs) :: Word16) + putLazyByteString bs + putC (CUnicode bs) = do + putWord8 2 + put (fromIntegral (B.length bs) :: Word16) + putLazyByteString bs + +getPool :: Word16 -> Get (Pool File) +getPool n = do + items <- St.evalStateT go 1 + return $ M.fromList items + where + go :: St.StateT Word16 Get [(Word16, Constant File)] + go = do + i <- St.get + if i > n + then return [] + else do + c <- lift getC + let i' = if long c + then i+2 + else i+1 + St.put i' + next <- go + return $ (i,c): next + + getC = do + !offset <- bytesRead + tag <- getWord8 + case tag of + 1 -> do + l <- get + bs <- getLazyByteString (fromIntegral (l :: Word16)) + return $ CUTF8 bs + 2 -> do + l <- get + bs <- getLazyByteString (fromIntegral (l :: Word16)) + return $ CUnicode bs + 3 -> CInteger <$> get + 4 -> CFloat <$> getFloat32be + 5 -> CLong <$> get + 6 -> CDouble <$> getFloat64be + 7 -> CClass <$> get + 8 -> CString <$> get + 9 -> CField <$> get <*> get + 10 -> CMethod <$> get <*> get + 11 -> CIfaceMethod <$> get <*> get + 12 -> CNameType <$> get <*> get + _ -> fail $ "Unknown constants pool entry tag: " ++ show tag +-- _ -> return $ CInteger 0 -- | Class field format -data FieldInfo = FieldInfo { - fieldAccessFlags :: Word16, - fieldNameIndex :: Word16, - fieldSignatureIndex :: Word16, +data Field stage = Field { + fieldAccessFlags :: AccessFlags stage, + fieldName :: Link stage B.ByteString, + fieldSignature :: Link stage FieldSignature, fieldAttributesCount :: Word16, - fieldAttributes :: [AttributeInfo] } - deriving (Eq, Show) + fieldAttributes :: Attributes stage } + +deriving instance Eq (Field File) +deriving instance Eq (Field Direct) +deriving instance Show (Field File) +deriving instance Show (Field Direct) + +lookupField :: B.ByteString -> Class Direct -> Maybe (Field Direct) +lookupField name cls = look (classFields cls) + where + look [] = Nothing + look (f:fs) + | fieldName f == name = Just f + | otherwise = look fs + +fieldNameType :: Field Direct -> NameType Field +fieldNameType f = NameType (fieldName f) (fieldSignature f) -instance Binary FieldInfo where - put (FieldInfo {..}) = do +instance Binary (Field File) where + put (Field {..}) = do put fieldAccessFlags - put fieldNameIndex - put fieldSignatureIndex + put fieldName + put fieldSignature put fieldAttributesCount - forM_ fieldAttributes put + forM_ (attributesList fieldAttributes) put get = do af <- get - ni <- get + ni <- getWord16be si <- get - n <- get + n <- getWord16be as <- replicateM (fromIntegral n) get - return $ FieldInfo af ni si n as + return $ Field af ni si n (AP as) -- | Class method format -data MethodInfo = MethodInfo { - methodAccessFlags :: Word16, - methodNameIndex :: Word16, - methodSignatureIndex :: Word16, +data Method stage = Method { + methodAccessFlags :: AccessFlags stage, + methodName :: Link stage B.ByteString, + methodSignature :: Link stage MethodSignature, methodAttributesCount :: Word16, - methodAttributes :: [AttributeInfo] } - deriving (Eq, Show) + methodAttributes :: Attributes stage } + +deriving instance Eq (Method File) +deriving instance Eq (Method Direct) +deriving instance Show (Method File) +deriving instance Show (Method Direct) + +methodNameType :: Method Direct -> NameType Method +methodNameType m = NameType (methodName m) (methodSignature m) -instance Binary MethodInfo where - put (MethodInfo {..}) = do +lookupMethod :: B.ByteString -> Class Direct -> Maybe (Method Direct) +lookupMethod name cls = look (classMethods cls) + where + look [] = Nothing + look (f:fs) + | methodName f == name = Just f + | otherwise = look fs + +instance Binary (Method File) where + put (Method {..}) = do put methodAccessFlags - put methodNameIndex - put methodSignatureIndex + put methodName + put methodSignature put methodAttributesCount - forM_ methodAttributes put + forM_ (attributesList methodAttributes) put get = do offset <- bytesRead @@ -351,27 +615,43 @@ instance Binary MethodInfo where si <- get n <- get as <- replicateM (fromIntegral n) get - return $ MethodInfo af ni si n as + return $ Method { + methodAccessFlags = af, + methodName = ni, + methodSignature = si, + methodAttributesCount = n, + methodAttributes = AP as } -- | Any (class/ field/ method/ ...) attribute format. -- Some formats specify special formats for @attributeValue@. -data AttributeInfo = AttributeInfo { +data Attribute = Attribute { attributeName :: Word16, attributeLength :: Word32, attributeValue :: B.ByteString } deriving (Eq, Show) -instance Binary AttributeInfo where - put (AttributeInfo {..}) = do +instance Binary Attribute where + put (Attribute {..}) = do put attributeName putWord32be attributeLength putLazyByteString attributeValue get = do offset <- bytesRead - name <- get + name <- getWord16be len <- getWord32be value <- getLazyByteString (fromIntegral len) - return $ AttributeInfo name len value + return $ Attribute name len value + +class HasAttributes a where + attributes :: a stage -> Attributes stage + +instance HasAttributes Class where + attributes = classAttributes + +instance HasAttributes Field where + attributes = fieldAttributes +instance HasAttributes Method where + attributes = methodAttributes