kernel/swap/parser/msg_buf.h

   1 /**
   2  * @file parser/msg_buf.h
   3  * @author Vyacheslav Cherkashin
   4  *
   5  * @section LICENSE
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20  *
  21  * @section COPYRIGHT
  22  *
  23  * Copyright (C) Samsung Electronics, 2013
  24  *
  25  * @section DESCRIPTION
  26  *
  27  * Message buffer interface declaration.
  28  */
  29
  30
  31 #ifndef _MSG_BUF_H
  32 #define _MSG_BUF_H
  33
  34 #include <linux/types.h>
  35
  36 /**
  37  * @struct msg_buf
  38  * @brief Stores pointers to the message buffer.
  39  */
  40 struct msg_buf {
  41         char *begin;    /**< Pointer to the beginning of the buffer. */
  42         char *end;      /**< Pointer to the end of the buffer. */
  43         char *ptr;      /**< Buffer iterator. */
  44 };
  45
  46 int init_mb(struct msg_buf *mb, size_t size);
  47 void uninit_mb(struct msg_buf *mb);
  48
  49 int cmp_mb(struct msg_buf *mb, size_t size);
  50 size_t remained_mb(struct msg_buf *mb);
  51 int is_end_mb(struct msg_buf *mb);
  52
  53 int get_u8(struct msg_buf *mb, u8 *val);
  54 int get_u32(struct msg_buf *mb, u32 *val);
  55 int get_u64(struct msg_buf *mb, u64 *val);
  56
  57 int get_string(struct msg_buf *mb, char **str);
  58 void put_string(char *str);
  59
  60 #endif /* _MSG_BUF_H */