org/objectweb/proactive/p2p/service/node/P2PNodeLookup.java

/* 
 * ################################################################
 * 
 * ProActive: The Java(TM) library for Parallel, Distributed, 
 *            Concurrent computing with Security and Mobility
 * 
 * Copyright (C) 1997-2007 INRIA/University of Nice-Sophia Antipolis
 * Contact: proactive@objectweb.org
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or any later version.
 *  
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 * USA
 *  
 *  Initial developer(s):               The ProActive Team
 *                        http://www.inria.fr/oasis/ProActive/contacts.html
 *  Contributor(s): 
 * 
 * ################################################################
 */ 
package org.objectweb.proactive.p2p.service.node;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Vector;

import org.apache.log4j.Logger;
import org.objectweb.proactive.Body;
import org.objectweb.proactive.EndActive;
import org.objectweb.proactive.InitActive;
import org.objectweb.proactive.ProActive;
import org.objectweb.proactive.ProActiveInternalObject;
import org.objectweb.proactive.RunActive;
import org.objectweb.proactive.Service;
import org.objectweb.proactive.core.ProActiveException;
import org.objectweb.proactive.core.node.Node;
import org.objectweb.proactive.core.node.NodeFactory;
import org.objectweb.proactive.core.runtime.ProActiveRuntime;
import org.objectweb.proactive.core.runtime.RuntimeFactory;
import org.objectweb.proactive.core.util.log.Loggers;
import org.objectweb.proactive.core.util.log.ProActiveLogger;
import org.objectweb.proactive.core.util.wrapper.IntWrapper;
import org.objectweb.proactive.p2p.service.P2PService;
import org.objectweb.proactive.p2p.service.util.P2PConstants;


public class P2PNodeLookup implements InitActive, RunActive, EndActive,
    P2PConstants, Serializable, ProActiveInternalObject {
    private static final Logger logger = ProActiveLogger.getLogger(Loggers.P2P_NODES);
    private Vector<Node> waitingNodesList;
    private Vector<String> nodesToKillList;
    private long expirationTime;
    private static final long TIMEOUT = Long.parseLong(System.getProperty(
                PROPERTY_NODES_ACQUISITION_T0));
    private static final long LOOKUP_FREQ = Long.parseLong(System.getProperty(
                PROPERTY_LOOKUP_FREQ));
    private static final int TTL = Integer.parseInt(System.getProperty(
                PROPERTY_TTL));
    private int numberOfAskedNodes;
    private int acquiredNodes = 0;
    private P2PService localP2pService;
    private String vnName;
    private String jobId;
    private P2PNodeLookup stub;
    private ProActiveRuntime paRuntime;
    private String parUrl;
    private HashMap<String, P2PNodeManager> nodeManagerMap = new HashMap<String, P2PNodeManager>();
    private boolean killAllFlag = false;
    private String nodeFamilyRegexp = null;

    public P2PNodeLookup() {
        // the empty constructor
    }

    public P2PNodeLookup(Integer numberOfAskedNodes,
        P2PService localP2pService, String vnName, String jobId,
        String nodeFamilyRegexp) {
        this.waitingNodesList = new Vector<Node>();
        this.nodesToKillList = new Vector<String>();
        this.expirationTime = System.currentTimeMillis() + TIMEOUT;
        this.numberOfAskedNodes = numberOfAskedNodes.intValue();
        assert (this.numberOfAskedNodes > 0) ||
        (this.numberOfAskedNodes == MAX_NODE) : "None authorized value for asked nodes";
        // Use special case: do not check TO
        //        if (this.numberOfAskedNodes == MAX_NODE) {
        //            this.expirationTime = Long.MAX_VALUE;
        //        }
        this.localP2pService = localP2pService;
        this.vnName = vnName;
        this.jobId = jobId;
        this.nodeFamilyRegexp = nodeFamilyRegexp;
    }

    // -------------------------------------------------------------------------
    // Access methods
    // -------------------------------------------------------------------------

    public boolean allArrived() {
        if (this.numberOfAskedNodes != MAX_NODE) {
            return (this.numberOfAskedNodes == this.acquiredNodes);
        } else {
            return false;
        }
    }

    public boolean nArrived(int n) {
        return n <= this.acquiredNodes;
    }

    public void killNode(String node) {
        try {
            Node remoteNode = NodeFactory.getNode(node);
            ProActiveRuntime remoteRuntime = remoteNode.getProActiveRuntime();
            P2PNodeManager remoteNodeManager = (P2PNodeManager) this.nodeManagerMap.get(node);

            remoteRuntime.unregisterVirtualNode(vnName);
            remoteRuntime.rmAcquaintance(this.parUrl);
            this.paRuntime.rmAcquaintance(remoteRuntime.getURL());
            remoteNodeManager.leaveNode(remoteNode, this.vnName);

            logger.info("Node at " + node + " succefuly removed");

            // Unregister the remote runtime
            this.paRuntime.unregister(remoteRuntime, remoteRuntime.getURL(),
                "p2p", System.getProperty(PROPERTY_ACQUISITION) + ":",
                remoteRuntime.getVMInformation().getName());
        } catch (Exception e) {
            logger.info("Node @" + node + " already down");
        } finally {
            this.nodesToKillList.remove(node);
        }
    }

    public void killAllNodes() {
        this.killAllFlag = true;
        while (this.nodesToKillList.size() > 0) {
            String currentNode = this.nodesToKillList.get(0);
            this.killNode(currentNode);
        }
    }

    public void wakeUp() {
        // nothing to do, just wake up the run activity
    }

    public IntWrapper giveNode(Node givenNode, P2PNodeManager remoteNodeManager) {
        if (logger.isDebugEnabled()) {
            logger.debug("Given node received from " +
                givenNode.getNodeInformation().getURL());
        }

        // Get currrent nodes accessor
        if (!this.allArrived()) {
            this.waitingNodesList.add(givenNode);
            String nodeUrl = givenNode.getNodeInformation().getURL();
            this.nodeManagerMap.put(nodeUrl, remoteNodeManager);
            this.acquiredNodes++;
            ProActiveRuntime remoteRt = givenNode.getProActiveRuntime();
            try {
                remoteRt.addAcquaintance(this.parUrl);
                this.paRuntime.addAcquaintance(remoteRt.getURL());
                this.paRuntime.register(remoteRt, remoteRt.getURL(), "p2p",
                    System.getProperty(PROPERTY_ACQUISITION) + ":",
                    remoteRt.getVMInformation().getName());
            } catch (ProActiveException e) {
                logger.warn("Couldn't recgister the remote runtime", e);
            }
            logger.info("Node at " + nodeUrl + " succefuly added");
            logger.info("Lookup got " + this.acquiredNodes + " nodes");
            return new IntWrapper(this.numberOfAskedNodes - this.acquiredNodes);
        }
        return new IntWrapper(-1);
    }

    public void giveNodeForMax(Vector<Node> givenNodes,
        P2PNodeManager remoteNodeManager) {
        // Get currrent nodes accessor
        this.waitingNodesList.addAll(givenNodes);
        for (int i = 0; i < givenNodes.size(); i++) {
            Node current = (Node) givenNodes.get(i);
            String nodeUrl = current.getNodeInformation().getURL();
            this.nodeManagerMap.put(nodeUrl, remoteNodeManager);
            this.acquiredNodes++;
            ProActiveRuntime remoteRt = current.getProActiveRuntime();
            try {
                remoteRt.addAcquaintance(this.parUrl);
                this.paRuntime.addAcquaintance(remoteRt.getURL());
                this.paRuntime.register(remoteRt, remoteRt.getURL(), "p2p",
                    System.getProperty(PROPERTY_ACQUISITION) + ":",
                    remoteRt.getVMInformation().getName());
            } catch (ProActiveException e) {
                logger.warn("Couldn't recgister the remote runtime", e);
            }
            logger.info("Node at " + nodeUrl + " succefuly added");
        }
        logger.info("Lookup MAX got " + this.acquiredNodes + " nodes");
    }

    public boolean isActive() {
        return ProActive.getBodyOnThis().isActive();
    }

    public Vector getAndRemoveNodes() {
        Vector<Node> v = new Vector<Node>();
        while (this.waitingNodesList.size() != 0) {
            Node elem = this.waitingNodesList.get(0);
            v.add(elem);
            this.waitingNodesList.remove(elem);
            this.nodesToKillList.add(elem.getNodeInformation().getURL());
        }
        return v;
    }

    public Vector getNodes() {
        Service service = new Service(ProActive.getBodyOnThis());
        while (!this.allArrived()) {
            this.localP2pService.askingNode(TTL, null, this.localP2pService,
                this.numberOfAskedNodes - this.acquiredNodes, stub,
                this.vnName, this.jobId, this.nodeFamilyRegexp);

            // Serving request
            service.blockingServeOldest(LOOKUP_FREQ);
            while (service.hasRequestToServe()) {
                service.serveOldest();
            }
        }
        return ((P2PNodeLookup) ProActive.getStubOnThis()).getAndRemoveNodes();
    }

    public Vector getNodes(long timeout) {
        long endTime = System.currentTimeMillis() + timeout;
        Service service = new Service(ProActive.getBodyOnThis());
        while (!this.allArrived() && (System.currentTimeMillis() < endTime)) {
            this.localP2pService.askingNode(TTL, null, this.localP2pService,
                this.numberOfAskedNodes - this.acquiredNodes, stub,
                this.vnName, this.jobId, this.nodeFamilyRegexp);
            // Serving request
            if (timeout < LOOKUP_FREQ) {
                service.blockingServeOldest(500);
            } else {
                service.blockingServeOldest(LOOKUP_FREQ);
            }
            while (service.hasRequestToServe()) {
                service.serveOldest();
            }
        }
        return ((P2PNodeLookup) ProActive.getStubOnThis()).getAndRemoveNodes();
    }

    public void moveTo(String nodeUrl) {
        try {
            ProActive.migrateTo(nodeUrl);
        } catch (Exception e) {
            logger.fatal("Couldn't migrate the node lookup to " + nodeUrl, e);
        }
    }

    // -------------------------------------------------------------------------
    // ProActive methods
    // -------------------------------------------------------------------------

    public void initActivity(Body body) {
        this.stub = (P2PNodeLookup) ProActive.getStubOnThis();
        try {
            this.paRuntime = RuntimeFactory.getDefaultRuntime();
            this.parUrl = this.paRuntime.getURL();
        } catch (ProActiveException e) {
            logger.fatal("Problem to get local runtime", e);
        }
    }

    public void runActivity(Body body) {
        logger.info("Looking for " +
            ((this.numberOfAskedNodes == MAX_NODE) ? "MAX"
                                                   : (this.numberOfAskedNodes +
            "")) + " nodes");
        Service service = new Service(body);

        String reason = null;
        while (true) {
            logger.debug("Aksing nodes");

            // Send a message to everybody
            this.localP2pService.askingNode(TTL, null, this.localP2pService,
                (this.numberOfAskedNodes == P2PConstants.MAX_NODE)
                ? P2PConstants.MAX_NODE
                : (this.numberOfAskedNodes - this.acquiredNodes), stub,
                this.vnName, this.jobId, this.nodeFamilyRegexp);

            // Serving request
            logger.debug("Waiting for requests");
            service.blockingServeOldest(LOOKUP_FREQ);
            while (service.hasRequestToServe()) {
                if (logger.isDebugEnabled()) {
                    logger.info("Serving request: " +
                        service.getOldest().getMethodName());
                }
                service.serveOldest();
            }

            // Test conditions to go out of the loop
            if (this.killAllFlag) {
                reason = "killing nodes request";
                break;
            } else if (this.numberOfAskedNodes == MAX_NODE) {
                reason = "Max node asked";
                continue;
            } else if (this.allArrived()) {
                reason = "all nodes are arrived";
                break;
            } else if ((System.currentTimeMillis() > this.expirationTime)) {
                reason = "timeout is expired";
                break;
            } else {
                reason = "Normal case continue";
                continue;
            }
        }

        if (reason == null) {
            reason = "Houston. We have a problem...";
        }
        logger.info("Ending loop activity because: " + reason);
    }

    public void endActivity(Body body) {
        Service service = new Service(body);
        logger.info("Nodes (" + this.acquiredNodes +
            ") arrived ending activity");
        this.localP2pService.removeWaitingAccessor(this.stub);
        while ((this.waitingNodesList.size() > 0) ||
                (this.nodesToKillList.size() > 0)) {
            service.blockingServeOldest(LOOKUP_FREQ);
            while (service.hasRequestToServe()) {
                service.serveOldest();
            }
        }
        logger.info("This P2P nodes lookup is no more active, bye..");
    }
}

---