使用管道的顺序二进制数据解码

时间:2012-09-24 16:13:21

标签: haskell protocol-buffers conduit

目标是拥有一个带有以下类型签名的管道

protobufConduit :: MonadResource m => (ByteString -> a) -> Conduit ByteString m a

管道应重复解析通过TCP / IP(使用ByteString -> a包)收到的协议缓冲区(使用network-conduit功能)。

有线消息格式为

{length (32 bits big endian)}{protobuf 1}{length}{protobuf 2}...

(花括号不是协议的一方,仅用于分隔实体)。

第一个想法是使用sequenceSink重复应用能够解析一个ProtoBuf的Sink

[...]
import qualified Data.Binary         as B
import qualified Data.Conduit.Binary as CB
import qualified Data.Conduit.Util   as CU

protobufConduit :: MonadResource m => (ByteString -> a) -> Conduit ByteString m a
protobufConduit protobufDecode =
    CU.sequenceSink () $ \() ->
        do lenBytes <- CB.take 4                                -- read protobuf length
           let len :: Word32
               len = B.decode lengthBytes                       -- decode ProtoBuf length
               intLen = fromIntegral len
           protobufBytes <- CB.take intLen                      -- read the ProtoBuf bytes
           return $ CU.Emit () [ protobufDecode protobufBytes ] -- emit decoded ProtoBuf

它不起作用(仅适用于第一个协议缓冲区),因为似乎已从源中读取了许多“剩余”字节,但未被丢弃的CB.take消耗。

我发现无法将“其余部分推回源头”。

我的概念完全错了吗?

PS:即使我在这里使用协议缓冲区,问题也与协议缓冲区无关。为了调试这个问题,我总是使用{length}{UTF8 encoded string}{length}{UTF8 encoded string}...和类似上面的导管(utf8StringConduit :: MonadResource m => Conduit ByteString m Text)。

更新

我只是尝试用剩余的字节替换上面示例中的状态(上面的示例中没有状态())并通过调用首先消耗已读取字节的函数来替换CB.take调用(来自状态)并仅在需要时调用await(当状态不够大时)。不幸的是,这不起作用,因为只要Source没有剩余字节,sequenceSink就不会执行代码,但状态仍然包含剩余的字节: - (。

如果您对代码感兴趣(代码不优化或非常好,但应足以测试):

utf8StringConduit :: forall m. MonadResource m => Conduit ByteString m Text
utf8StringConduit =
    CU.sequenceSink [] $ \st ->
        do (lengthBytes, st') <- takeWithState BS.empty st 4
           let len :: Word32
               len = B.decode $ BSL.fromChunks [lengthBytes]
               intLength = fromIntegral len
           (textBytes, st'') <- takeWithState BS.empty st' intLength
           return $ CU.Emit st'' [ TE.decodeUtf8 $ textBytes ]

takeWithState :: Monad m
              => ByteString
              -> [ByteString]
              -> Int
              -> Pipe l ByteString o u m (ByteString, [ByteString])
takeWithState acc state 0 = return (acc, state)
takeWithState acc state neededLen =
    let stateLenSum = foldl' (+) 0 $ map BS.length state
     in if stateLenSum >= neededLen
           then do let (firstChunk:state') = state
                       (neededChunk, pushBack) = BS.splitAt neededLen firstChunk
                       acc' = acc `BS.append` neededChunk
                       neededLen' = neededLen - BS.length neededChunk
                       state'' = if BS.null pushBack
                                    then state'
                                    else pushBack:state'
                   takeWithState acc' state'' neededLen'
           else do aM <- await
                   case aM of
                     Just a -> takeWithState acc (state ++ [a]) neededLen
                     Nothing -> error "to be fixed later"

1 个答案:

答案 0 :(得分:4)

对于协议缓冲区解析和序列化,我们使用messageWithLengthPutMmessageWithLengthGetM(见下文)但我假设它使用长度的varint编码,这不是你需要的。我可能会尝试通过用{/ p>之类的东西替换messageWithLength Get / Put来调整我们的实现

myMessageWithLengthGetM = 
   do size <- getWord32be 
      getMessageWithSize size

但我不知道如何使用协议缓冲包中的可用函数来实现getMessageWithSize。另一方面,你可以只getByteString然后“重新分析”字节串。

关于管道:您是否尝试在没有Data.Conduit.Util的情况下实施管道?像

这样的东西
protobufConduit protobufDecode = loop
   where
      loop = 
         do len <- liftM convertLen (CB.take 4)
            bs <- CB.take len
            yield (protobufDecode bs)
            loop

以下是我们使用的代码:

pbufSerialize :: (ReflectDescriptor w, Wire w) => Conduit w IO ByteString
pbufSerialize = awaitForever f
    where f pb = M.mapM_ yield $ BSL.toChunks $ runPut (messageWithLengthPutM pb)

pbufParse :: (ReflectDescriptor w, Wire w, Show w) => Conduit ByteString IO w
pbufParse = new
    where
      new = read (runGet messageWithLengthGetM . BSL.fromChunks . (:[]))
      read parse =
          do mbs <- await
             case mbs of
               Just bs -> checkResult (parse bs)
               Nothing -> return ()
      checkResult result =
          case result of
            Failed _ errmsg -> fail errmsg
            Partial cont -> read (cont . Just . BSL.fromChunks . (:[]))
            Finished rest _ msg ->
                do yield msg
                   checkResult (runGet messageWithLengthGetM rest)