nm_headers.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 2006-2026 (see AUTHORS file)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */
 
#ifndef NM_HEADERS_H
#define NM_HEADERS_H
 
struct nm_header_global_s
{
  uint16_t v0len; 
} __attribute__((packed));
 
#define NM_PROTO_ID_MASK        0x0F
#define NM_PROTO_FLAG_MASK      0xF0
 
#define NM_PROTO_SMALL_DATA     0x01
#define NM_PROTO_SHORT_DATA     0x02
#define NM_PROTO_PKT_DATA       0x03
#define NM_PROTO_RDV            0x04
#define NM_PROTO_RTR            0x05
#define NM_PROTO_ACK            0x06
#define NM_PROTO_STRAT          0x07
#define NM_PROTO_MSG            0x08
#define NM_PROTO_DEBUG          0x0F
 
#define NM_PROTO_FLAG_LASTCHUNK 0x10
#define NM_PROTO_FLAG_ALIGNED   0x20
#define NM_PROTO_FLAG_ACKREQ    0x40
 
 
/* Warning : All header structs (except the global one) _MUST_ begin
 * with the 'proto_id' field
 */
 
struct nm_header_pkt_data_s
{
  nm_proto_t    proto_id;     
  nm_core_tag_t tag_id;       
  nm_seq_t      seq;          
  nm_len_t      data_len;     
  nm_len_t      chunk_offset; 
  uint16_t      hlen;         
} __attribute__((packed));
struct nm_header_pkt_data_chunk_s
{
  uint16_t len;  
  uint16_t skip; 
} __attribute__((packed));
 
struct nm_header_data_s
{
  nm_proto_t proto_id;   
  nm_core_tag_t tag_id;  
  nm_seq_t seq;          
  nm_len_t len;
  nm_len_t chunk_offset;
  uint16_t skip;         
} __attribute__((packed));
 
struct nm_header_short_data_s
{
  nm_proto_t proto_id;    
  nm_core_tag_t tag_id;
  nm_seq_t seq;
  uint8_t len;
} __attribute__((packed));
 
struct nm_header_msg_s
{
  nm_proto_t proto_id;    
  nm_core_tag_t tag_id;
  nm_seq_t seq;
  nm_len_t msg_len;
} __attribute__((packed));
 
struct nm_header_ctrl_rdv_s
{
  nm_proto_t proto_id;    
  nm_core_tag_t tag_id;
  nm_seq_t seq;
  nm_len_t chunk_offset;  
  nm_len_t chunk_len;     
  nm_len_t msg_len;       
  nm_prio_t priority;
  int is_contig_data;     
} __attribute__((packed));
 
struct nm_header_ctrl_rtr_s
{
  nm_proto_t proto_id;  
  nm_core_tag_t tag_id; 
  nm_seq_t seq;
  nm_trk_id_t trk_id;   
  nm_len_t chunk_offset;
  nm_len_t chunk_len;
  nm_len_t payload_size;
} __attribute__((packed));
 
struct nm_header_ctrl_ack_s
{
  nm_proto_t proto_id;  
  nm_core_tag_t tag_id;
  nm_seq_t seq;
} __attribute__((packed));
 
struct nm_header_common_s
{
  nm_proto_t proto_id;
  nm_core_tag_t tag_id;
  nm_seq_t seq;
} __attribute__((packed));
 
union nm_header_ctrl_generic_s
{
  struct nm_header_msg_s msg;
  struct nm_header_ctrl_rdv_s rdv;
  struct nm_header_ctrl_rtr_s rtr;
  struct nm_header_ctrl_ack_s ack;
  struct nm_header_common_s generic;
};
union nm_header_data_generic_s
{
  struct nm_header_pkt_data_s pkt_data;
  struct nm_header_short_data_s short_data;
  struct nm_header_data_s data;
  struct nm_header_common_s generic;
};
union nm_header_generic_s
{
  struct nm_header_common_s generic;
  struct nm_header_pkt_data_s pkt_data;
  struct nm_header_short_data_s short_data;
  struct nm_header_data_s data;
  struct nm_header_msg_s msg;
  struct nm_header_ctrl_rdv_s rdv;
  struct nm_header_ctrl_rtr_s rtr;
  struct nm_header_ctrl_ack_s ack;
};
 
struct nm_header_strat_s
{
  nm_proto_t proto_id; 
  nm_len_t size;
};
 
struct nm_header_debug_s
{
  nm_proto_t proto_id;
  uint64_t req;         
} __attribute__((packed));
 
typedef union nm_header_ctrl_generic_s nm_header_ctrl_generic_t;
typedef union nm_header_data_generic_s nm_header_data_generic_t;
 
PUK_LIST_DECLARE_TYPE(nm_ctrl_chunk);
 
struct nm_ctrl_chunk_s
{
  PUK_LIST_LINK(nm_ctrl_chunk);
  nm_gate_t p_gate;
  nm_header_ctrl_generic_t ctrl;
  const void*p_payload; 
  nm_len_t size;        
};
PUK_LIST_CREATE_FUNCS(nm_ctrl_chunk);
 
PUK_ALLOCATOR_TYPE_SINGLE(nm_ctrl_chunk, struct nm_ctrl_chunk_s);
 
 
#define NM_HEADER_PKT_DATA_SIZE                         \
  sizeof(struct nm_header_pkt_data_s)
 
#define NM_HEADER_DATA_SIZE                             \
  nm_aligned(sizeof(struct nm_header_data_s))
 
#define NM_HEADER_SHORT_DATA_SIZE                       \
  nm_aligned(sizeof(struct nm_header_short_data_s))
 
#define NM_HEADER_CTRL_SIZE(P_CTRL)                     \
  nm_header_ctrl_size(P_CTRL)
 
static inline size_t nm_header_ctrl_size(const union nm_header_ctrl_generic_s*const p_ctrl)
{
  switch(p_ctrl->generic.proto_id & NM_PROTO_ID_MASK)
    {
    case NM_PROTO_RDV:
      return sizeof(struct nm_header_ctrl_rdv_s);
      break;
    case NM_PROTO_RTR:
      return sizeof(struct nm_header_ctrl_rtr_s);
      break;
    case NM_PROTO_ACK:
      return sizeof(struct nm_header_ctrl_ack_s);
      break;
    case NM_PROTO_MSG:
      return sizeof(struct nm_header_msg_s);
      break;
    default:
      NM_FATAL("invalid kind 0x%x for control header.\n", p_ctrl->generic.proto_id);
      break;
    }
}
 
static inline void nm_header_init_pkt_data(struct nm_header_pkt_data_s*p_header, nm_core_tag_t tag_id, nm_seq_t seq, uint8_t flags,
                                           nm_len_t len, nm_len_t chunk_offset)
{
  assert((flags & NM_PROTO_ID_MASK) == 0x00);
  p_header->proto_id = NM_PROTO_PKT_DATA | flags;
  p_header->tag_id   = tag_id;
  p_header->seq      = seq;
  p_header->data_len = len;
  p_header->chunk_offset = chunk_offset;
  p_header->hlen = NM_HEADER_PKT_DATA_SIZE;
}
 
static inline void nm_header_init_data(struct nm_header_data_s*p_header, nm_core_tag_t tag_id, nm_seq_t seq, uint8_t flags,
                                       uint16_t skip, nm_len_t len, nm_len_t chunk_offset)
{
  assert((flags & NM_PROTO_ID_MASK) == 0x00);
  p_header->proto_id = NM_PROTO_SMALL_DATA | flags;
  p_header->tag_id   = tag_id;
  p_header->seq      = seq;
  p_header->skip     = skip;
  p_header->len      = len;
  p_header->chunk_offset = chunk_offset;
}
 
static inline void nm_header_init_short_data(struct nm_header_short_data_s*p_header, nm_core_tag_t tag_id,
                                             nm_seq_t seq, nm_len_t len)
{
  p_header->proto_id = NM_PROTO_SHORT_DATA | NM_PROTO_FLAG_LASTCHUNK;
  p_header->tag_id   = tag_id;
  p_header->seq      = seq;
  p_header->len      = len;
}
 
static inline void nm_header_init_msg(union nm_header_ctrl_generic_s*p_ctrl, nm_core_tag_t tag_id, nm_seq_t seq, nm_len_t msg_len)
{
  p_ctrl->msg.proto_id = NM_PROTO_MSG;
  p_ctrl->msg.tag_id   = tag_id;
  p_ctrl->msg.seq      = seq;
  p_ctrl->msg.msg_len  = msg_len;
 }
 
static inline void nm_header_init_rdv(union nm_header_ctrl_generic_s*p_ctrl, struct nm_req_s*p_pack,
                                      nm_len_t chunk_len, nm_len_t chunk_offset, int is_contig_data, uint8_t rdv_flags)
{
  if(p_pack->flags & NM_REQ_FLAG_PACK_SYNCHRONOUS)
    rdv_flags |= NM_PROTO_FLAG_ACKREQ;
  assert((rdv_flags & NM_PROTO_ID_MASK) == 0);
  p_ctrl->rdv.proto_id     = NM_PROTO_RDV | rdv_flags;
  p_ctrl->rdv.tag_id       = p_pack->tag;
  p_ctrl->rdv.seq          = p_pack->seq;
  p_ctrl->rdv.chunk_offset = chunk_offset;
  p_ctrl->rdv.chunk_len    = chunk_len;
  p_ctrl->rdv.msg_len      = p_pack->pack.len;
  p_ctrl->rdv.priority     = p_pack->pack.priority;
  p_ctrl->rdv.is_contig_data = is_contig_data;
}
 
static inline void nm_header_init_rtr(union nm_header_ctrl_generic_s*p_ctrl, nm_core_tag_t tag, nm_seq_t seq,
                                      nm_trk_id_t trk_id, nm_len_t chunk_offset, nm_len_t chunk_len, nm_len_t payload_size)
{
  p_ctrl->rtr.proto_id     = NM_PROTO_RTR;
  p_ctrl->rtr.tag_id       = tag;
  p_ctrl->rtr.seq          = seq;
  p_ctrl->rtr.trk_id       = trk_id;
  p_ctrl->rtr.chunk_offset = chunk_offset;
  p_ctrl->rtr.chunk_len    = chunk_len;
  p_ctrl->rtr.payload_size = payload_size;
}
 
static inline void nm_header_init_ack(union nm_header_ctrl_generic_s*p_ctrl, nm_core_tag_t tag, nm_seq_t seq)
{
  p_ctrl->ack.proto_id = NM_PROTO_ACK;
  p_ctrl->ack.tag_id   = tag;
  p_ctrl->ack.seq      = seq;
}
 
static inline void nm_header_init_debug(struct nm_header_debug_s*p_header, int req)
{
  p_header->proto_id = NM_PROTO_DEBUG;
  p_header->req = req;
}
 
#endif /* NM_HEADER_H */