/*
 * Copyright (c) 2007 Shakir James and Washington University in St. Louis.
 * All rights reserved
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. The name of the author or Washington University may not be used 
 *       to endorse or promote products derived from this source code 
 *       without specific prior written permission.
 *    4. Conditions of any other entities that contributed to this are also
 *       met. If a copyright notice is present from another entity, it must
 *       be maintained in redistributions of the source code.
 *
 * THIS INTELLECTUAL PROPERTY (WHICH MAY INCLUDE BUT IS NOT LIMITED TO SOFTWARE,
 * FIRMWARE, VHDL, etc) IS PROVIDED BY THE AUTHOR AND WASHINGTON UNIVERSITY 
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR WASHINGTON UNIVERSITY 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS INTELLECTUAL PROPERTY, EVEN IF 
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * */
/*
 * File: log-new.c  
 * Author: Jessica Codr
 * Email: jmc5@cec.wustl.edu
 * Organization: Applied Research Laboratory
 * 
 * Derived from: nstats.c and ipHdr.c
 *
 * Date Created: 07/21/08
 * 
 * Description: copy packet header info into a separate udp
 *  packet and send this packet to a separate logging process.
 *
 * Modification History:
 *
 */

#ifndef _PLUGIN_LOG_C
#define _PLUGIN_LOG_C


//
//
// NOTE: See pluginFramework/null.c (null plugin) 
//       for description pre-processors values
//
//

#include "plugin_api.h"
#include <stdlib.h>
#include "sram_rings_WU.h"


//-----------------------------------------------------------
// Global variables/Registers
//-----------------------------------------------------------
// thread-specific globals 
__declspec(gp_reg) int dlNextBlock;  // where to send packets to next
__declspec(gp_reg) int dlFromBlock;  // where to get packets from
__declspec(gp_reg) int msgNextBlock; // where to send control messages to next
__declspec(gp_reg) int msgFromBlock; // where to get control messages from

// see ring_formats.h for struct definitions
volatile __declspec(gp_reg) plc_plugin_data ring_in;  // ring data from PLC
volatile __declspec(gp_reg) plugin_out_data ring_out; // ring data to next block


__declspec(local_mem) unsigned int timeout; // time (cycles) between callbacks
__declspec(gp_reg) unsigned int pluginId;  // plugin id (0...7)

__declspec(shared gp_reg) int curPkt;
__declspec(shared gp_reg) int prevPkt;
__declspec(shared gp_reg) int stride;
__declspec(shared gp_reg) unsigned int deterministic;
__declspec(shared gp_reg) unsigned int probability;
__declspec(shared gp_reg) int nextDroppable;  //kinda like next drop for probabalistic
__declspec(shared gp_reg) int probMult;
__declspec(shared gp_reg) unsigned int count;
__declspec(shared gp_reg) unsigned int damages;


//-----------------------------------------------------------
// Function prototypes
//-----------------------------------------------------------
void handle_pkt_user();
void handle_msg_user();
void callback_user();
void plugin_init_user();


//delcared here so can use in handle_pkt_user() w/out implicit delcaration
void default_format_out_data(unsigned int nextblock);

void handle_pkt_user()  {

    __declspec(gp_reg) onl_api_ip_hdr ipv4_hdr; // defined in ixp_lib.h
    __declspec(gp_reg) buf_handle_t buf_handle;  // see dl_buf.h, ixp_lib.h   
    __declspec(gp_reg) onl_api_buf_desc bufDescriptor;  // see dl_buf.h, ixp_lib.h
    __declspec(gp_reg) onl_api_udp_hdr udp_hdr;
    __declspec(local_mem) sixteenWordsOfData payload;
    unsigned int bufDescPtr;  //some of these might need to sram
    unsigned int ipv4HdrPtr;
    unsigned int dramBufferPtr;
    unsigned int udpHdrPtr;
    unsigned int payloadPtr;

    __declspec(local_mem) char dataStr[9];
    __declspec(local_mem) char damageStr[8] = "DAMAGE!\0";

    // Read the buf handle from the input Ring
    onl_api_get_buf_handle(&buf_handle); 
    bufDescPtr = onl_api_getBufferDescriptorPtr(buf_handle);
    onl_api_readBufferDescriptor(bufDescPtr, &bufDescriptor);
    dramBufferPtr = onl_api_getBufferPtr(buf_handle);
    ipv4HdrPtr = onl_api_getIpv4HdrPtr(dramBufferPtr, bufDescriptor.offset);
    onl_api_readIpv4Hdr(ipv4HdrPtr, &ipv4_hdr);       
    udpHdrPtr = onl_api_getUdpHdrPtr(ipv4HdrPtr, ipv4_hdr.ip_hl);
    payloadPtr = onl_api_getUdpPacketPayloadPtr(udpHdrPtr);

    onl_api_readUdpHdr(udpHdrPtr, &udp_hdr);

    onl_api_ua_read_8W_dram(payloadPtr, (void *) &payload);

    curPkt = (int) ((payload.i[2]) >> 24); 

    if(prevPkt != curPkt && (curPkt == 0 || curPkt == 1)){ 
	nextDroppable = curPkt;
    }

    //when I add this, the plugin completely breaks and no packets get through:
    if(curPkt >= 0x1d){ //does it not realize curPkt is 29?
	nextDroppable = curPkt;
    }

    onl_api_int2str(curPkt, dataStr);
    onl_api_debug_message(msgNextBlock, dataStr); 

    onl_api_int2str(nextDroppable, dataStr);
    onl_api_debug_message(msgNextBlock, dataStr); 


	//why isn't 29 == 29???
    //commenting the "if" part and having everything checked for
    //dropability causes the compliler to say there isn't enough
    //memory for local variables.....
    if(nextDroppable == curPkt){

	nextDroppable = nextDroppable + 1;
	count = count + 1;

    	if((deterministic > 0 && (curPkt % stride) == 0) || 
	   (deterministic == 0 && rand() < probability)){ 
		
		damages = damages + 1;

		//damage payload

    		payload.i[0] = ((int)(('X' << 24) & 0xFF000000)) |
			((int)(('X' << 16) & 0xFF0000)) |
			((int) (('X' << 8) & 0xFF00)) |
			((int) (('X'<< 0) & 0xFF));
    		payload.i[1] = ((int)(('X' << 24) & 0xFF000000)) |
			((int)(('X' << 16) & 0xFF0000)) |
			((int) (('X' << 8) & 0xFF00)) |
			((int) (('\0'<< 0) & 0xFF));
    	
		udp_hdr.uh_sum = 0;	

		//save damages
		onl_api_ua_write_8W_dram(payloadPtr, (void *) &payload);
    		onl_api_writeUdpHdr(udpHdrPtr, &udp_hdr);
	}
    }

  prevPkt = curPkt;

}

void handle_msg_user(){}

void callback_user() {
}


void plugin_init_user() {

	if(ctx() == 0){
		probMult = (RAND_MAX / 100) * 2;
		stride = 4;
		deterministic = 1;
		probability = 20 * probMult;
		nextDroppable = -1;
	}

}


static __forceinline __declspec(local_mem) unsigned int
kenw_atoi(__declspec(local_mem) char *p ) {
    __declspec(gp_reg) unsigned int x = 0;
    __declspec(gp_reg) int	     y;

    //added && *p != ' ' to keep from adding digits after ' ' -jmc5
    while( *p != '\0' && *p != ' ') {
    	if( *p != ' ' )	{
    	    x *= 10;
    	    y = *p - '0';
	    if( (y<0) || (y>9) )	return 0;
	    x += y;
	}
	p++;
    }
    return x;
}

static __forceinline __declspec(local_mem) char *
nxt_token(__declspec(local_mem) char *p ) {

    while( *p != '\0' ) {  //find SP char
    	if( *p == ' ' )	break;
	p++;
    }
    if( *p == '\0' )	return 0;
    ++p;

    while(*p != '\0' ) {		// scan past SP characters
    	if( *p == ' ' )	++p;
	else		break;
    }

    if( *p == '\0' )	return 0;
    else		return p;
}


// fills valstr with the decimal representation of val
__forceinline void onl_api_int2dstr(__declspec(gp_reg) unsigned int val, __declspec(local_mem) char valcalc[9])
{
  //__declspec(gp_reg) unsigned int c;
  __declspec(gp_reg) unsigned int i = 0;
  __declspec(gp_reg) unsigned int j = 0;
  __declspec(gp_reg) unsigned int addVal = 1;
  __declspec(gp_reg) unsigned int addValCopy = 1;
  __declspec(gp_reg) unsigned int numDigits = 1;
  //__declspec(gp_reg) unsigned int found_non_zero = 0;
  __declspec(gp_reg) unsigned int nine = 57;
  __declspec(gp_reg) unsigned int zero = 48;
  //__declspec(sram) unsigned int tmpholder;

  valcalc[i] = 48;

  while(val > 0){
  
 	if(val & 0x1){
		addValCopy = addVal;
		//definitely is an easier way to do this, eg adding in 100s or 10s...
		while(addValCopy >= 196){ //to avoid wrap-arounds w/ chars
			i = numDigits - 1;
			valcalc[i] = valcalc[i] + 196;  //problems w/ this exceeding range of chars?
			while(valcalc[i] > nine){
				if(i==0){ // shift digits over for more space if needed. 
					//NOTE:  need to add accounting for too many digits
					j = numDigits;
					while(j>0){ //remember that j is unsigned!!!!
						valcalc[j] = valcalc[j-1];
						j = j - 1;
					}
					valcalc[0] = zero;
					i = 1;
					numDigits = numDigits + 1;
				}	
				valcalc[i] -= 10;
				valcalc[i-1] += 1;
				if(valcalc[i] <= nine && i > 0){
					i -= 1;
				}
			}
			addValCopy = addValCopy - 196;
		
		}
		i = numDigits - 1;
		valcalc[i] = valcalc[i] + addValCopy;  //problems w/ this exceeding range of chars?
		while(valcalc[i] > nine){
			if(i==0){ // shift digits over for more space if needed. 
				//NOTE:  need to add accounting for too many digits
				j = numDigits;
				while(j>0){ //remember that j is unsigned!!!!
					valcalc[j] = valcalc[j-1];
					j = j - 1;
				}
				valcalc[0] = zero;
				i = 1;
				numDigits = numDigits + 1;
			}	
			valcalc[i] -= 10;
			valcalc[i-1] += 1;
			if(valcalc[i] <= nine && i > 0){
				i -= 1;
			}
		}
  	}
	val = val >> 1;
  	addVal = addVal * 2;
  }
  /*j = 0;
  while(j < numDigits){
  	valdstr[j] = valcalc[j];
	j = j + 1;
  }*/
  valcalc[numDigits] = '\0';
}


/**
	----------------------------------------------------------------
 @User: YOU SHOULD NOT NEED TO MAKE ANY CHANGES TO THE REST OF THIS FILE
	----------------------------------------------------------------
*/





void default_format_out_data(unsigned int nextblock)
{
  __declspec(gp_reg) int out_port;
  if(nextblock == QM)
  {
    __declspec(gp_reg) dl_buf_handle_t buf_handle;
    __declspec(sram) unsigned int *buf_desc_ptr;
    __declspec(sram_write_reg) unsigned int sram_wr_regs[3];
    SIGNAL sram_sig;

    // assume unicast
    out_port = (ring_in.uc_mc_bits >> 3) & 0x7;
    ring_out.plugin_qm_data_out.out_port = out_port;

    ring_out.plugin_qm_data_out.qid = ((out_port+1) << 13) | ring_in.qid;

    ring_out.plugin_qm_data_out.l3_pkt_len = ring_in.l3_pkt_len;
    ring_out.plugin_qm_data_out.buf_handle_lo24 = ring_in.buf_handle_lo24;

  }
  else // assume MUX and ignore xscale data packets for now
  {
    // assume unicast
    out_port = (ring_in.uc_mc_bits >> 3) & 0x7;
    ring_out.plugin_mux_data_out.out_port = out_port;
    
    ring_out.plugin_mux_data_out.qid = ((out_port+1) << 13) | ring_in.qid;

    // assume pass-through
    ring_out.plugin_mux_data_out.flags = 1;

    ring_out.plugin_mux_data_out.plugin_tag = ring_in.plugin_tag;
    ring_out.plugin_mux_data_out.in_port = ring_in.in_port;
    ring_out.plugin_mux_data_out.stats_index = ring_in.stats_index;
    ring_out.plugin_mux_data_out.l3_pkt_len = ring_in.l3_pkt_len;
    ring_out.plugin_mux_data_out.buf_handle_lo24 = ring_in.buf_handle_lo24;
  }
}

/* handle packets */
void handle_pkt()
{
  dl_source_packet(dlFromBlock);
  
  handle_pkt_user();

  default_format_out_data(dlNextBlock);

  dl_sink_packet(dlNextBlock);
}
/* handle control messages */
void handle_msg()
{
  __declspec(gp_reg) unsigned int message[8];
  __declspec(gp_reg) unsigned int i;
  __declspec(local_mem) char msgstr[28];
  __declspec(local_mem) char return_str[28];
  __declspec(local_mem) char getcount_str[4] = "gco\0";  
  __declspec(local_mem) char getdamages_str[4] = "gda\0";
  __declspec(local_mem) char setdeterm_str[4] = "sde\0";
  __declspec(local_mem) char setstride_str[4] = "sst\0";
  __declspec(local_mem) char setprob_str[4] = "spr\0";
  __declspec(local_mem) char reset_str[4] = "rst\0";
  __declspec(local_mem) char bado_str[11] = "BAD OP\0"; 
  __declspec(local_mem) char bada_str[11] = "BAD ARG\0"; 
  __declspec(gp_reg) onl_api_ctrl_msg_hdr hdr;

  //for(i=0; i<8; ++i) { message[i] = 0; }
  //had to unroll loop like Dr. Wong did (after adding his methods)
  message[0] = 0;
  message[1] = 0;
  message[2] = 0;
  message[3] = 0;
  message[4] = 0;
  message[5] = 0;
  message[6] = 0;
  message[7] = 0;

  dl_source_message(msgFromBlock, message);

  hdr.value = message[0];
  if(hdr.type != CM_CONTROLMSG)
  {
    return;
  }
  if(hdr.response_requested != 1)
  {
    return;
  }

  onl_api_intarr2str(&message[1], msgstr);

  if(strncmp_lmem(msgstr, setdeterm_str, 3) == 0)
  {
    deterministic = kenw_atoi(nxt_token(msgstr));
  }
  else if(strncmp_lmem(msgstr, setstride_str, 3) == 0)
  {
    stride = kenw_atoi(nxt_token(msgstr));
  }
  else if(strncmp_lmem(msgstr, setprob_str, 3) == 0)
  {
    probability = kenw_atoi(nxt_token(msgstr)) * probMult;
  }
  else if(strncmp_lmem(msgstr, reset_str, 3) == 0)
  {
    nextDroppable = -1;
    count = 0;
    damages = 0;
  }
  else if(strncmp_lmem(msgstr, getcount_str, 3) == 0)
  {
    onl_api_int2dstr(count, return_str);
    if(onl_api_str2intarr(return_str, &message[1]) < 0)
    {
      return;
    }
  }
  else if(strncmp_lmem(msgstr, getdamages_str, 3) == 0)
  {
    onl_api_int2dstr(damages, return_str);
    if(onl_api_str2intarr(return_str, &message[1]) < 0)
    {
      return;
    }
  }
  else
  {
    if(onl_api_str2intarr(bado_str, &message[1]) < 0)
    {
      return;
    }
  }

  hdr.type = CM_CONTROLMSGRSP;
  hdr.response_requested = 0;
  hdr.num_words = 7;
  message[0] = hdr.value;

  dl_sink_message(msgNextBlock, message);
}


/* handle periodic functionality */
void callback()
{
}


/* take care of any setup that needs to be done before processing begins */
void plugin_init()
{
  /* set a default timeout value for callback of 10000 cycles */
  timeout = 10000;

  /* set the default next block to be the Queue Manager */
  dlNextBlock = QM;

  /* by default, get packets and get and put control messages from input rings
   * based on which microengine we are currently running on; this assumes a
   * default one to one mapping */
  switch(__ME())
  {
    case 0x7:
      pluginId = 0;
      dlFromBlock  = PACKET_IN_RING_0;
      msgFromBlock = MESSAGE_IN_RING_0;
      msgNextBlock = MESSAGE_OUT_RING_0;
      break;
    case 0x10:
      pluginId = 1;
      dlFromBlock  = PACKET_IN_RING_1;
      msgFromBlock = MESSAGE_IN_RING_1;
      msgNextBlock = MESSAGE_OUT_RING_1;

      break;
    case 0x11:
      pluginId = 2;
      dlFromBlock  = PACKET_IN_RING_2;
      msgFromBlock = MESSAGE_IN_RING_2;
      msgNextBlock = MESSAGE_OUT_RING_2;  
      break;
    case 0x12:
      pluginId = 3;
      dlFromBlock  = PACKET_IN_RING_3;
      msgFromBlock = MESSAGE_IN_RING_3;
      msgNextBlock = MESSAGE_OUT_RING_3;    
      break;
    case 0x13:
      pluginId = 4;
      dlFromBlock  = PACKET_IN_RING_4;
      msgFromBlock = MESSAGE_IN_RING_4;
      msgNextBlock = MESSAGE_OUT_RING_4;
      break;
    default:  // keep the compiler happy
      pluginId = 0;
      dlFromBlock  = PACKET_IN_RING_0;
      msgFromBlock = MESSAGE_IN_RING_0;
      msgNextBlock = MESSAGE_OUT_RING_0;
      break;
  }

  plugin_init_user(); // user hook
}


/* entry point */
void main()
{
  int c;

  /* do initialization */
  plugin_init();
  dl_sink_init();
  dl_source_init();

  /* get the current thread's context number (0-7) */
  c = ctx();

  if(c >= FIRST_PACKET_THREAD && c <= LAST_PACKET_THREAD)
  {
    while(1)
    {
      handle_pkt();
    }
  }
#ifdef MESSAGE_THREAD
  else if(c == MESSAGE_THREAD)
  {
    while(1)
    {
      handle_msg();
    }
  }
#endif
#ifdef CALLBACK_THREAD
  else if(c == CALLBACK_THREAD)
  {
    while(1)
    {
      callback();
    }
  }
#endif
}

#endif	// _PLUGIN_LOG_C